@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,146 @@
+{
+  "operationId": "get_ca_board_members",
+  "resource": "ca",
+  "name": "List All Community Association Board Members",
+  "method": "GET",
+  "path": "/ca/board_members",
+  "description": "Returns Community Association (CA) Board of Director Member's details that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[AssociationId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the Community Association. All GET requests must include a filter for [AssociationId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter by last updated date. All GET requests must include a filter for [AssociationId] 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 CABoardMember objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the homeowner on the Board of Directors"
+    },
+    {
+      "name": "data[].AssociationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the association related to the Board of Directors"
+    },
+    {
+      "name": "data[].Email",
+      "type": "string",
+      "required": false,
+      "description": "The Board of Director member's primary email address",
+      "deprecated": true
+    },
+    {
+      "name": "data[].Emails",
+      "type": "Array of objects",
+      "required": false,
+      "description": "The Board of Director member's emails"
+    },
+    {
+      "name": "data[].FirstName",
+      "type": "string",
+      "required": false,
+      "description": "The first name of the Board of Director member"
+    },
+    {
+      "name": "data[].LastName",
+      "type": "string",
+      "required": false,
+      "description": "The last name of the Board of Director member"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the CA Board of Director's details were last updated"
+    },
+    {
+      "name": "data[].MiddleName",
+      "type": "string",
+      "required": false,
+      "description": "The middle name of the Board of Director member"
+    },
+    {
+      "name": "data[].PhoneNumber",
+      "type": "string",
+      "required": false,
+      "description": "The Board of Director member's primary phone number",
+      "deprecated": true
+    },
+    {
+      "name": "data[].PhoneNumbers",
+      "type": "Array of objects",
+      "required": false,
+      "description": "The Board of Director member's phone numbers"
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit related to the Board of Directors"
+    },
+    {
+      "name": "data[].BoardMemberships",
+      "type": "Array of objects",
+      "required": false,
+      "description": "Array containing details about Board of Director memberships",
+      "attributes": [
+        {
+          "name": "Role",
+          "type": "string",
+          "required": false,
+          "description": "The Board of Director member's role. Valid roles include President, Vice President, Treasurer, Secretary/Treasurer, Board Member or other."
+        },
+        {
+          "name": "StartDate",
+          "type": "string <date>",
+          "required": false,
+          "description": "The Board of Director member's term start date"
+        },
+        {
+          "name": "EndDate",
+          "type": "string <date>",
+          "required": false,
+          "description": "The Board of Director member's term end date"
+        }
+      ]
+    },
+    {
+      "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/ca/board_members?filters[AssociationId]=1abcde23-c543-456e-abc9-123456789cee&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_ca_homeowner_ledgers.json

@@ -0,0 +1,70 @@
+{
+  "operationId": "get_ca_homeowner_ledgers",
+  "resource": "ca",
+  "name": "List All Community Association Homeowner Ledgers",
+  "method": "GET",
+  "path": "/ca/homeowner_ledgers",
+  "description": "Returns all Community Association ledgers that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[AssociationId]",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Filter by unique identifier of the Community Association. All GET requests must include filters for [AssociationId], [DateFrom], and [DateTo]."
+    },
+    {
+      "name": "filters[DateFrom]",
+      "type": "string <date>",
+      "required": true,
+      "description": "The start date for filtering homeowner ledger records. All GET requests must include filters for [AssociationId], [DateFrom], and [DateTo]."
+    },
+    {
+      "name": "filters[DateTo]",
+      "type": "string <date>",
+      "required": true,
+      "description": "The end date for filtering homeowner ledger records. All GET requests must include filters for [AssociationId], [DateFrom], and [DateTo]."
+    },
+    {
+      "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 CaHomeownerLedger objects"
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the occupancy associated with the ledger"
+    },
+    {
+      "name": "data[].Ledger",
+      "type": "Array of objects",
+      "required": false,
+      "description": "This contains the charges, payments, and credits for the occupancy specified by the OccupancyId"
+    },
+    {
+      "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/ca/homeowner_ledgers?filters[DateFrom]=2020-12-15&filters[DateTo]=2020-12-16&filters[AssociationId]=1abcde23-c543-456e-abc9-123456789cee' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

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

@@ -0,0 +1,151 @@
+{
+  "operationId": "get_ca_homeowners",
+  "resource": "ca",
+  "name": "List All Community Association Homeowners",
+  "method": "GET",
+  "path": "/ca/homeowners",
+  "description": "Returns Community Association (CA) homeowners 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 CA homeowner. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter CA homeowners by last updated date. All GET requests must include a filter for [Id] (if available), 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 CAHomeowner objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the CA homeowner"
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit associated with the CA homeowner"
+    },
+    {
+      "name": "data[].AssociationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the association associated with the CA homeowner"
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique Identifier of a CA occupancy of one or more CA homeowners"
+    },
+    {
+      "name": "data[].FirstName",
+      "type": "string",
+      "required": false,
+      "description": "The first name of the CA homeowner"
+    },
+    {
+      "name": "data[].MailingAddress",
+      "type": "Array of objects",
+      "required": false,
+      "description": "The homeowner's mailing address"
+    },
+    {
+      "name": "data[].MiddleName",
+      "type": "string",
+      "required": false,
+      "description": "The middle name of the CA homeowner"
+    },
+    {
+      "name": "data[].LastName",
+      "type": "string",
+      "required": false,
+      "description": "The last name of the CA homeowner"
+    },
+    {
+      "name": "data[].PhoneNumber",
+      "type": "string",
+      "required": false,
+      "description": "The CA homeowner's primary phone number",
+      "deprecated": true
+    },
+    {
+      "name": "data[].PhoneNumbers",
+      "type": "Array of objects",
+      "required": false,
+      "description": "The CA homeowner's phone numbers"
+    },
+    {
+      "name": "data[].Status",
+      "type": "string",
+      "required": false,
+      "description": "The status of the Community Association homeowner",
+      "enum": ["Current", "Past", "Future", "Notice", "Foreclosure"]
+    },
+    {
+      "name": "data[].Email",
+      "type": "string",
+      "required": false,
+      "description": "The CA homeowner's primary email address",
+      "deprecated": true
+    },
+    {
+      "name": "data[].Emails",
+      "type": "Array of objects",
+      "required": false,
+      "description": "The CA homeowner's emails"
+    },
+    {
+      "name": "data[].InCollections",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the CA Homeowner is in collections"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the CA homeowner's details were last updated"
+    },
+    {
+      "name": "data[].Link",
+      "type": "string <uri>",
+      "required": false,
+      "description": "A link to the occupancy page of the homeowner"
+    },
+    {
+      "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/ca/homeowners?filters[AssociationId]=1abcde23-c543-456e-abc9-123456789cee&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_ca_renters.json

@@ -0,0 +1,132 @@
+{
+  "operationId": "get_ca_renters",
+  "resource": "ca",
+  "name": "List All Community Association Renters",
+  "method": "GET",
+  "path": "/ca/renters",
+  "description": "Returns Community Association (CA) renters 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 CA renter. All GET requests must include a filter for [Id], [AssociationId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[AssociationId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the Community Association. All GET requests must include a filter for [Id], [AssociationId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter CA renters by last updated date. All GET requests must include a filter for [Id], [AssociationId] 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 CARenter objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the CA renter"
+    },
+    {
+      "name": "data[].AssociationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the association related to the CA renter"
+    },
+    {
+      "name": "data[].Email",
+      "type": "string",
+      "required": false,
+      "description": "The CA renter's primary email address",
+      "deprecated": true
+    },
+    {
+      "name": "data[].Emails",
+      "type": "Array of objects",
+      "required": false,
+      "description": "The CA renter's emails"
+    },
+    {
+      "name": "data[].FirstName",
+      "type": "string",
+      "required": false,
+      "description": "The first name of the CA renter"
+    },
+    {
+      "name": "data[].LastName",
+      "type": "string",
+      "required": false,
+      "description": "The last name of the CA renter"
+    },
+    {
+      "name": "data[].PhoneNumber",
+      "type": "string",
+      "required": false,
+      "description": "The CA renter's primary phone number",
+      "deprecated": true
+    },
+    {
+      "name": "data[].PhoneNumbers",
+      "type": "Array of objects",
+      "required": false,
+      "description": "The CA renter's phone numbers"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Returns the CA renters records that have been updated since the date provided. The default time zone is Coordinated Universal Time (UTC)."
+    },
+    {
+      "name": "data[].LeaseEndDate",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the CA renter's lease ends"
+    },
+    {
+      "name": "data[].LeaseStartDate",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the CA renter's lease starts"
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit related to the CA renter"
+    },
+    {
+      "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/ca/renters?filters[AssociationId]=1abcde23-c543-456e-abc9-123456789cee&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_ca_rules.json

@@ -0,0 +1,76 @@
+{
+  "operationId": "get_ca_rules",
+  "resource": "ca",
+  "name": "List All Community Association Rules",
+  "method": "GET",
+  "path": "/ca/rules",
+  "description": "Returns Community Association (CA) rules that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": true,
+      "description": "Filter CA rules by last updated date. All GET requests must include a filter for [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 CARule objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the CA rule"
+    },
+    {
+      "name": "data[].AssociationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the association related to the rule(s)"
+    },
+    {
+      "name": "data[].RuleName",
+      "type": "string",
+      "required": false,
+      "description": "The name of the CA rule"
+    },
+    {
+      "name": "data[].RuleDescription",
+      "type": "string",
+      "required": false,
+      "description": "A brief summary or description of the CA rule"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The last time a CA rule's details were updated by an AppFolio Property Manager user"
+    },
+    {
+      "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/ca/rules?filters[AssociationId]=1abcde23-c543-456e-abc9-123456789cee&filters[LastUpdatedAtFrom]=2020-12-15T16:30:46Z' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}