@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,71 @@
+{
+  "operationId": "get_properties_notes",
+  "resource": "properties",
+  "name": "List All Properties Notes",
+  "method": "GET",
+  "path": "/properties/notes",
+  "description": "Returns all properties' notes that meet the filter criteria",
+  "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 [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter notes updated at or after this date-time. All GET requests must include a filter for [PropertyId] or [LastUpdatedAtFrom]."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of property note objects"
+    },
+    {
+      "name": "data[].Body",
+      "type": "string",
+      "required": false,
+      "description": "A brief informative message about the property note. A property note cannot exceed 63,535 characters."
+    },
+    {
+      "name": "data[].EntityId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The property to which the note will be attached"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string",
+      "required": false,
+      "description": "The date the property note's details were last updated"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the note associated with the property"
+    },
+    {
+      "name": "data[].NoteId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the note associated with the property. Deprecated in favor of Id.",
+      "deprecated": true
+    },
+    {
+      "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/notes?filters[PropertyId]=1abcde23-c543-456e-abc9-123456789cba&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_photos.json

@@ -0,0 +1,76 @@
+{
+  "operationId": "get_properties_photos",
+  "resource": "properties",
+  "name": "List All Properties Photos",
+  "method": "GET",
+  "path": "/properties/photos",
+  "description": "Returns all properties' photos that meet the filter criteria",
+  "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 photo objects (Properties.Photo)"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the photo"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the 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 photo"
+    },
+    {
+      "name": "data[].ContentType",
+      "type": "string",
+      "required": false,
+      "description": "The content type of the 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/photos?filters[PropertyId]=1abcde23-c543-456e-abc9-123456789cba' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

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

@@ -0,0 +1,84 @@
+{
+  "operationId": "get_property_groups",
+  "resource": "property_groups",
+  "name": "List All Property Groups",
+  "method": "GET",
+  "path": "/property_groups",
+  "description": "Returns all property groups that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the property group. All GET requests must include a filter for [Id] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter property groups last updated at or after this date-time. All GET requests must include a filter for [Id] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "page[number]",
+      "type": "integer",
+      "required": false,
+      "description": "Page number for pagination. Default is 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Number of results per page. Default is 1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of property group objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property group"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the property group's details were last updated"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name of the property group"
+    },
+    {
+      "name": "data[].Type",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The type of property groups",
+      "enum": ["PropertyGroup", "Portfolio"]
+    },
+    {
+      "name": "data[].PropertyIds",
+      "type": "Array of arrays",
+      "required": false,
+      "description": "Array of PropertyIds linked to the property group. Hidden properties within a property group are returned by default. Polling for a PropertyId that is hidden will return no data. Note: To associate hidden properties yielded from this endpoint with those from the Properties endpoint, ensure the IncludeHidden filter is enabled."
+    },
+    {
+      "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/property_groups?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_recurring_charges.json

@@ -0,0 +1,106 @@
+{
+  "operationId": "get_recurring_charges",
+  "resource": "recurring_charges",
+  "name": "List All Recurring Charges",
+  "method": "GET",
+  "path": "/recurring_charges",
+  "description": "Returns all recurring charges that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[OccupancyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by occupancy ID. All GET requests must include a filter for [OccupancyId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter recurring charges updated at or after this date-time. All GET requests must include a filter for [OccupancyId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "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 recurring charge objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the recurring charge"
+    },
+    {
+      "name": "data[].Amount",
+      "type": "number <float>",
+      "required": false,
+      "description": "The amount of the recurring charge"
+    },
+    {
+      "name": "data[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief summary or description of the recurring charge"
+    },
+    {
+      "name": "data[].Frequency",
+      "type": "string",
+      "required": false,
+      "description": "The frequency that the recurring charge occurs. Enum: \"Monthly\" \"Every 3 Months\" \"Every 6 Months\" \"Once a Year\""
+    },
+    {
+      "name": "data[].EndDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The end date of the recurring charge"
+    },
+    {
+      "name": "data[].StartDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The start date of the recurring charge"
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the occupancy associated with the recurring charge"
+    },
+    {
+      "name": "data[].GlAccountId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the general ledger account associated with the recurring charge"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the recurring charge was 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/recurring_charges?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_rental_applications.json

@@ -0,0 +1,186 @@
+{
+  "operationId": "get_rental_applications",
+  "resource": "rental_applications",
+  "name": "List All Rental Applications",
+  "method": "GET",
+  "path": "/rental_applications",
+  "description": "Returns all rental applications that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the rental application"
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the property associated with the rental application"
+    },
+    {
+      "name": "filters[UnitId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the unit associated with the rental application"
+    },
+    {
+      "name": "filters[GroupId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the application group associated with the rental application"
+    },
+    {
+      "name": "filters[ScreeningId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the screening associated with the rental application"
+    },
+    {
+      "name": "filters[SubmittedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter rental applications submitted at or after this date/time"
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of rental application objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the rental application"
+    },
+    {
+      "name": "data[].RequestedBackgroundReport",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the applicant has requested a copy of their background check report"
+    },
+    {
+      "name": "data[].HasHousingVoucher",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the applicant has a housing voucher, a government subsidy that assists with rent payments"
+    },
+    {
+      "name": "data[].AgreedToTerms",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the applicant agreed to the terms and conditions set for the rental application"
+    },
+    {
+      "name": "data[].ScreeningSubmissions",
+      "type": "array",
+      "required": false,
+      "description": "Array containing information about each screening submission associated with this rental application"
+    },
+    {
+      "name": "data[].CampaignId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the campaign associated with the rental application"
+    },
+    {
+      "name": "data[].GroupId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the application group associated with the rental application"
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit associated with the rental application"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the rental application"
+    },
+    {
+      "name": "data[].Bedrooms",
+      "type": "integer",
+      "required": false,
+      "description": "The number of desired bedrooms"
+    },
+    {
+      "name": "data[].Bathrooms",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The number of desired bathrooms"
+    },
+    {
+      "name": "data[].Deposit",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The security deposit amount"
+    },
+    {
+      "name": "data[].ListedMarketRent",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The rent per month as listed on the market",
+      "deprecated": true
+    },
+    {
+      "name": "data[].ListedRent",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The rent per month as listed on the market. This value reflects either the market rent or the advertised rent, depending on whether \"Use Market Rent On Ads\" is enabled in the AppFolio Property Manager."
+    },
+    {
+      "name": "data[].Status",
+      "type": "string",
+      "required": false,
+      "description": "The rental application's status",
+      "enum": ["new", "decision_pending", "approved", "denied", "canceled", "in_review", "info_needed", "in_screening"]
+    },
+    {
+      "name": "data[].StatusChangedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Timestamp indicating when the application's current status was last modified"
+    },
+    {
+      "name": "data[].SubmittedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The time the rental application was submitted"
+    },
+    {
+      "name": "data[].DesiredMoveInDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date the applicant would like to move in"
+    },
+    {
+      "name": "data[].Dependents",
+      "type": "array",
+      "required": false,
+      "description": "Contains details about any dependents of the applicant"
+    },
+    {
+      "name": "data[].Applicant",
+      "type": "object",
+      "required": false,
+      "description": "Contains details about the rental applicant including their name, contact information, and residential and employment history"
+    },
+    {
+      "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/rental_applications?filters[Id]=1abcde23-c543-456e-abc9-123456789cba&filters[PropertyId]=1abcde23-c543-456e-abc9-123456689cba&filters[UnitId]=1abcde23-c543-456e-abc9-123455789cba&filters[SubmittedAtFrom]=2020-12-15' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

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

@@ -0,0 +1,71 @@
+{
+  "operationId": "get_rental_applications_notes",
+  "resource": "rental_applications",
+  "name": "List All Rental Applications Notes",
+  "method": "GET",
+  "path": "/rental_applications/notes",
+  "description": "Returns all rental applications notes that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[RentalApplicationId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by rental application ID; all GET requests must include a filter for [RentalApplicationId] or [LastUpdatedAtFrom]"
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter rental application notes last updated at or after this date/time; all GET requests must include a filter for [RentalApplicationId] or [LastUpdatedAtFrom]"
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of rental application note objects"
+    },
+    {
+      "name": "data[].Body",
+      "type": "string",
+      "required": false,
+      "description": "A brief informative message about the rental application note. A rental application note cannot exceed 63,535 characters."
+    },
+    {
+      "name": "data[].EntityId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The rental application to which the note will be attached"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string",
+      "required": false,
+      "description": "The date the rental application note's details were last updated"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the note associated with the rental application"
+    },
+    {
+      "name": "data[].NoteId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the note associated with the rental application. Deprecated in favor of Id.",
+      "deprecated": true
+    },
+    {
+      "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/rental_applications/notes?filters[RentalApplicationId]=1abcde23-c543-456e-abc9-123456789cba&filters[LastUpdatedAtFrom]=2020-12-15T16:30:46Z' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}