@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,130 @@
+{
+  "operationId": "get_ca_units",
+  "resource": "ca",
+  "name": "List All Community Association Units",
+  "method": "GET",
+  "path": "/ca/units",
+  "description": "Returns all Community Association (CA) units 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 unit"
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter for CA units updated at or after this date. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[AssociationId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the association associated with the unit"
+    },
+    {
+      "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 of objects (CAUnit)",
+      "required": false,
+      "description": "Array of CA unit objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the CA unit"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name of the CA unit"
+    },
+    {
+      "name": "data[].AssociationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the CA associated with the unit"
+    },
+    {
+      "name": "data[].CurrentOccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the current occupancy associated with the CA unit"
+    },
+    {
+      "name": "data[].CustomFields",
+      "type": "object (CustomFields.Attribute)",
+      "required": false,
+      "description": "The custom fields for the associated entity"
+    },
+    {
+      "name": "data[].Address1",
+      "type": "string",
+      "required": false,
+      "description": "The primary street address of the CA unit"
+    },
+    {
+      "name": "data[].Address2",
+      "type": "string",
+      "required": false,
+      "description": "Additional street address information pertaining to the CA unit"
+    },
+    {
+      "name": "data[].City",
+      "type": "string",
+      "required": false,
+      "description": "The city where the CA unit is located"
+    },
+    {
+      "name": "data[].RenterOccupied",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the CA unit is occupied by a renter"
+    },
+    {
+      "name": "data[].State",
+      "type": "string",
+      "required": false,
+      "description": "The state where the CA unit is located"
+    },
+    {
+      "name": "data[].Zip",
+      "type": "string",
+      "required": false,
+      "description": "The zip code where the CA unit is located"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the CA unit'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/ca/units?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_violations.json

@@ -0,0 +1,119 @@
+{
+  "operationId": "get_ca_violations",
+  "resource": "ca",
+  "name": "List All Community Association Violations",
+  "method": "GET",
+  "path": "/ca/violations",
+  "description": "Returns Community Association (CA) violations that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": true,
+      "description": "Filter for CA violations updated at or after this date. All GET requests must include a filter for [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[AssociationId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the association related to the violation(s)"
+    },
+    {
+      "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 of objects (CAViolation)",
+      "required": false,
+      "description": "Array of CA violation objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the CA violation"
+    },
+    {
+      "name": "data[].AssociationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the association related to the violation(s)"
+    },
+    {
+      "name": "data[].CreatedAt",
+      "type": "string",
+      "required": false,
+      "description": "The date the CA violation was created"
+    },
+    {
+      "name": "data[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief summary or description of the CA violation"
+    },
+    {
+      "name": "data[].InspectionDate",
+      "type": "string",
+      "required": false,
+      "description": "The date of the CA unit's inspection"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The last time a CA violation's details were updated by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].MarkedForEscalation",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the CA violation was marked for escalation"
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the occupancy associated with the CA violation"
+    },
+    {
+      "name": "data[].Status",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the current status of the CA violation",
+      "enum": ["In Progress", "In Dispute", "Corrected", "On Hold"]
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit associated with the CA violation"
+    },
+    {
+      "name": "data[].ViolatedRuleId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the CA rule that was violated"
+    },
+    {
+      "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/violations?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_charges.json

@@ -0,0 +1,76 @@
+{
+  "operationId": "get_charges",
+  "resource": "charges",
+  "name": "List All Charges",
+  "method": "GET",
+  "path": "/charges",
+  "description": "Returns all open charges for all occupants residing at the property.",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by charge ID. All GET requests must include a filter for [Id] or [PropertyId]."
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by property ID. All GET requests must include a filter for [Id] or [PropertyId]."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of Charge objects."
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the charge."
+    },
+    {
+      "name": "data[].AmountDue",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The current amount outstanding, and/or future amounts not yet paid."
+    },
+    {
+      "name": "data[].ChargedOn",
+      "type": "string <date>",
+      "required": false,
+      "description": "ChargedOn dates from the past indicate an outstanding charge(s) that have not yet been paid that are \"owed.\" ChargedOn dates in the future indicate upcoming charge(s) during the next monthly period."
+    },
+    {
+      "name": "data[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief summary or description of the charge."
+    },
+    {
+      "name": "data[].GlAccountId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the General Ledger Account associated with the charge."
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the occupancy associated with the charge."
+    },
+    {
+      "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/charges?filters[Id]=1abcde23-c543-456e-abc9-123456789cba&filters[PropertyId]=3b5344d0-482b-4b50-b30f-2dd67412b517' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002' \\\n     --header 'Authorization: Basic {Auth}'"
+}

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

@@ -0,0 +1,88 @@
+{
+  "operationId": "get_corporate_entities",
+  "resource": "corporate_entities",
+  "name": "List All Corporate Entities",
+  "method": "GET",
+  "path": "/corporate_entities",
+  "description": "Returns all corporate entities that meet the filter criteria. Corporate entities represent properties with PropertyType = \"Corporate\" used for corporate accounting purposes.",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by the unique identifier of a specific corporate entity. All GET requests must include a filter for [Id], [Ids], or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[Ids]",
+      "type": "string",
+      "required": false,
+      "description": "Filter by multiple unique identifiers of corporate entities. All GET requests must include a filter for [Id], [Ids], or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter corporate entities last updated at or after this date-time. All GET requests must include a filter for [Id], [Ids], 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 CorporateEntity objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the corporate entity"
+    },
+    {
+      "name": "data[].DisplayName",
+      "type": "string",
+      "required": false,
+      "description": "The display name of the corporate entity"
+    },
+    {
+      "name": "data[].Hidden",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the corporate entity is hidden by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the corporate entity's details were last updated"
+    },
+    {
+      "name": "data[].HiddenAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the corporate entity was hidden. Null if not hidden."
+    },
+    {
+      "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/corporate_entities?filters[Id]=1abcde234-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_custom_fields.json

@@ -0,0 +1,120 @@
+{
+  "operationId": "get_custom_fields",
+  "resource": "custom_fields",
+  "name": "List All Custom Fields",
+  "method": "GET",
+  "path": "/custom_fields",
+  "description": "Returns all custom fields that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": true,
+      "description": "Filters for custom fields. 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 custom field objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the custom field"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name of the custom field"
+    },
+    {
+      "name": "data[].EntityType",
+      "type": "string",
+      "required": false,
+      "description": "The type of entity for which the custom field was created. Entity types include properties, units, associations, and others."
+    },
+    {
+      "name": "data[].EntitySubType",
+      "type": "string",
+      "required": false,
+      "description": "The sub-type of the entity for which the custom field was created. For example, a property entity's sub-type could be \"Single Family.\" If EntitySubType is null, the field applies to all possible entity sub-types."
+    },
+    {
+      "name": "data[].Instruction",
+      "type": "string",
+      "required": false,
+      "description": "Any additional instructions or clarification relating to the custom field"
+    },
+    {
+      "name": "data[].DefaultValue",
+      "type": "string",
+      "required": false,
+      "description": "The default value set for the custom attribute. If DefaultValue is null, no default value was set for this custom field."
+    },
+    {
+      "name": "data[].Required",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the custom attribute was marked as required by the AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].Type",
+      "type": "string",
+      "required": false,
+      "description": "The type of custom attribute.",
+      "enum": [
+        "boolean",
+        "currency",
+        "date",
+        "decimal",
+        "select",
+        "select_multiple",
+        "email",
+        "link",
+        "number",
+        "percent",
+        "phone_number",
+        "text_line"
+      ]
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the custom field's details were last updated"
+    },
+    {
+      "name": "data[].Options",
+      "type": "array",
+      "required": false,
+      "description": "The option(s) set for the custom attribute. If Type is set to Select or Select Multiple, several values can be present."
+    },
+    {
+      "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/custom_fields?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_delinquent_charges.json

@@ -0,0 +1,88 @@
+{
+  "operationId": "get_delinquent_charges",
+  "resource": "delinquent_charges",
+  "name": "List All Delinquent Charges",
+  "method": "GET",
+  "path": "/delinquent_charges",
+  "description": "Returns all delinquent charges 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 delinquent charge"
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by the unique identifier of the property associated with the delinquent charge. Accepts comma-separated values for multiple properties."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of delinquent charge objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the delinquent charge"
+    },
+    {
+      "name": "data[].AmountDue",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The current amount outstanding for the delinquent charge"
+    },
+    {
+      "name": "data[].ChargedOn",
+      "type": "string <date>",
+      "required": false,
+      "description": "ChargedOn dates from the past indicate an outstanding charge(s) that have not yet been paid that are \"owed.\" The endpoint will return all currently outstanding charges with their respective amounts and ChargedOn date."
+    },
+    {
+      "name": "data[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief summary or description of the delinquent charge"
+    },
+    {
+      "name": "data[].GlAccountId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the general ledger account associated with the delinquent charge"
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the occupancy associated with the delinquent charge"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The last time the delinquent charge was updated. On the date the charge becomes delinquent, this value will always be the current time."
+    },
+    {
+      "name": "data[].Subsidy",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the delinquent charge is subsidized"
+    },
+    {
+      "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/delinquent_charges?filters[Id]=1abcde23-c543-456e-abc9-123456789cba&filters[PropertyId]=1abcde23-c543-456e-abc9-123456789cee,3b5344d0-482b-4b50-b30f-2dd67412b517' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002' \\\n     --header 'Authorization: Basic {Auth}'"
+}