@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog-db/endpoints/get_payables.json

@@ -0,0 +1,138 @@
+{
+  "operationId": "get_payables",
+  "resource": "payables",
+  "name": "List All Payables",
+  "method": "GET",
+  "path": "/payables",
+  "description": "Returns all payable bills that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[CreatedAt]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter payables by creation date"
+    },
+    {
+      "name": "filters",
+      "type": "object",
+      "required": true,
+      "description": "Filters for payables"
+    },
+    {
+      "name": "page[number]",
+      "type": "integer",
+      "required": false,
+      "description": "Page number for pagination. Default is 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Page size for pagination. Default is 1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of payable objects"
+    },
+    {
+      "name": "data[].TotalAmount",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The total amount of the payable. Ensure that the total amount is equal to the total of all line items summed."
+    },
+    {
+      "name": "data[].BankAccountId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the bank account associated with the payable"
+    },
+    {
+      "name": "data[].CheckNumber",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The check number of the payable"
+    },
+    {
+      "name": "data[].CreatedAt",
+      "type": "string",
+      "required": false,
+      "description": "The date the payable was created"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the payable"
+    },
+    {
+      "name": "data[].LineItems",
+      "type": "array",
+      "required": false,
+      "description": "Array of line item attributes present on the payable(s)",
+      "attributes": [
+        {
+          "name": "Amount",
+          "type": "string",
+          "required": false,
+          "description": "The amount due for the line item"
+        },
+        {
+          "name": "BillId",
+          "type": "string",
+          "required": false,
+          "description": "The bill ID relevant to the line item"
+        },
+        {
+          "name": "Description",
+          "type": "string",
+          "required": false,
+          "description": "A brief description of the line item"
+        },
+        {
+          "name": "Id",
+          "type": "string",
+          "required": false,
+          "description": "Unique identifier of line item"
+        },
+        {
+          "name": "PayerAddress",
+          "type": "array",
+          "required": false,
+          "description": "Array of payer address details"
+        },
+        {
+          "name": "PropertyId",
+          "type": "string",
+          "required": false,
+          "description": "The property ID relevant to the line item"
+        },
+        {
+          "name": "PropertyName",
+          "type": "string",
+          "required": false,
+          "description": "The property name relevant to the line item"
+        }
+      ]
+    },
+    {
+      "name": "data[].VendorId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the vendor owed the payable"
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/payables?filters[CreatedAt]=2020-12-15T16:30:46Z' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

package/dist/catalog-db/endpoints/get_portfolios.json

@@ -0,0 +1,70 @@
+{
+  "operationId": "get_portfolios",
+  "resource": "portfolios",
+  "name": "List All Portfolios",
+  "method": "GET",
+  "path": "/portfolios",
+  "description": "Returns all portfolios that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter portfolios by unique identifier. All GET requests must include a filter for [Id] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter portfolios updated at or after this date-time. All GET requests must include a filter for [Id] or [LastUpdatedAtFrom]."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of Portfolio objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the portfolio"
+    },
+    {
+      "name": "data[].Default",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the portfolio is the default portfolio"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name of the portfolio"
+    },
+    {
+      "name": "data[].PropertyIds",
+      "type": "Array of arrays",
+      "required": false,
+      "description": "Unique identifier(s) of the properties associated with the portfolio. Note: The portfolio endpoint returns hidden properties. To associate hidden properties yielded from this endpoint with those from the Properties endpoint, ensure the IncludeHidden filter is enabled."
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the portfolio's details were last updated"
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/portfolios?filters[LastUpdatedAtFrom]=2020-12-15T16:30:46Z' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

package/dist/catalog-db/endpoints/get_properties.json

@@ -0,0 +1,267 @@
+{
+  "operationId": "get_properties",
+  "resource": "properties",
+  "name": "List All Properties",
+  "method": "GET",
+  "path": "/properties",
+  "description": "Returns all properties that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by the unique identifier of the property. All GET requests must include a filter for [Id] (if available) or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter properties updated at or after this date-time. All GET requests must include a filter for [Id] (if available) or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[PropertyType]",
+      "type": "string",
+      "required": false,
+      "description": "Filter by property type. Accepts comma-separated values such as Single-Family, Multi-Family, Commercial."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of property objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property retrieved"
+    },
+    {
+      "name": "data[].CustomFields",
+      "type": "object",
+      "required": false,
+      "description": "The custom fields for the associated entity"
+    },
+    {
+      "name": "data[].HasHomeWarrantyCoverage",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the property has home warranty coverage"
+    },
+    {
+      "name": "data[].HomeWarrantyInfo",
+      "type": "object",
+      "required": false,
+      "description": "Contains information about the property's home warranty coverage"
+    },
+    {
+      "name": "data[].HiddenAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "When the property was placed into an inactive state by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the property group's details were last updated"
+    },
+    {
+      "name": "data[].LeaseFeePolicy",
+      "type": "object",
+      "required": false,
+      "description": "Contains details about the property's lease fee policy"
+    },
+    {
+      "name": "data[].Link",
+      "type": "string <uri>",
+      "required": false,
+      "description": "A link to the property page in the AppFolio Property Manager"
+    },
+    {
+      "name": "data[].PortfolioId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the portfolio associated with the property"
+    },
+    {
+      "name": "data[].PropertyGroupIds",
+      "type": "Array of strings",
+      "required": false,
+      "description": "Unique identifier(s) of the property group(s) associated with the property"
+    },
+    {
+      "name": "data[].PropertyType",
+      "type": "string",
+      "required": false,
+      "description": "The type of property",
+      "enum": ["Commercial", "Corporate", "Manufactured-Housing", "Mixed-Use", "Multi-Family", "Self-Storage", "Single-Family", "Student-Housing", "Vacation"]
+    },
+    {
+      "name": "data[].PostedToInternet",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the Single-Family (SFR) property has been posted to a third-party listings page. Returns null if property type is not SFR."
+    },
+    {
+      "name": "data[].PostedToWebsite",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether a vacant Single-Family (SFR) property was posted to the AppFolio listings page. Returns null if property type is not SFR."
+    },
+    {
+      "name": "data[].TenantPortalLink",
+      "type": "string",
+      "required": false,
+      "description": "Link that can be used to direct a resident to their tenant portal"
+    },
+    {
+      "name": "data[].AdminFee",
+      "type": "number",
+      "required": false,
+      "description": "The admin fee associated with the property"
+    },
+    {
+      "name": "data[].Amenities",
+      "type": "Array of strings",
+      "required": false,
+      "description": "The amenities associated with the property"
+    },
+    {
+      "name": "data[].CatsAllowed",
+      "type": "string",
+      "required": false,
+      "description": "The property's cat policy. Valid values include \"Yes\", \"No\" or null.",
+      "enum": ["Yes", "No"]
+    },
+    {
+      "name": "data[].Class",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the type and quality of the property based on factors such as age, location, amenities, and overall condition.",
+      "enum": ["A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-"]
+    },
+    {
+      "name": "data[].CurrentManagementFeePolicy",
+      "type": "object",
+      "required": false,
+      "description": "Contains details about the property's current management fee policy"
+    },
+    {
+      "name": "data[].DogsAllowed",
+      "type": "string",
+      "required": false,
+      "description": "The property's dog policy.",
+      "enum": ["Large & Small", "Small Only", "No"]
+    },
+    {
+      "name": "data[].InsuranceExpiration",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date the property's insurance expires"
+    },
+    {
+      "name": "data[].MaintenanceLimit",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The dollar amount limit to not exceed for maintenance"
+    },
+    {
+      "name": "data[].MaintenanceNotes",
+      "type": "string",
+      "required": false,
+      "description": "A brief informative message about the property's maintenance"
+    },
+    {
+      "name": "data[].ManagementEndDate",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date when the current management of the property ended"
+    },
+    {
+      "name": "data[].ManagementEndReason",
+      "type": "string",
+      "required": false,
+      "description": "The reason for the end of the current management of the property",
+      "enum": ["Foreclosure", "Maintenance", "Management Company Concerns", "Management Company Terminated", "Owner Moved In", "Owner Self-Managing", "Owner Sold", "Owner Terminated Management", "Property Uninhabitable/Demolition", "Tenant Placement", "Other"]
+    },
+    {
+      "name": "data[].ManagementStartDate",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date when the current management of the property began"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name of the property"
+    },
+    {
+      "name": "data[].NsfFee",
+      "type": "number",
+      "required": false,
+      "description": "The non-sufficient funds (NSF) fee associated with the property"
+    },
+    {
+      "name": "data[].SiteManager",
+      "type": "object",
+      "required": false,
+      "description": "Contains the property site manager's contact information and details"
+    },
+    {
+      "name": "data[].UnitEntryPreAuthorized",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not entry to the unit was pre-authorized"
+    },
+    {
+      "name": "data[].YearBuilt",
+      "type": "integer",
+      "required": false,
+      "description": "The year in which the property was constructed"
+    },
+    {
+      "name": "data[].Address1",
+      "type": "string",
+      "required": false,
+      "description": "The primary street address of the property"
+    },
+    {
+      "name": "data[].Address2",
+      "type": "string",
+      "required": false,
+      "description": "Additional street address information pertaining to the property"
+    },
+    {
+      "name": "data[].City",
+      "type": "string",
+      "required": false,
+      "description": "The city where the property is located"
+    },
+    {
+      "name": "data[].State",
+      "type": "string",
+      "required": false,
+      "description": "The state where the property is located"
+    },
+    {
+      "name": "data[].Zip",
+      "type": "string",
+      "required": false,
+      "description": "The zip code where the property is located"
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/properties?filters[Id]=1abcde234-c543-456e-abc9-123456789cba&filters[LastUpdatedAtFrom]=2020-12-15T16:30:46Z&filters[PropertyType]=Single-Family,Multi-Family,Commercial' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

package/dist/catalog-db/endpoints/get_properties_attachments.json

@@ -0,0 +1,76 @@
+{
+  "operationId": "get_properties_attachments",
+  "resource": "properties",
+  "name": "List All Property Attachments",
+  "method": "GET",
+  "path": "/properties/attachments",
+  "description": "Returns all attachments associated with a property",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by the unique identifier of the property. All GET requests must include a filter for [PropertyId] or [CreatedAtFrom]."
+    },
+    {
+      "name": "filters[CreatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter attachments created at or after this date-time. All GET requests must include a filter for [PropertyId] or [CreatedAtFrom]."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of property attachment objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the attachment"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name given to describe the attachment"
+    },
+    {
+      "name": "data[].ContentType",
+      "type": "string",
+      "required": false,
+      "description": "The content type of the attachment. An example content type is a photo or a PDF."
+    },
+    {
+      "name": "data[].CreatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date and time the attachment was created by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].EntityId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the attachment"
+    },
+    {
+      "name": "data[].URL",
+      "type": "string",
+      "required": false,
+      "description": "The link to download the file in the attachment"
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/properties/attachments?page[size]=10&page[number]=2&filters[PropertyId]=2e67d04f-e02f-449a-9b61-694636189c04&filters[CreatedAtFrom]=2020-12-14T16:30:46Z' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

package/dist/catalog-db/endpoints/get_properties_marketing_photos.json

@@ -0,0 +1,76 @@
+{
+  "operationId": "get_properties_marketing_photos",
+  "resource": "properties",
+  "name": "List All Properties Marketing Photos",
+  "method": "GET",
+  "path": "/properties/marketing_photos",
+  "description": "Returns all multi-family residential properties' marketing photos that meet the specified filter criteria. Marketing photos are not available for single-family residential properties.",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Filters for property photos. All GET requests must include a filter for [PropertyId]."
+    },
+    {
+      "name": "page[number]",
+      "type": "integer",
+      "required": false,
+      "description": "Page number for pagination. Default: 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Page size for pagination. Default: 1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of marketing photo objects (Properties.MarketingPhoto)"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the marketing photo"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the marketing photo"
+    },
+    {
+      "name": "data[].Position",
+      "type": "integer",
+      "required": false,
+      "description": "The position of the photo in the property photo gallery. If multiple photos are associated with a property, the order of the remaining photos (positions 1 and above) will not change automatically if some photos are deleted."
+    },
+    {
+      "name": "data[].Url",
+      "type": "string <uri>",
+      "required": false,
+      "description": "The public link to the marketing photo"
+    },
+    {
+      "name": "data[].ContentType",
+      "type": "string",
+      "required": false,
+      "description": "The content type of the marketing photo"
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/properties/marketing_photos?filters[PropertyId]=1abcde23-c543-456e-abc9-123456789cba' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}