@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,46 @@
+{
+  "operationId": "patch_rental_applications_rentalapplicationid_notes_id",
+  "resource": "rental_applications",
+  "name": "Update Rental Application Note",
+  "method": "PATCH",
+  "path": "/rental_applications/{RentalApplicationId}/notes/{Id}",
+  "description": "Update a note to a rental application",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "RentalApplicationId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The rental application to which the note will be attached"
+    },
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the note to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Note object",
+    "attributes": [
+      {
+        "name": "Body",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message about the rental application note. A rental application note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated rental application note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This rental application has been submitted on 11/11/2023\"\n}"
+}

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

@@ -0,0 +1,69 @@
+{
+  "operationId": "patch_showings_showingid",
+  "resource": "showings",
+  "name": "Update Showing",
+  "method": "PATCH",
+  "path": "/showings/{showingId}",
+  "description": "Update a showing",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "showingId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the showing to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Showing update object",
+    "attributes": [
+      {
+        "name": "AssignedUserId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "AppFolio Property Manager user assigned to the showing. A null value passed to AssignedUserId will unassign the user previously assigned to the showing. Omitting AssignedUserId from the request body will not update the assigned user. Reference the Users endpoint for any necessary associations."
+      },
+      {
+        "name": "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": "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": "Notes",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message about the showing"
+      },
+      {
+        "name": "Status",
+        "type": "string",
+        "required": false,
+        "description": "The status of the showing",
+        "enum": [
+          "scheduled",
+          "canceled",
+          "no-show"
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated showing"
+    }
+  ],
+  "requestSample": "{\n  \"AssignedUserId\": \"f6b42b23-85e1-4a8a-a581-ceab1055e310\",\n  \"EndAt\": \"2022-02-08T18:45:00Z\",\n  \"Notes\": \"Prospect wants to see the unit.\",\n  \"StartAt\": \"2022-02-08T18:30:00Z\",\n  \"Status\": \"canceled\"\n}"
+}

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

@@ -0,0 +1,131 @@
+{
+  "operationId": "patch_tenants_bulk",
+  "resource": "tenants",
+  "name": "Bulk Update Tenants",
+  "method": "PATCH",
+  "path": "/tenants/bulk",
+  "description": "Update Tenants in bulk",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Tenant objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of tenant objects to update",
+        "attributes": [
+          {
+            "name": "Id",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier for the tenant"
+          },
+          {
+            "name": "FirstName",
+            "type": "string",
+            "required": false,
+            "description": "The tenant's first name"
+          },
+          {
+            "name": "LastName",
+            "type": "string",
+            "required": false,
+            "description": "The tenant's last name"
+          },
+          {
+            "name": "MiddleName",
+            "type": "string",
+            "required": false,
+            "description": "The tenant's middle name"
+          },
+          {
+            "name": "CompanyName",
+            "type": "string",
+            "required": false,
+            "description": "The display name of the tenant's company. Cannot be blank unless IsCompany is false."
+          },
+          {
+            "name": "IsCompany",
+            "type": "boolean",
+            "required": false,
+            "description": "Whether the tenant is a company (controls if the company name should be used as the name of the tenant). When true, CompanyName must be set. When false, FirstName and LastName must both be set."
+          },
+          {
+            "name": "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": "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": "PrimaryTenant",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the tenant is the primary leaseholder for the occupancy. At least one PrimaryTenant is required per UnitId. Note: PrimaryTenant: true automatically sets the TenantType to Financially Responsible."
+          },
+          {
+            "name": "TenantType",
+            "type": "string",
+            "required": false,
+            "description": "The type of tenant. At least one tenant with TenantType Financially Responsible is required per UnitId.",
+            "enum": ["Financially Responsible", "Other Occupant", "Co-signer"]
+          },
+          {
+            "name": "Addresses",
+            "type": "array",
+            "required": false,
+            "description": "The tenant's address(es). Passing any number of addresses will replace all existing addresses for the tenant. Passing an empty array [] will remove all existing addresses for the tenant."
+          },
+          {
+            "name": "PhoneNumbers",
+            "type": "array",
+            "required": false,
+            "description": "The tenant's phone number(s). Passing any number of phone numbers will replace all existing phone numbers for the tenant. Passing an empty array [] will remove all existing phone numbers for the tenant."
+          },
+          {
+            "name": "Pets",
+            "type": "array",
+            "required": false,
+            "description": "Contains details about the tenant's pet(s). This will add new pets to the tenant and not remove any existing pets."
+          },
+          {
+            "name": "Vehicles",
+            "type": "array",
+            "required": false,
+            "description": "Contains details about the tenant's vehicle(s). This will add new vehicles to the tenant and not remove any existing vehicles."
+          },
+          {
+            "name": "Emails",
+            "type": "array",
+            "required": false,
+            "description": "The tenant's email address(es). Passing any number of emails will replace all existing email addresses for the tenant. Passing an empty array [] will remove all existing email addresses for the tenant."
+          },
+          {
+            "name": "Tags",
+            "type": "Array of strings",
+            "required": false,
+            "description": "User-defined tag(s) that categorize the tenant. Providing an array of valid strings will overwrite all existing tags. Passing in an empty array [] or an array of empty strings [\"\"] or [\"\", \"\"] will clear all existing tags. Passing in an array of a valid string and an empty string [\"tag_name\", \"\"] will result in Tags: [\"tag_name\"]. Passing in null will result in no change."
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "JobId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the bulk update job"
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {},\n    {}\n  ]\n}"
+}

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

@@ -0,0 +1,48 @@
+{
+  "operationId": "patch_tenants_tenantid",
+  "resource": "tenants",
+  "name": "Update Tenant",
+  "method": "PATCH",
+  "path": "/tenants/{tenantId}",
+  "description": "Update a Tenant",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "tenantId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the tenant to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Tenant object",
+    "attributes": [
+      {
+        "name": "OccupancyCustomFields",
+        "type": "object",
+        "required": false,
+        "description": "The custom fields for the associated entity",
+        "attributes": [
+          {
+            "name": "CustomFieldId",
+            "type": "object",
+            "required": false,
+            "description": "The value of the CustomField to update. Ensure the value set for CustomFieldId matches the type that was set for the CustomField at creation. For example, if boolean is the type set for the CustomField associated with this CustomFieldId, the value set here must be either true or false. Note: To clear the value of a CustomField, set CustomFieldId to null in the PATCH request. For array-type custom fields (select_multiple), use an empty array [] or empty string \"\" instead of null, as null will be ignored."
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated tenant"
+    }
+  ],
+  "requestSample": "{\n  \"OccupancyCustomFields\": {\n    \"a965e7d8-a17d-11ec-b909-0242ac120002\": \"a new value\",\n    \"454d8635-521e-4864-99fb-0bd6200d3a0f\": true,\n    \"c80d3dd1-9eba-45aa-803c-666280b8ff24\": 87.4,\n    \"3277c366-1783-42a9-b925-0bca2afbe391\": \"0e9a7b18-1778-4a03-bc1c-f913aeaef6bc\"\n  }\n}"
+}

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

@@ -0,0 +1,46 @@
+{
+  "operationId": "patch_tenants_tenantid_notes_id",
+  "resource": "tenants",
+  "name": "Update Tenant Note",
+  "method": "PATCH",
+  "path": "/tenants/{TenantId}/notes/{Id}",
+  "description": "Update a note to a tenant",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "TenantId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The tenant to which the note will be attached"
+    },
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the note to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Note object",
+    "attributes": [
+      {
+        "name": "Body",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message about the tenant note. A tenant note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated tenant note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This tenant have scheduled a cleaning service on 11/30/2022 - Updated\"\n}"
+}

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

@@ -0,0 +1,126 @@
+{
+  "operationId": "patch_unit_types_unittypeid",
+  "resource": "unit_types",
+  "name": "Update Unit Type",
+  "method": "PATCH",
+  "path": "/unit_types/{unitTypeId}",
+  "description": "Update a unit Type.",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "unitTypeId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the unit type to update."
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Attributes to update on the unit type.",
+    "attributes": [
+      {
+        "name": "ApplicationFee",
+        "type": "number",
+        "required": false,
+        "description": "The fee charged when applying for a unit of this type. If the property associated with the unit type is payments enabled (if the property's bank account is payment enabled), then the ApplicationFee must be $0.00 or between $6 and $200."
+      },
+      {
+        "name": "Amenities",
+        "type": "Array of strings",
+        "required": false,
+        "description": "The amenities associated with the unit type. Amenity names are case-sensitive. Providing an array of valid strings will overwrite all existing amenities. Passing in an empty array [] or an array of empty strings [\"\"] or [\"\", \"\"] will clear all existing amenities. Passing in an array of a valid string and an empty string [\"amenity_name\", \"\"] will result in Amenities: [\"amenity_name\"]. Passing in null will result in no change."
+      },
+      {
+        "name": "Bathrooms",
+        "type": "number",
+        "required": false,
+        "description": "The number of bathrooms for this unit type."
+      },
+      {
+        "name": "Bedrooms",
+        "type": "integer",
+        "required": false,
+        "description": "The number of bedrooms for this unit type."
+      },
+      {
+        "name": "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": "Deposit",
+        "type": "number",
+        "required": false,
+        "description": "The security deposit amount."
+      },
+      {
+        "name": "DogsAllowed",
+        "type": "string",
+        "required": false,
+        "description": "The unit type's dog policy.",
+        "enum": ["Large & Small", "Small Only", "No"]
+      },
+      {
+        "name": "FutureMarketRent",
+        "type": "number",
+        "required": false,
+        "description": "The projected future market rent for the unit type. This attribute must be provided together with FutureMarketRentEffectiveOn date. Both attributes must either be present or absent together."
+      },
+      {
+        "name": "FutureMarketRentEffectiveOn",
+        "type": "string <date-time>",
+        "required": false,
+        "description": "The date when the FutureMarketRent will take effect. This attribute must be provided together with FutureMarketRent. Both attributes must either be present or absent together."
+      },
+      {
+        "name": "MarketRent",
+        "type": "number <decimal>",
+        "required": false,
+        "description": "The current market rent for the unit type."
+      },
+      {
+        "name": "MarketingTitle",
+        "type": "string",
+        "required": false,
+        "description": "The title of the listing for syndication."
+      },
+      {
+        "name": "MarketingDescription",
+        "type": "string",
+        "required": false,
+        "description": "A description of the listing for syndication."
+      },
+      {
+        "name": "Name",
+        "type": "string",
+        "required": false,
+        "description": "The name of the unit type. This value must be unique per PropertyId, meaning different unit types can use the same Name only when their PropertyIds are different."
+      },
+      {
+        "name": "SquareFeet",
+        "type": "number",
+        "required": false,
+        "description": "The size of the unit type in square feet."
+      },
+      {
+        "name": "YouTubeURL",
+        "type": "string <uri>",
+        "required": false,
+        "description": "The URL of the YouTube video for the listing(s)."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated unit type."
+    }
+  ],
+  "requestSample": "{\n  \"Name\": \"Unit Type A\",\n  \"Amenities\": [\n    \"gym\",\n    \"covered parking\"\n  ],\n  \"ApplicationFee\": 20.23,\n  \"Bathrooms\": 2.5,\n  \"Bedrooms\": 3,\n  \"CatsAllowed\": \"Yes\",\n  \"Deposit\": 300.34,\n  \"DogsAllowed\": \"Large & Small\",\n  \"MarketRent\": 1569.05,\n  \"FutureMarketRent\": 699.99,\n  \"FutureMarketRentEffectiveOn\": \"2022-02-08\",\n  \"MarketingDescription\": \"Sample marketing description\",\n  \"MarketingTitle\": \"Sample marketing title\",\n  \"SquareFeet\": 2000,\n  \"YouTubeURL\": \"https://www.youtube.com/watch?v=abc\"\n}"
+}