@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_rental_applications_rentalapplicationid_notes",
+  "resource": "rental_applications",
+  "name": "Create Rental Application Note",
+  "method": "POST",
+  "path": "/rental_applications/{RentalApplicationId}/notes",
+  "description": "Add 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"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Note object",
+    "attributes": [
+      {
+        "name": "Body",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message about the rental applications note. A rental applications note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the rental applications note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This rental application has been submitted on 11/11/2023\"\n}"
+}

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

@@ -0,0 +1,62 @@
+{
+  "operationId": "post_showings",
+  "resource": "showings",
+  "name": "Create Showings",
+  "method": "POST",
+  "path": "/showings",
+  "description": "Create a showing",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Showing object",
+    "attributes": [
+      {
+        "name": "LeadId",
+        "type": "string <uuid>",
+        "required": true,
+        "description": "Unique identifier of the lead associated with the showing. Reference the Leads endpoint for any necessary associations."
+      },
+      {
+        "name": "UnitId",
+        "type": "string <uuid>",
+        "required": true,
+        "description": "Unique identifier of the unit that the interested party will be shown. Reference the Units endpoint for any necessary associations."
+      },
+      {
+        "name": "StartAt",
+        "type": "string <date-time>",
+        "required": true,
+        "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": true,
+        "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": "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": "Notes",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message about the showing"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the created showing"
+    }
+  ],
+  "requestSample": "{\n  \"AssignedUserId\": \"80c5cb28-547f-11ec-bfa5-02975b268737\",\n  \"EndAt\": \"2022-02-08T18:45:00Z\",\n  \"LeadId\": \"71c5cb28-547f-11ec-bfa5-02975b268737\",\n  \"Notes\": \"Prospect was very excited about the unit.\",\n  \"StartAt\": \"2022-02-08T18:30:00Z\",\n  \"UnitId\": \"91c5cb28-547f-11ec-bfa5-02975b268737\"\n}"
+}

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

@@ -0,0 +1,161 @@
+{
+  "operationId": "post_tenants_bulk",
+  "resource": "tenants",
+  "name": "Bulk Create Tenants",
+  "method": "POST",
+  "path": "/tenants/bulk",
+  "description": "Create 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 create",
+        "attributes": [
+          {
+            "name": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual tenant in the bulk-creation of tenants."
+          },
+          {
+            "name": "MoveInOn",
+            "type": "string <date>",
+            "required": true,
+            "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": "UnitId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "The unit the tenant occupies."
+          },
+          {
+            "name": "FirstName",
+            "type": "string",
+            "required": false,
+            "description": "The tenant's first name. Required if IsCompany is false or not provided."
+          },
+          {
+            "name": "LastName",
+            "type": "string",
+            "required": false,
+            "description": "The tenant's last name. Required if IsCompany is false or not provided."
+          },
+          {
+            "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. Required if IsCompany is true."
+          },
+          {
+            "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 is required. When false, FirstName and LastName are required."
+          },
+          {
+            "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)"
+          },
+          {
+            "name": "PhoneNumbers",
+            "type": "array",
+            "required": false,
+            "description": "The tenant's phone number(s)"
+          },
+          {
+            "name": "Pets",
+            "type": "array",
+            "required": false,
+            "description": "Contains details about the tenant's pet(s)"
+          },
+          {
+            "name": "Vehicles",
+            "type": "array",
+            "required": false,
+            "description": "Contains details about the tenant's vehicle(s)"
+          },
+          {
+            "name": "Emails",
+            "type": "array",
+            "required": false,
+            "description": "The tenant's email address(es)"
+          },
+          {
+            "name": "Tags",
+            "type": "Array of strings",
+            "required": false,
+            "description": "User-defined tag(s) that categorize the tenant"
+          },
+          {
+            "name": "NextRentIncrease",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date of the tenant is eligible for a rent increase"
+          },
+          {
+            "name": "LeaseStartDate",
+            "type": "string <date>",
+            "required": false,
+            "description": "The day the lease agreement starts"
+          },
+          {
+            "name": "LeaseEndDate",
+            "type": "string <date>",
+            "required": false,
+            "description": "The last day of the lease agreement"
+          },
+          {
+            "name": "LastLeaseRenewal",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date the last lease renewal agreement was started"
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "JobId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the bulk create job"
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {},\n    {},\n    {},\n    {},\n    {}\n  ]\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_tenants_tenantid_notes",
+  "resource": "tenants",
+  "name": "Create Tenant Note",
+  "method": "POST",
+  "path": "/tenants/{TenantId}/notes",
+  "description": "Add 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"
+    }
+  ],
+  "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 tenant note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This tenant have scheduled a cleaning service on 11/11/2023\"\n}"
+}

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

@@ -0,0 +1,138 @@
+{
+  "operationId": "post_unit_types_bulk",
+  "resource": "unit_types",
+  "name": "Bulk Create Unit Types",
+  "method": "POST",
+  "path": "/unit_types/bulk",
+  "description": "Create unit types in bulk.",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Unit Type objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of unit type objects to create in bulk.",
+        "attributes": [
+          {
+            "name": "Name",
+            "type": "string",
+            "required": true,
+            "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": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual unit types in the bulk-creation of unit types."
+          },
+          {
+            "name": "PropertyId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier of the property associated with the unit type."
+          },
+          {
+            "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.00 and $200.00."
+          },
+          {
+            "name": "Amenities",
+            "type": "Array of strings",
+            "required": false,
+            "description": "The amenities associated with the unit type. Amenity names are case-sensitive."
+          },
+          {
+            "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": "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": "JobId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier for the bulk creation job."
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {}\n  ]\n}"
+}

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

