@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,258 @@
+{
+  "operationId": "get_owners",
+  "resource": "owners",
+  "name": "List All Owners",
+  "method": "GET",
+  "path": "/owners",
+  "description": "Returns all owners that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters",
+      "type": "object",
+      "required": true,
+      "description": "Filters for owners. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "page",
+      "type": "object",
+      "required": false,
+      "description": "Optional pagination parameters. Default: page[number]=1&page[size]=1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of owner objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string",
+      "required": false,
+      "description": "Unique identifier of an owner within an owner group"
+    },
+    {
+      "name": "data[].CompanyName",
+      "type": "string",
+      "required": false,
+      "description": "The company name associated with the owner"
+    },
+    {
+      "name": "data[].CustomFields",
+      "type": "object",
+      "required": false,
+      "description": "The custom fields for the associated entity"
+    },
+    {
+      "name": "data[].Email",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The primary email address of the owner"
+    },
+    {
+      "name": "data[].Emails",
+      "type": "array",
+      "required": false,
+      "description": "The owner's emails"
+    },
+    {
+      "name": "data[].EmailEcheckReceipt",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not to send a notification to the payee after an eCheck payment is made."
+    },
+    {
+      "name": "data[].HoldPayments",
+      "type": "boolean",
+      "required": false,
+      "description": "When true, bills created for the owner through the Pay Owner or Owner Draw function will not be available in the Pay Bills flow."
+    },
+    {
+      "name": "data[].FirstName",
+      "type": "string",
+      "required": false,
+      "description": "The first name of the owner"
+    },
+    {
+      "name": "data[].HiddenAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "When the owner was marked inactive by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].IsCompany",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the owner identifies as a company"
+    },
+    {
+      "name": "data[].LastName",
+      "type": "string",
+      "required": false,
+      "description": "The last name of the owner"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the owner was last updated"
+    },
+    {
+      "name": "data[].Link",
+      "type": "string <uri>",
+      "required": false,
+      "description": "A link to the owner's page in the AppFolio Property Manager"
+    },
+    {
+      "name": "data[].MaintenanceNotes",
+      "type": "string",
+      "required": false,
+      "description": "Maintenance notes for the properties owned"
+    },
+    {
+      "name": "data[].PhoneNumber",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The owner's primary phone number"
+    },
+    {
+      "name": "data[].PhoneNumbers",
+      "type": "array",
+      "required": false,
+      "description": "The owner's phone number(s)"
+    },
+    {
+      "name": "data[].Address1",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The primary street address of the owner"
+    },
+    {
+      "name": "data[].Address2",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "Additional street address information pertaining to the owner"
+    },
+    {
+      "name": "data[].City",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The city where the owner is located"
+    },
+    {
+      "name": "data[].State",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The state where the owner is located"
+    },
+    {
+      "name": "data[].Zip",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The zip code where the owner is located"
+    },
+    {
+      "name": "data[].CountryCode",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The country code of the owner (e.g. US for United states)"
+    },
+    {
+      "name": "data[].Tags",
+      "type": "Array of strings",
+      "required": false,
+      "description": "User-defined tag(s) that categorize the owner"
+    },
+    {
+      "name": "data[].UseAlternatePayee",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the owner payments are submitted to an alternate person other than what is listed for Owner First, Last and/or Company Name"
+    },
+    {
+      "name": "data[].AlternatePayeeName",
+      "type": "string",
+      "required": false,
+      "description": "The name of the alternate payee"
+    },
+    {
+      "name": "data[].AlternatePaymentAddress1",
+      "type": "string",
+      "required": false,
+      "description": "The street address of the Alternate Payee"
+    },
+    {
+      "name": "data[].AlternatePaymentAddress2",
+      "type": "string",
+      "required": false,
+      "description": "Additional street address information pertaining to the alternate payee"
+    },
+    {
+      "name": "data[].AlternatePaymentCity",
+      "type": "string",
+      "required": false,
+      "description": "The city where the alternate payee is located"
+    },
+    {
+      "name": "data[].AlternatePaymentState",
+      "type": "string",
+      "required": false,
+      "description": "The state where the alternate payee is located"
+    },
+    {
+      "name": "data[].AlternatePaymentPostalCode",
+      "type": "string",
+      "required": false,
+      "description": "The zip code where the alternate payee is located"
+    },
+    {
+      "name": "data[].AlternatePaymentCountryCode",
+      "type": "string",
+      "required": false,
+      "description": "The country code of the alternate payee (e.g. US for United states)"
+    },
+    {
+      "name": "data[].Addresses",
+      "type": "array",
+      "required": false,
+      "description": "The owner's address(es)"
+    },
+    {
+      "name": "data[].Send1099",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether a 1099 form is sent to the owner."
+    },
+    {
+      "name": "data[].OwnerConsentedToReceiveElectronic1099",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the owner has consented to receive the 1099 tax form electronically. If Send1099 is false, this value will also be false."
+    },
+    {
+      "name": "data[].Sending1099Preference",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the owner's 1099 sending preference. Valid values include \"Paper\", \"Electronic\", \"PaperAndElectronic\", or \"null\". If Send1099 is false, this value will be null."
+    },
+    {
+      "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/owners?page[size]=100&page[number]=1&filters[PropertyId]=bfcb95e8-d5fb-448c-b811-88d9f832e79c' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

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

@@ -0,0 +1,82 @@
+{
+  "operationId": "get_owners_attachments",
+  "resource": "owners",
+  "name": "List All Owner Attachments",
+  "method": "GET",
+  "path": "/owners/attachments",
+  "description": "Returns all attachments associated with an owner",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "page",
+      "type": "object",
+      "required": false,
+      "description": "Optional pagination parameters. Default: page[number]=1&page[size]=1000."
+    },
+    {
+      "name": "filters[OwnerId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by owner ID. All GET requests must include a filter for [OwnerId], or [CreatedAtFrom]."
+    },
+    {
+      "name": "filters[CreatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter attachments created at or after this date/time. All GET requests must include a filter for [OwnerId], or [CreatedAtFrom]."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of owner 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 owner 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 owner attachment was created by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data[].EntityId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the owner 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/owners/attachments?page[size]=10&page[number]=2&filters[OwnerId]=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_owners_notes.json

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

@@ -0,0 +1,247 @@
+{
+  "operationId": "get_owners_ownerid",
+  "resource": "owners",
+  "name": "Fetch an Owner by ID",
+  "method": "GET",
+  "path": "/owners/{ownerId}",
+  "description": "Returns the owner",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "ownerId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the owner to fetch. Filter the results based on a single value."
+    }
+  ],
+  "queryFilters": [],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "object",
+      "required": false,
+      "description": "Owner object"
+    },
+    {
+      "name": "data.Id",
+      "type": "string",
+      "required": false,
+      "description": "Unique identifier of an owner within an owner group"
+    },
+    {
+      "name": "data.CompanyName",
+      "type": "string",
+      "required": false,
+      "description": "The company name associated with the owner"
+    },
+    {
+      "name": "data.CustomFields",
+      "type": "object",
+      "required": false,
+      "description": "The custom fields for the associated entity"
+    },
+    {
+      "name": "data.Email",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The primary email address of the owner"
+    },
+    {
+      "name": "data.Emails",
+      "type": "array",
+      "required": false,
+      "description": "The owner's emails"
+    },
+    {
+      "name": "data.EmailEcheckReceipt",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not to send a notification to the payee after an eCheck payment is made."
+    },
+    {
+      "name": "data.HoldPayments",
+      "type": "boolean",
+      "required": false,
+      "description": "When true, bills created for the owner through the Pay Owner or Owner Draw function will not be available in the Pay Bills flow."
+    },
+    {
+      "name": "data.FirstName",
+      "type": "string",
+      "required": false,
+      "description": "The first name of the owner"
+    },
+    {
+      "name": "data.HiddenAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "When the owner was marked inactive by an AppFolio Property Manager user"
+    },
+    {
+      "name": "data.IsCompany",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the owner identifies as a company"
+    },
+    {
+      "name": "data.LastName",
+      "type": "string",
+      "required": false,
+      "description": "The last name of the owner"
+    },
+    {
+      "name": "data.LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the owner was last updated"
+    },
+    {
+      "name": "data.Link",
+      "type": "string <uri>",
+      "required": false,
+      "description": "A link to the owner's page in the AppFolio Property Manager"
+    },
+    {
+      "name": "data.MaintenanceNotes",
+      "type": "string",
+      "required": false,
+      "description": "Maintenance notes for the properties owned"
+    },
+    {
+      "name": "data.PhoneNumber",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The owner's primary phone number"
+    },
+    {
+      "name": "data.PhoneNumbers",
+      "type": "array",
+      "required": false,
+      "description": "The owner's phone number(s)"
+    },
+    {
+      "name": "data.Address1",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The primary street address of the owner"
+    },
+    {
+      "name": "data.Address2",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "Additional street address information pertaining to the owner"
+    },
+    {
+      "name": "data.City",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The city where the owner is located"
+    },
+    {
+      "name": "data.State",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The state where the owner is located"
+    },
+    {
+      "name": "data.Zip",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The zip code where the owner is located"
+    },
+    {
+      "name": "data.CountryCode",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The country code of the owner (e.g. US for United states)"
+    },
+    {
+      "name": "data.Tags",
+      "type": "Array of strings",
+      "required": false,
+      "description": "User-defined tag(s) that categorize the owner"
+    },
+    {
+      "name": "data.UseAlternatePayee",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the owner payments are submitted to an alternate person other than what is listed for Owner First, Last and/or Company Name"
+    },
+    {
+      "name": "data.AlternatePayeeName",
+      "type": "string",
+      "required": false,
+      "description": "The name of the alternate payee"
+    },
+    {
+      "name": "data.AlternatePaymentAddress1",
+      "type": "string",
+      "required": false,
+      "description": "The street address of the Alternate Payee"
+    },
+    {
+      "name": "data.AlternatePaymentAddress2",
+      "type": "string",
+      "required": false,
+      "description": "Additional street address information pertaining to the alternate payee"
+    },
+    {
+      "name": "data.AlternatePaymentCity",
+      "type": "string",
+      "required": false,
+      "description": "The city where the alternate payee is located"
+    },
+    {
+      "name": "data.AlternatePaymentState",
+      "type": "string",
+      "required": false,
+      "description": "The state where the alternate payee is located"
+    },
+    {
+      "name": "data.AlternatePaymentPostalCode",
+      "type": "string",
+      "required": false,
+      "description": "The zip code where the alternate payee is located"
+    },
+    {
+      "name": "data.AlternatePaymentCountryCode",
+      "type": "string",
+      "required": false,
+      "description": "The country code of the alternate payee (e.g. US for United states)"
+    },
+    {
+      "name": "data.Addresses",
+      "type": "array",
+      "required": false,
+      "description": "The owner's address(es)"
+    },
+    {
+      "name": "data.Send1099",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether a 1099 form is sent to the owner."
+    },
+    {
+      "name": "data.OwnerConsentedToReceiveElectronic1099",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the owner has consented to receive the 1099 tax form electronically. If Send1099 is false, this value will also be false."
+    },
+    {
+      "name": "data.Sending1099Preference",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the owner's 1099 sending preference. Valid values include \"Paper\", \"Electronic\", \"PaperAndElectronic\", or \"null\". If Send1099 is false, this value will be null."
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/owners/1abcde23-c543-456e-abc9-123456789cba' \\\n     --header 'Authorization: Basic {Auth}'"
+}