@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,52 @@
+{
+  "operationId": "get_leases_renewal_pricings",
+  "resource": "leases",
+  "name": "List All Lease Renewal Pricings",
+  "method": "GET",
+  "path": "/leases/renewal_pricings",
+  "description": "Returns all lease renewal pricing options that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[LeaseId]",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the lease to filter renewal pricings by. LeaseId is required."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the renewal pricing option"
+    },
+    {
+      "name": "LeaseId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the lease associated with this renewal pricing option"
+    },
+    {
+      "name": "StartDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The start date of the renewal pricing option. The format is YYYY-MM-DD."
+    },
+    {
+      "name": "Price",
+      "type": "integer",
+      "required": false,
+      "description": "The monthly rent price for this renewal pricing option"
+    },
+    {
+      "name": "LeaseTerm",
+      "type": "integer",
+      "required": false,
+      "description": "The lease term in months for this renewal pricing option"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/leases/renewal_pricings?filters[LeaseId]=1abcde23-c543-456e-abc9-123456789cba' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002' \\\n     --header 'Authorization: Basic {Auth}'"
+}

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

@@ -0,0 +1,259 @@
+{
+  "operationId": "get_listings",
+  "resource": "listings",
+  "name": "List All Listings",
+  "method": "GET",
+  "path": "/listings",
+  "description": "Returns all units that are not manually excluded, have no active occupancy with a move-out, notice, or move-in date, are currently advertised on the website or external listing platforms, and satisfy the filter criteria.",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": true,
+      "description": "Filter listings by last updated date/time (from). All GET requests must include this filter."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of Listing objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string",
+      "required": false,
+      "description": "Unique identifier of the listing"
+    },
+    {
+      "name": "data[].AcceptingApplications",
+      "type": "boolean",
+      "required": false,
+      "deprecated": true,
+      "description": "Indicates whether or not the listing is accepting applications"
+    },
+    {
+      "name": "data[].Address1",
+      "type": "string",
+      "required": false,
+      "description": "The primary street address of the listing"
+    },
+    {
+      "name": "data[].Address2",
+      "type": "string",
+      "required": false,
+      "description": "Additional street address information pertaining to the listing"
+    },
+    {
+      "name": "data[].AdvertisedRent",
+      "type": "number <float>",
+      "required": false,
+      "deprecated": true,
+      "description": "The rent per month as advertised"
+    },
+    {
+      "name": "data[].ApplicationFee",
+      "type": "string",
+      "required": false,
+      "description": "The application fee amount for the listing"
+    },
+    {
+      "name": "data[].ApplicationURL",
+      "type": "string",
+      "required": false,
+      "description": "The URL link(s) to the application page of the listing(s) accepting online applications"
+    },
+    {
+      "name": "data[].AvailableOn",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date upon which the listing can be leased"
+    },
+    {
+      "name": "data[].Bathrooms",
+      "type": "number <float>",
+      "required": false,
+      "description": "The number of bathrooms listed for the unit"
+    },
+    {
+      "name": "data[].Bedrooms",
+      "type": "integer",
+      "required": false,
+      "description": "The number of bedrooms listed for the unit"
+    },
+    {
+      "name": "data[].CatsAllowed",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the listing allows cats. A null value indicates that the listing may not have specified a policy for cats."
+    },
+    {
+      "name": "data[].City",
+      "type": "string",
+      "required": false,
+      "description": "The city where the listing is located"
+    },
+    {
+      "name": "data[].Deposit",
+      "type": "number <float>",
+      "required": false,
+      "description": "The security, rent, or pet and cleaning deposit amount"
+    },
+    {
+      "name": "data[].DogPolicy",
+      "type": "string",
+      "required": false,
+      "enum": ["Large & Small", "Small Only", "Not Allowed"],
+      "description": "Indicates whether or not the listing allows dogs. If dogs are allowed, valid values are: \"Large & Small\" or \"Small Only.\""
+    },
+    {
+      "name": "data[].Email",
+      "type": "string",
+      "required": false,
+      "description": "The contact email address associated with the listing"
+    },
+    {
+      "name": "data[].HighAdvertisedRent",
+      "type": "number <float>",
+      "required": false,
+      "description": "The highest rent per month as advertised"
+    },
+    {
+      "name": "data[].IsCampaign",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the listing is a part of a campaign"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the listing's details were last updated"
+    },
+    {
+      "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[].LowAdvertisedRent",
+      "type": "number <float>",
+      "required": false,
+      "description": "The lowest rent per month as advertised"
+    },
+    {
+      "name": "data[].MarketingDescription",
+      "type": "string",
+      "required": false,
+      "description": "A description of the listing for syndication"
+    },
+    {
+      "name": "data[].MarketingTitle",
+      "type": "string",
+      "required": false,
+      "description": "The title of the listing for syndication"
+    },
+    {
+      "name": "data[].PhoneNumber",
+      "type": "string",
+      "required": false,
+      "description": "The contact phone number associated with the listing. Includes the extension number if applicable."
+    },
+    {
+      "name": "data[].PostedToWebsite",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not a vacant unit was posted to the AppFolio listings page. If true, the unit is displayed on the AppFolio listings page and accepting applications. If false, the unit is not displayed on the AppFolio listings page."
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the listing"
+    },
+    {
+      "name": "data[].PropertyMarketingDescription",
+      "type": "string",
+      "required": false,
+      "description": "A description of the property associated with the listing for syndication"
+    },
+    {
+      "name": "data[].PropertyMarketingTitle",
+      "type": "string",
+      "required": false,
+      "description": "The title of the property associated with the listing for syndication"
+    },
+    {
+      "name": "data[].SquareFeet",
+      "type": "number <float>",
+      "required": false,
+      "description": "The size of the listing in square feet"
+    },
+    {
+      "name": "data[].State",
+      "type": "string",
+      "required": false,
+      "description": "The state where the listing is located"
+    },
+    {
+      "name": "data[].UnitAmenities",
+      "type": "array of strings",
+      "required": false,
+      "description": "The amenities offered by the building in the listing"
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit associated with the listing"
+    },
+    {
+      "name": "data[].UnitPhotos",
+      "type": "array of objects (ListingsPhoto)",
+      "required": false,
+      "description": "Photos of the listing"
+    },
+    {
+      "name": "data[].UnitType",
+      "type": "string",
+      "required": false,
+      "description": "The floor plan of the listing"
+    },
+    {
+      "name": "data[].UnitTypeId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the UnitType for the listing"
+    },
+    {
+      "name": "data[].UtilitiesIncluded",
+      "type": "array of strings",
+      "required": false,
+      "description": "The utilities which are included with rent"
+    },
+    {
+      "name": "data[].YouTubeURL",
+      "type": "string",
+      "required": false,
+      "description": "The URL of the YouTube video for the listing"
+    },
+    {
+      "name": "data[].Zip",
+      "type": "string",
+      "required": false,
+      "description": "The zip code where the listing is located"
+    },
+    {
+      "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/listings?filters[LastUpdatedAtFrom]=2022-10-01T16:30:46Z' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

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

@@ -0,0 +1,70 @@
+{
+  "operationId": "get_occupancies_documents",
+  "resource": "occupancies",
+  "name": "List All Occupancies Documents",
+  "method": "GET",
+  "path": "/occupancies/documents",
+  "description": "Returns all occupancy's documents that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[OccupancyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by occupancy identifier. All GET requests must include a filter for [OccupancyId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter occupancy documents 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 is 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Number of results per page. Default is 50."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of occupancy objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the occupancy"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the occupancy's details were last updated"
+    },
+    {
+      "name": "data[].OccupancyDocuments",
+      "type": "array",
+      "required": false,
+      "description": "Array containing a list of documents associated with an occupancy. An occupancy document is classified as either a lease or a supporting document"
+    },
+    {
+      "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/occupancies/documents?filters[OccupancyId]=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_owner_groups.json

@@ -0,0 +1,230 @@
+{
+  "operationId": "get_owner_groups",
+  "resource": "owner_groups",
+  "name": "List All Owner Groups",
+  "method": "GET",
+  "path": "/owner_groups",
+  "description": "Returns all property owner groups 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 owner group. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter owner groups 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": "Number of results per page. Default is 1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of owner group objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the owner group"
+    },
+    {
+      "name": "data[].Current",
+      "type": "boolean",
+      "required": false,
+      "description": "The current owner(s) of the properties in the property group"
+    },
+    {
+      "name": "data[].FiscalYearEnd",
+      "type": "integer",
+      "required": false,
+      "description": "The month number representing the end of the fiscal year"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date owners groups details were last updated"
+    },
+    {
+      "name": "data[].Owners",
+      "type": "array",
+      "required": false,
+      "description": "List of owners within an ownership group",
+      "attributes": [
+        {
+          "name": "Id",
+          "type": "string",
+          "required": false,
+          "description": "Unique identifier an owner within an owner group. UUID format e.g. \"38a5a5bb-dc30-49a2-b175-1de0d1488c43\""
+        },
+        {
+          "name": "ContractExpiration",
+          "type": "string",
+          "required": false,
+          "description": "The date when the owner's contract expires. The date must be in YYYY-MM-DD format."
+        },
+        {
+          "name": "CompanyName",
+          "type": "string",
+          "required": false,
+          "description": "Optional display name of the owner's company"
+        },
+        {
+          "name": "Email",
+          "type": "string",
+          "required": false,
+          "description": "The owner's primary email address"
+        },
+        {
+          "name": "PhoneNumber",
+          "type": "string",
+          "required": false,
+          "description": "Primary phone number"
+        },
+        {
+          "name": "FirstName",
+          "type": "string",
+          "required": false,
+          "description": "The owner's first name"
+        },
+        {
+          "name": "LastName",
+          "type": "string",
+          "required": false,
+          "description": "The owner's last name"
+        },
+        {
+          "name": "Link",
+          "type": "string",
+          "required": false,
+          "description": "A link to the owner's page in the AppFolio Property Manager."
+        },
+        {
+          "name": "MaintenanceNotes",
+          "type": "string",
+          "required": false,
+          "description": "Maintenance notes for the properties owned"
+        },
+        {
+          "name": "HiddenAt",
+          "type": "string",
+          "required": false,
+          "description": "When the owner group was labeled no longer active by an AppFolio Property Manager user. Valid format is in ISO 8601 format: \"YYYY-MM-DDTHH:mm:ssZ\" e.g. \"2022-06-00T12:00:00Z\". The default time zone is Coordinated Universal Time (UTC)."
+        },
+        {
+          "name": "IsCompany",
+          "type": "boolean",
+          "required": false,
+          "description": "Indicates whether or not the owner identifies as a company"
+        },
+        {
+          "name": "Address1",
+          "type": "string",
+          "required": false,
+          "description": "The primary street address of the owner"
+        },
+        {
+          "name": "Address2",
+          "type": "string",
+          "required": false,
+          "description": "Additional street address information pertaining to the owner"
+        },
+        {
+          "name": "City",
+          "type": "string",
+          "required": false,
+          "description": "The city where the owner is located"
+        },
+        {
+          "name": "State",
+          "type": "string",
+          "required": false,
+          "description": "The state where the owner is located"
+        },
+        {
+          "name": "Zip",
+          "type": "string",
+          "required": false,
+          "description": "The zip code where the owner is located"
+        },
+        {
+          "name": "CountryCode",
+          "type": "string",
+          "required": false,
+          "description": "The country code of the owner (e.g. \"JP\" for Japan)"
+        },
+        {
+          "name": "PercentOwned",
+          "type": "string",
+          "required": false,
+          "description": "The percentage of ownership assigned to this owner. The sum of PercentOwned across all owners must equal 100%."
+        }
+      ]
+    },
+    {
+      "name": "data[].OwnerPacketBasis",
+      "type": "string",
+      "required": false,
+      "description": "The accounting method used for owner packet calculations. Valid values are \"Cash\" or \"Accrual\".",
+      "enum": ["Cash", "Accrual"]
+    },
+    {
+      "name": "data[].PaymentType",
+      "type": "string",
+      "required": false,
+      "description": "The type of payment distribution for the owners. Valid values are \"Net Income\" or \"Flat\".",
+      "enum": ["Net Income", "Flat"]
+    },
+    {
+      "name": "data[].PaymentAmount",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The fixed payment amount to distribute to owners. This value is required when PaymentType is \"Flat\"."
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with all owners within the owner group"
+    },
+    {
+      "name": "data[].StartDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date when this ownership group becomes effective. The date must be in YYYY-MM-DD format and cannot be set in the future."
+    },
+    {
+      "name": "data[].ReserveFunds",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The amount of funds to maintain in reserve for the property"
+    },
+    {
+      "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/owner_groups?filters[PropertyId]=bfcb95e8-d5fb-448c-b811-88d9f832e79c' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}