@@ -0,0 +1,236 @@
+{
+  "operationId": "post_units_bulk",
+  "resource": "units",
+  "name": "Bulk Create Units",
+  "method": "POST",
+  "path": "/units/bulk",
+  "description": "Create units in bulk",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Unit objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of unit objects to create",
+        "attributes": [
+          {
+            "name": "Name",
+            "type": "string",
+            "required": true,
+            "description": "The unit name as displayed in the AppFolio Property Manager"
+          },
+          {
+            "name": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual units in the bulk-creation of units."
+          },
+          {
+            "name": "PropertyId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier of the property associated with the unit"
+          },
+          {
+            "name": "Address1",
+            "type": "string",
+            "required": true,
+            "description": "The primary street address of the unit"
+          },
+          {
+            "name": "City",
+            "type": "string",
+            "required": true,
+            "description": "The city where the unit is located"
+          },
+          {
+            "name": "State",
+            "type": "string",
+            "required": true,
+            "description": "The state where the unit is located"
+          },
+          {
+            "name": "Zip",
+            "type": "string",
+            "required": true,
+            "description": "The zip code where the unit is located"
+          },
+          {
+            "name": "UnitTypeId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "When present, the unit type can dictate fields like bedrooms, bathrooms, sq. feet, etc. Attempting to create a Unit with values that conflict with the Unit Type will cause an error."
+          },
+          {
+            "name": "Bathrooms",
+            "type": "number",
+            "required": false,
+            "description": "The number of desired bathrooms"
+          },
+          {
+            "name": "Bedrooms",
+            "type": "integer",
+            "required": false,
+            "description": "The number of desired bedrooms"
+          },
+          {
+            "name": "SquareFeet",
+            "type": "number",
+            "required": false,
+            "description": "The size of the unit in square feet"
+          },
+          {
+            "name": "Description",
+            "type": "string",
+            "required": false,
+            "description": "A brief, informative description of the unit"
+          },
+          {
+            "name": "ListedMarketRent",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The rent per month as listed on the market",
+            "deprecated": true
+          },
+          {
+            "name": "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 AppFolio Property Manager.",
+            "deprecated": true
+          },
+          {
+            "name": "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. It does not include advertised adjustments or amenity fees."
+          },
+          {
+            "name": "AdvertiseUsingListedMarketRent",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not to use the listed market rent as the advertised rent. Defaults to true if no value is provided or null is passed in."
+          },
+          {
+            "name": "CatsAllowed",
+            "type": "string",
+            "required": false,
+            "description": "The unit's cat policy. Enum: \"Yes\" \"No\" or null",
+            "enum": ["Yes", "No"]
+          },
+          {
+            "name": "DogsAllowed",
+            "type": "string",
+            "required": false,
+            "description": "The unit's dog policy. Enum: \"Large & Small\" \"Small Only\" \"No\" or null",
+            "enum": ["Large & Small", "Small Only", "No"]
+          },
+          {
+            "name": "Address2",
+            "type": "string",
+            "required": false,
+            "description": "Additional street address information pertaining to the unit"
+          },
+          {
+            "name": "MaintenanceNotes",
+            "type": "string",
+            "required": false,
+            "description": "A brief informative message about the unit's maintenance"
+          },
+          {
+            "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": "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": "Deposit",
+            "type": "number",
+            "required": false,
+            "description": "The security deposit amount"
+          },
+          {
+            "name": "ApplicationFee",
+            "type": "number",
+            "required": false,
+            "description": "The application fee amount"
+          },
+          {
+            "name": "RentReady",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the unit is ready to be occupied by a tenant"
+          },
+          {
+            "name": "Amenities",
+            "type": "Array of strings",
+            "required": false,
+            "description": "The amenities associated with the unit. Amenity names are case-sensitive. Cannot be specified when a Unit Type that defines amenities is assigned."
+          },
+          {
+            "name": "Tags",
+            "type": "Array of strings",
+            "required": false,
+            "description": "User-defined tag(s) that categorize the unit"
+          },
+          {
+            "name": "LastInspectedDate",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date the unit was last inspected"
+          },
+          {
+            "name": "YouTubeURL",
+            "type": "string <uri>",
+            "required": false,
+            "description": "The URL of the YouTube video for the listing(s)"
+          },
+          {
+            "name": "AvailableOn",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date upon which the unit can be leased. The date must be within three years of today's date"
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of created unit status objects"
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string",
+      "required": false,
+      "description": "Unique identifier of the created unit"
+    },
+    {
+      "name": "data[].ReferenceId",
+      "type": "string",
+      "required": false,
+      "description": "Transient unique ID assigned by the developer. Used to reference individual units in the bulk-creation of units."
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {}\n  ]\n}"
+}