@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,99 @@
+{
+  "operationId": "get_showings",
+  "resource": "showings",
+  "name": "List All Showings",
+  "method": "GET",
+  "path": "/showings",
+  "description": "Returns all showings 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 showing. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter showings last updated at or after this date-time. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of Showing objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the showing"
+    },
+    {
+      "name": "data[].AssignedUserId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The AppFolio Property Manager user responsible for the showing. Reference the Users endpoint for any necessary associations."
+    },
+    {
+      "name": "data[].LeadId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the lead associated with the showing. Reference the Leads endpoint for any necessary associations."
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit that the interested party will be shown. Reference the Units endpoint for any necessary associations."
+    },
+    {
+      "name": "data[].StartAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The start time of the showing. The value must adhere to the ISO 8601 format YYYY-MM-DDThh:mm:ssZ and the default time zone is Coordinated Universal Time (UTC)."
+    },
+    {
+      "name": "data[].EndAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The end time of the showing. The value must adhere to the ISO 8601 format YYYY-MM-DDThh:mm:ssZ and the default time zone is Coordinated Universal Time (UTC)."
+    },
+    {
+      "name": "data[].Notes",
+      "type": "string",
+      "required": false,
+      "description": "A brief informative message about the showing"
+    },
+    {
+      "name": "data[].Status",
+      "type": "string",
+      "required": false,
+      "description": "The status of the showing",
+      "enum": [
+        "scheduled",
+        "canceled",
+        "no-show",
+        "confirmation pending",
+        "prospect confirmed",
+        "prospect canceled",
+        "canceled (unconfirmed)",
+        "cancel in progress",
+        "reschedule in progress"
+      ]
+    },
+    {
+      "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/showings?page[size]=10&page[number]=2&filters[Id]=7f3230dc-8b9a-11ec-9b4b-14482e0fbe8e&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_tenant_ledgers.json

@@ -0,0 +1,82 @@
+{
+  "operationId": "get_tenant_ledgers",
+  "resource": "tenant_ledgers",
+  "name": "List All Tenant Ledgers",
+  "method": "GET",
+  "path": "/tenant_ledgers",
+  "description": "Returns all tenant ledgers that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the property. All requests must include this filter."
+    },
+    {
+      "name": "filters[DateFrom]",
+      "type": "string <date>",
+      "required": true,
+      "description": "Start date for the ledger date range filter. All requests must include this filter."
+    },
+    {
+      "name": "filters[DateTo]",
+      "type": "string <date>",
+      "required": true,
+      "description": "End date for the ledger date range filter. All requests must include this filter."
+    },
+    {
+      "name": "filters[OccupancyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the occupancy to filter ledgers by."
+    },
+    {
+      "name": "filters[ExcludeSubsidies]",
+      "type": "boolean",
+      "required": false,
+      "description": "When true, excludes subsidy entries from the ledger results."
+    },
+    {
+      "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 TenantLedger objects"
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the occupancy associated with the ledger"
+    },
+    {
+      "name": "data[].Ledger",
+      "type": "array",
+      "required": false,
+      "description": "Array of ledger data. 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/tenant_ledgers?filters[DateFrom]=2020-12-15&filters[DateTo]=2020-12-16&filters[PropertyId]=1abcde23-c543-456e-abc9-123456789cee&filters[ExcludeSubsidies]=false&filters[OccupancyId]=8rbcde234-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_tenants.json

@@ -0,0 +1,273 @@
+{
+  "operationId": "get_tenants",
+  "resource": "tenants",
+  "name": "List All Tenants",
+  "method": "GET",
+  "path": "/tenants",
+  "description": "Returns all tenants that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by tenant unique identifier"
+    },
+    {
+      "name": "filters[UnitId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unit unique identifier. Multiple values should be separated by commas."
+    },
+    {
+      "name": "filters[MoveInOnFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter tenants by move-in date (from)"
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter tenants updated at or after this date-time. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[Status]",
+      "type": "string",
+      "required": false,
+      "description": "Filter the results based on one or more statuses. Multiple values should be separated by commas.",
+      "enum": ["Current", "Past", "Future", "Evict", "Notice"]
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of tenant objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the tenant"
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique Identifier of an occupancy of one or more tenants"
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The unit the tenant occupies"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The property with the unit occupied by the tenant"
+    },
+    {
+      "name": "data[].FirstName",
+      "type": "string",
+      "required": false,
+      "description": "The tenant's first name"
+    },
+    {
+      "name": "data[].MiddleName",
+      "type": "string",
+      "required": false,
+      "description": "The tenant's middle name"
+    },
+    {
+      "name": "data[].LastName",
+      "type": "string",
+      "required": false,
+      "description": "The tenant's last name"
+    },
+    {
+      "name": "data[].BirthDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The tenant's birthdate"
+    },
+    {
+      "name": "data[].SocialSecurityNumber",
+      "type": "string",
+      "required": false,
+      "description": "The tenant's social security number"
+    },
+    {
+      "name": "data[].Link",
+      "type": "string <uri>",
+      "required": false,
+      "description": "A link to the tenant's page in the AppFolio Property manager"
+    },
+    {
+      "name": "data[].CompanyName",
+      "type": "string",
+      "required": false,
+      "description": "The display name of the tenant's company"
+    },
+    {
+      "name": "data[].CurrentRent",
+      "type": "number <float>",
+      "required": false,
+      "description": "The amount the tenant currently pays for rent"
+    },
+    {
+      "name": "data[].Status",
+      "type": "string",
+      "required": false,
+      "description": "The status of the tenant",
+      "enum": ["Current", "Past", "Future", "Evict", "Notice"]
+    },
+    {
+      "name": "data[].Addresses",
+      "type": "array",
+      "required": false,
+      "description": "The tenant's address(es)"
+    },
+    {
+      "name": "data[].PhoneNumber",
+      "type": "string",
+      "required": false,
+      "description": "The tenant's primary phone number",
+      "deprecated": true
+    },
+    {
+      "name": "data[].PhoneNumbers",
+      "type": "array",
+      "required": false,
+      "description": "The tenant's phone number(s)"
+    },
+    {
+      "name": "data[].Email",
+      "type": "string <email>",
+      "required": false,
+      "description": "The tenant's primary email address",
+      "deprecated": true
+    },
+    {
+      "name": "data[].Emails",
+      "type": "array",
+      "required": false,
+      "description": "The tenant's emails"
+    },
+    {
+      "name": "data[].MoveInOn",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date the tenant physically started or will start occupancy. Dictates whether the \"future\" or \"current\" option is displayed in the status field."
+    },
+    {
+      "name": "data[].MoveOutOn",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date the tenant physically ended or will end occupancy. Dictates whether the \"notice\" or \"past\" option is displayed in the status field."
+    },
+    {
+      "name": "data[].OccupancyCustomFields",
+      "type": "object",
+      "required": false,
+      "description": "The custom fields for the associated entity"
+    },
+    {
+      "name": "data[].RentalApplicationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier for a tenant-submitted rental application"
+    },
+    {
+      "name": "data[].TenantType",
+      "type": "string",
+      "required": false,
+      "description": "The type of tenant",
+      "enum": ["Financially Responsible", "Other Occupant", "Co-signer"]
+    },
+    {
+      "name": "data[].PrimaryTenant",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the tenant is the primary leaseholder for the occupancy"
+    },
+    {
+      "name": "data[].LastLeaseRenewal",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date the last lease renewal agreement was started"
+    },
+    {
+      "name": "data[].LeaseSignedDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date the lease was executed by the tenant"
+    },
+    {
+      "name": "data[].LeaseStartDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The day the lease agreement starts"
+    },
+    {
+      "name": "data[].LeaseEndDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The last day of the lease agreement"
+    },
+    {
+      "name": "data[].IsMonthlyLease",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the tenant is currently on a month-to-month lease"
+    },
+    {
+      "name": "data[].NextRentIncrease",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date of the tenant is eligible for a rent increase"
+    },
+    {
+      "name": "data[].Pets",
+      "type": "array",
+      "required": false,
+      "description": "Contains details about the tenant's pet(s)"
+    },
+    {
+      "name": "data[].Vehicles",
+      "type": "array",
+      "required": false,
+      "description": "Contains details about the tenant's vehicle(s)"
+    },
+    {
+      "name": "data[].Tags",
+      "type": "Array of strings",
+      "required": false,
+      "description": "User-defined tag(s) that categorize the tenant"
+    },
+    {
+      "name": "data[].HiddenAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "When the tenant 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 tenant'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/tenants?filters[Id]=1abcde23-c543-456e-abc9-123456789cba&filters[UnitId]=1abcde23-c543-456e-abc9-123456789cba,234abcde-c543-456e-abc9-123456789abc&filters[MoveInOnFrom]=2020-12-15T16:30:46Z&filters[LastUpdatedAtFrom]=2020-12-15T16:30:46Z&filters[Status]=Current' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

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

@@ -0,0 +1,71 @@
+{
+  "operationId": "get_tenants_notes",
+  "resource": "tenants",
+  "name": "List All Tenants Notes",
+  "method": "GET",
+  "path": "/tenants/notes",
+  "description": "Returns all tenant notes that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[TenantId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by tenant unique identifier. All GET requests must include a filter for [TenantId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter tenant notes updated at or after this date-time. All GET requests must include a filter for [TenantId] or [LastUpdatedAtFrom]."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of tenant note objects"
+    },
+    {
+      "name": "data[].Body",
+      "type": "string",
+      "required": false,
+      "description": "A brief informative message about the tenant note. A tenant note cannot exceed 63,535 characters."
+    },
+    {
+      "name": "data[].EntityId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The tenant to which the note will be attached"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string",
+      "required": false,
+      "description": "The date the tenant note's details were last updated"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the note associated with the tenant"
+    },
+    {
+      "name": "data[].NoteId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the note associated with the tenant. 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/tenants/notes?filters[TenantId]=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'"
+}