@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,168 @@
+{
+  "operationId": "get_unit_types",
+  "resource": "unit_types",
+  "name": "List All Unit Types",
+  "method": "GET",
+  "path": "/unit_types",
+  "description": "Returns all unit types that meet the filter criteria.",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unit type Id. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by the unique identifier of the property associated with the unit type."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter unit types last updated at or after this date-time. 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 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 unit type objects."
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit type."
+    },
+    {
+      "name": "data[].ApplicationFee",
+      "type": "number",
+      "required": false,
+      "description": "The application fee amount."
+    },
+    {
+      "name": "data[].Amenities",
+      "type": "Array of strings",
+      "required": false,
+      "description": "The amenities associated with the unit type. Amenity names are case-sensitive."
+    },
+    {
+      "name": "data[].Bathrooms",
+      "type": "number",
+      "required": false,
+      "description": "The number of bathrooms for this unit type."
+    },
+    {
+      "name": "data[].Bedrooms",
+      "type": "integer",
+      "required": false,
+      "description": "The number of bedrooms for this unit type."
+    },
+    {
+      "name": "data[].CatsAllowed",
+      "type": "string",
+      "required": false,
+      "description": "The unit type's cat policy. Valid values include \"Yes\", \"No\" or null. A null value indicates that the unit type may not have specified a policy for cats.",
+      "enum": ["Yes", "No"]
+    },
+    {
+      "name": "data[].Deposit",
+      "type": "number",
+      "required": false,
+      "description": "The security deposit amount."
+    },
+    {
+      "name": "data[].DogsAllowed",
+      "type": "string",
+      "required": false,
+      "description": "The unit type's dog policy.",
+      "enum": ["Large & Small", "Small Only", "No"]
+    },
+    {
+      "name": "data[].FutureMarketRent",
+      "type": "number",
+      "required": false,
+      "description": "The projected future market rent for the unit type."
+    },
+    {
+      "name": "data[].FutureMarketRentEffectiveOn",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date when the future market rent becomes effective."
+    },
+    {
+      "name": "data[].MarketRent",
+      "type": "number",
+      "required": false,
+      "description": "The current market rent for the unit type."
+    },
+    {
+      "name": "data[].MarketingTitle",
+      "type": "string",
+      "required": false,
+      "description": "The title of the listing for syndication."
+    },
+    {
+      "name": "data[].MarketingDescription",
+      "type": "string",
+      "required": false,
+      "description": "A description of the listing for syndication."
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name of the unit type."
+    },
+    {
+      "name": "data[].SquareFeet",
+      "type": "number",
+      "required": false,
+      "description": "The size of the unit type in square feet."
+    },
+    {
+      "name": "data[].YouTubeURL",
+      "type": "string <uri>",
+      "required": false,
+      "description": "The URL of the YouTube video for the listing(s)."
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the unit type."
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the unit type 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/unit_types?filters[Id]=fabcde23-c543-456e-abc9-123456789cba&filters[PropertyId]=12bcde23-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_units.json

@@ -0,0 +1,359 @@
+{
+  "operationId": "get_units",
+  "resource": "units",
+  "name": "List All Units",
+  "method": "GET",
+  "path": "/units",
+  "description": "Returns all 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 unit"
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the property associated with the unit"
+    },
+    {
+      "name": "filters[UnitGroupId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the unit group the unit is a part of"
+    },
+    {
+      "name": "filters[LeasingType]",
+      "type": "string",
+      "required": false,
+      "description": "Filter results based on a single leasing type value. Enum: \"ConventionalUnit\" \"BedUnit\""
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter units 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 unit objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The unit name as displayed in the AppFolio Property Manager"
+    },
+    {
+      "name": "data[].Bathrooms",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The number of desired bathrooms"
+    },
+    {
+      "name": "data[].Bedrooms",
+      "type": "integer",
+      "required": false,
+      "description": "The number of desired bedrooms"
+    },
+    {
+      "name": "data[].CustomFields",
+      "type": "object",
+      "required": false,
+      "description": "The custom fields for the associated entity"
+    },
+    {
+      "name": "data[].SquareFeet",
+      "type": "string",
+      "required": false,
+      "description": "The size of the unit in square feet"
+    },
+    {
+      "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 plus amenities fees or the advertised rent, depending on whether \"Use Market Rent On Ads\" is enabled in AppFolio Property Manager."
+    },
+    {
+      "name": "data[].MarketRent",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The unit's base market rent, representing its estimated fair market value based on current market conditions and comparable properties. This value may differ from ListedRent, as it does not include advertised adjustments or amenity fees."
+    },
+    {
+      "name": "data[].Status",
+      "type": "string",
+      "required": false,
+      "description": "The status of the unit. Enum: \"Occupied\" \"Vacant\" \"Vacant Rented\" \"Notice\" \"Notice Rented\""
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the unit"
+    },
+    {
+      "name": "data[].CurrentOccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the current occupant of the unit"
+    },
+    {
+      "name": "data[].UnitGroupId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit group the unit is a part of"
+    },
+    {
+      "name": "data[].LeasingType",
+      "type": "string",
+      "required": false,
+      "description": "The type of lease for the unit. Enum: \"ConventionalUnit\" \"BedUnit\""
+    },
+    {
+      "name": "data[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief, informative description of the unit"
+    },
+    {
+      "name": "data[].Address1",
+      "type": "string",
+      "required": false,
+      "description": "The primary street address of the unit"
+    },
+    {
+      "name": "data[].Address2",
+      "type": "string",
+      "required": false,
+      "description": "Additional street address information pertaining to the unit"
+    },
+    {
+      "name": "data[].City",
+      "type": "string",
+      "required": false,
+      "description": "The city where the unit is located"
+    },
+    {
+      "name": "data[].State",
+      "type": "string",
+      "required": false,
+      "description": "The state where the unit is located"
+    },
+    {
+      "name": "data[].Zip",
+      "type": "string",
+      "required": false,
+      "description": "The zip code where the unit is located"
+    },
+    {
+      "name": "data[].MaintenanceNotes",
+      "type": "string",
+      "required": false,
+      "description": "A brief informative message about the unit's maintenance"
+    },
+    {
+      "name": "data[].MarketingTitle",
+      "type": "string",
+      "required": false,
+      "description": "The title of the listing for syndication"
+    },
+    {
+      "name": "data[].MarketingDescription",
+      "type": "string",
+      "required": false,
+      "description": "A description of the listing for syndication"
+    },
+    {
+      "name": "data[].NonRevenue",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the unit is rentable and is a model unit, office or other non revenue unit"
+    },
+    {
+      "name": "data[].ApplicationURL",
+      "type": "string",
+      "required": false,
+      "description": "The URL link(s) to the application page of the unit(s) accepting online applications"
+    },
+    {
+      "name": "data[].AppliancesIncluded",
+      "type": "Array of strings",
+      "required": false,
+      "description": "User-defined appliances that are included with the unit"
+    },
+    {
+      "name": "data[].AcceptingApplications",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the unit is accepting applications"
+    },
+    {
+      "name": "data[].PostedToInternet",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the unit has been posted to a third-party listings page."
+    },
+    {
+      "name": "data[].PostedToWebsite",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether a vacant unit was posted to the AppFolio listings page."
+    },
+    {
+      "name": "data[].YouTubeURL",
+      "type": "string <uri>",
+      "required": false,
+      "description": "The URL of the YouTube video for the listing(s)"
+    },
+    {
+      "name": "data[].Link",
+      "type": "string <uri>",
+      "required": false,
+      "description": "A link to the unit page in the AppFolio Property Manager"
+    },
+    {
+      "name": "data[].Deposit",
+      "type": "string",
+      "required": false,
+      "description": "The security deposit amount"
+    },
+    {
+      "name": "data[].CatsAllowed",
+      "type": "string",
+      "required": false,
+      "description": "The unit's cat policy. Enum: \"Yes\" \"No\" or null"
+    },
+    {
+      "name": "data[].DogsAllowed",
+      "type": "string",
+      "required": false,
+      "description": "The unit's dog policy. Enum: \"Large & Small\" \"Small Only\" \"No\" or null"
+    },
+    {
+      "name": "data[].Tags",
+      "type": "Array of strings",
+      "required": false,
+      "description": "User-defined tag(s) that categorize the unit"
+    },
+    {
+      "name": "data[].UnitType",
+      "type": "string",
+      "required": false,
+      "description": "The floor plan of the unit"
+    },
+    {
+      "name": "data[].UnitTypeId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the floor plan associated with the unit"
+    },
+    {
+      "name": "data[].UtilitiesIncluded",
+      "type": "Array of strings",
+      "required": false,
+      "description": "User-defined utilities that are included with the unit"
+    },
+    {
+      "name": "data[].CreatedAt",
+      "type": "string",
+      "required": false,
+      "description": "When the unit was created in the AppFolio Property Manager"
+    },
+    {
+      "name": "data[].RentStatus",
+      "type": "null or string",
+      "required": false,
+      "description": "Status / type of rent control. Enum: null \"RentControlled\" \"RentStabilized\" \"Decontrolled\""
+    },
+    {
+      "name": "data[].ApplicationFee",
+      "type": "string",
+      "required": false,
+      "description": "The application fee amount"
+    },
+    {
+      "name": "data[].Amenities",
+      "type": "Array of objects",
+      "required": false,
+      "description": "Array containing a unit's amenities"
+    },
+    {
+      "name": "data[].HvacFilters",
+      "type": "Array of objects",
+      "required": false,
+      "description": "Array containing a unit's HVAC filters"
+    },
+    {
+      "name": "data[].HvacDetail",
+      "type": "object",
+      "required": false,
+      "description": "The HVAC details of the unit"
+    },
+    {
+      "name": "data[].RentReady",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the unit is ready to be occupied by a tenant"
+    },
+    {
+      "name": "data[].AvailableOn",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date upon which the unit can be leased"
+    },
+    {
+      "name": "data[].LastInspectedDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date the unit was last inspected"
+    },
+    {
+      "name": "data[].ReadyForShowingOn",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date upon which the unit is ready for showing"
+    },
+    {
+      "name": "data[].HiddenAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "When the property was marked inactive state by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the 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/units?filters[Id]=1abcde23-c543-456e-abc9-123456789cba&filters[PropertyId]=1abcde23-c543-456e-abc9-123456789cee,1abcde23-c543-456e-abc9-123456789cbb&filters[UnitGroupId]=abcdef23-c543-456e-abc9-123456789cba&filters[LeasingType]=BedUnit&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_units_attachments.json

@@ -0,0 +1,76 @@
+{
+  "operationId": "get_units_attachments",
+  "resource": "units",
+  "name": "List All Unit Attachments",
+  "method": "GET",
+  "path": "/units/attachments",
+  "description": "Returns all attachments associated with a unit",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[UnitId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unit ID. All GET requests must include a filter for [UnitId] or [CreatedAtFrom]."
+    },
+    {
+      "name": "filters[CreatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter by creation date from. All GET requests must include a filter for [UnitId] or [CreatedAtFrom]."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of unit 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 unit 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 unit attachment was created by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].EntityId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit 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/units/attachments?page[size]=10&page[number]=2&filters[UnitId]=1abcde23-c543-456e-abc9-123456789cba&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_units_notes.json

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