{
  "service": "buildium",
  "displayName": "Buildium",
  "categories": [
    "Productivity",
    "Data"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "Client Secret",
      "placeholder": "BUILDIUM_CLIENT_SECRET",
      "description": "Buildium API client secret sent with the x-buildium-client-secret header. Create or view API keys in your Buildium account under Settings > API Keys: https://developer.buildium.com/.",
      "extraFields": [
        {
          "key": "clientId",
          "label": "Client ID",
          "inputType": "text",
          "required": true,
          "secret": false,
          "placeholder": "BUILDIUM_CLIENT_ID",
          "description": "Buildium API client ID sent with the x-buildium-client-id header. Find it with the client secret in your Buildium account API Keys page: https://developer.buildium.com/."
        }
      ]
    }
  ],
  "homepageUrl": "https://www.buildium.com",
  "actions": [
    {
      "id": "buildium.get_owner",
      "service": "buildium",
      "name": "get_owner",
      "description": "Retrieve one Buildium rental owner by identifier.",
      "requiredScopes": [],
      "providerPermissions": [
        "Rentals > Rental owners: View"
      ],
      "inputSchema": {
        "type": "object",
        "properties": {
          "rentalOwnerId": {
            "type": "integer",
            "minimum": 1,
            "description": "The Buildium rental owner identifier."
          }
        },
        "additionalProperties": false,
        "required": [
          "rentalOwnerId"
        ],
        "description": "The input payload for retrieving one rental owner."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "owner": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The normalized Buildium resource payload."
          }
        },
        "additionalProperties": false,
        "required": [
          "owner"
        ],
        "description": "A Buildium rental owner response."
      }
    },
    {
      "id": "buildium.get_property",
      "service": "buildium",
      "name": "get_property",
      "description": "Retrieve one Buildium rental property by identifier.",
      "requiredScopes": [],
      "providerPermissions": [
        "Rentals > Rental properties and units: View"
      ],
      "inputSchema": {
        "type": "object",
        "properties": {
          "propertyId": {
            "type": "integer",
            "minimum": 1,
            "description": "The Buildium rental property identifier."
          }
        },
        "additionalProperties": false,
        "required": [
          "propertyId"
        ],
        "description": "The input payload for retrieving one rental property."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "property": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The normalized Buildium resource payload."
          }
        },
        "additionalProperties": false,
        "required": [
          "property"
        ],
        "description": "A Buildium rental property response."
      }
    },
    {
      "id": "buildium.get_unit",
      "service": "buildium",
      "name": "get_unit",
      "description": "Retrieve one Buildium rental unit by identifier.",
      "requiredScopes": [],
      "providerPermissions": [
        "Rentals > Rental properties and units: View"
      ],
      "inputSchema": {
        "type": "object",
        "properties": {
          "unitId": {
            "type": "integer",
            "minimum": 1,
            "description": "The Buildium rental unit identifier."
          }
        },
        "additionalProperties": false,
        "required": [
          "unitId"
        ],
        "description": "The input payload for retrieving one rental unit."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "unit": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The normalized Buildium resource payload."
          }
        },
        "additionalProperties": false,
        "required": [
          "unit"
        ],
        "description": "A Buildium rental unit response."
      }
    },
    {
      "id": "buildium.list_owners",
      "service": "buildium",
      "name": "list_owners",
      "description": "List Buildium rental owners.",
      "requiredScopes": [],
      "providerPermissions": [
        "Rentals > Rental owners: View"
      ],
      "inputSchema": {
        "type": "object",
        "properties": {
          "limit": {
            "type": "integer",
            "minimum": 1,
            "description": "Maximum number of records to return."
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "description": "Zero-based record offset used for pagination."
          },
          "orderBy": {
            "type": "string",
            "minLength": 1,
            "description": "Buildium orderby expression used to sort returned records."
          },
          "rentalOwnerIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "minimum": 1,
              "description": "One Buildium identifier."
            },
            "description": "Rental owner identifiers to include.",
            "minItems": 1
          }
        },
        "additionalProperties": false,
        "description": "The input payload for listing Buildium rental owners."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The number of returned records."
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Buildium rental owner."
            },
            "description": "The returned records."
          }
        },
        "additionalProperties": false,
        "required": [
          "count",
          "items"
        ],
        "description": "A list of Buildium rental owners."
      }
    },
    {
      "id": "buildium.list_properties",
      "service": "buildium",
      "name": "list_properties",
      "description": "List Buildium rental properties.",
      "requiredScopes": [],
      "providerPermissions": [
        "Rentals > Rental properties and units: View"
      ],
      "inputSchema": {
        "type": "object",
        "properties": {
          "limit": {
            "type": "integer",
            "minimum": 1,
            "description": "Maximum number of records to return."
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "description": "Zero-based record offset used for pagination."
          },
          "orderBy": {
            "type": "string",
            "minLength": 1,
            "description": "Buildium orderby expression used to sort returned records."
          },
          "propertyIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "minimum": 1,
              "description": "One Buildium identifier."
            },
            "description": "Rental property identifiers to include.",
            "minItems": 1
          }
        },
        "additionalProperties": false,
        "description": "The input payload for listing Buildium rental properties."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The number of returned records."
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Buildium rental property."
            },
            "description": "The returned records."
          }
        },
        "additionalProperties": false,
        "required": [
          "count",
          "items"
        ],
        "description": "A list of Buildium rental properties."
      }
    },
    {
      "id": "buildium.list_property_notes",
      "service": "buildium",
      "name": "list_property_notes",
      "description": "List notes attached to one Buildium rental property.",
      "requiredScopes": [],
      "providerPermissions": [
        "Rentals > Rental properties and units: View"
      ],
      "inputSchema": {
        "type": "object",
        "properties": {
          "propertyId": {
            "type": "integer",
            "minimum": 1,
            "description": "The Buildium rental property identifier."
          },
          "updatedDateTimeFrom": {
            "type": "string",
            "minLength": 1,
            "description": "Filter to notes updated at or after this Buildium date-time value."
          },
          "updatedDateTimeTo": {
            "type": "string",
            "minLength": 1,
            "description": "Filter to notes updated at or before this Buildium date-time value."
          },
          "lastUpdatedByUserId": {
            "type": "integer",
            "minimum": 1,
            "description": "Filter to notes last updated by this user identifier."
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "description": "Maximum number of records to return."
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "description": "Zero-based record offset used for pagination."
          },
          "orderBy": {
            "type": "string",
            "minLength": 1,
            "description": "Buildium orderby expression used to sort returned records."
          }
        },
        "additionalProperties": false,
        "required": [
          "propertyId"
        ],
        "description": "The input payload for listing notes on one Buildium rental property."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The number of returned records."
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Buildium rental property note."
            },
            "description": "The returned records."
          }
        },
        "additionalProperties": false,
        "required": [
          "count",
          "items"
        ],
        "description": "A list of Buildium rental property notes."
      }
    },
    {
      "id": "buildium.list_units",
      "service": "buildium",
      "name": "list_units",
      "description": "List Buildium rental units.",
      "requiredScopes": [],
      "providerPermissions": [
        "Rentals > Rental properties and units: View"
      ],
      "inputSchema": {
        "type": "object",
        "properties": {
          "limit": {
            "type": "integer",
            "minimum": 1,
            "description": "Maximum number of records to return."
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "description": "Zero-based record offset used for pagination."
          },
          "orderBy": {
            "type": "string",
            "minLength": 1,
            "description": "Buildium orderby expression used to sort returned records."
          },
          "propertyIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "minimum": 1,
              "description": "One Buildium identifier."
            },
            "description": "Rental property identifiers used to filter units.",
            "minItems": 1
          },
          "unitIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "minimum": 1,
              "description": "One Buildium identifier."
            },
            "description": "Rental unit identifiers to include.",
            "minItems": 1
          }
        },
        "additionalProperties": false,
        "description": "The input payload for listing Buildium rental units."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The number of returned records."
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "One Buildium rental unit."
            },
            "description": "The returned records."
          }
        },
        "additionalProperties": false,
        "required": [
          "count",
          "items"
        ],
        "description": "A list of Buildium rental units."
      }
    }
  ]
}