{"items":[{"type":"link","label":"Aryeo","link":"/api/aryeo","routeSlug":"/api/aryeo","content":{"contentType":"overview","meta":{"name":"Aryeo"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.aryeo.com","url":"https://www.aryeo.com"},{"kind":"email","title":"Admin","email":"jarrodp@zillowgroup.com","label":"jarrodp@zillowgroup.com","withCopyButton":true,"copyContent":"jarrodp@zillowgroup.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://choosealicense.com/licenses/apache-2.0/"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://www.aryeo.com/legal/terms-of-service"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"js","title":"JS","lang":"JavaScript"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"curl","title":"cURL","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Aryeo (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/api/aryeo"}],"sectionId":"/api/aryeo"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Aryeo API provides access to the Aryeo platform."},"children":[]}]}]}]}],"sectionId":"/api/aryeo/section/introduction"}]}]}},{"type":"link","label":"Introduction","link":"/api/aryeo/section/introduction","routeSlug":"/api/aryeo/section/introduction","content":null},{"type":"group","label":"Addresses","link":"/api/aryeo/addresses","routeSlug":"/api/aryeo/addresses","items":[{"label":"Create address.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/addresses/post-addresses","routeSlug":"/api/aryeo/addresses/post-addresses","metadata":{"seo":{"title":"Create address.","description":"Create address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-addresses","name":"Create address.","isWebhook":false,"pointer":"/paths/~1addresses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create address.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create address."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressPostPayload"}},"schemaId":"components/schemas/AddressPostPayload","pointer":"/paths/~1addresses/post/requestBody","description":"AddressPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addresses","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AddressPostPayload"}},"responseCodes":["201","403","404","422","500"],"pointer":"/addresses","href":"addresses/post-addresses","openApiOperationId":"post-addresses","summary":"Create address."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AddressPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"AddressResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressResource"}},"schemaId":"components/schemas/AddressResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1addresses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AddressResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/addresses/post-addresses"}],"panels":[]}]},"httpPath":"/addresses"},{"label":"Get address.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/addresses/addresses-address-get","routeSlug":"/api/aryeo/addresses/addresses-address-get","metadata":{"seo":{"title":"Get address.","description":"Get address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addresses-address-get","name":"Get address.","isWebhook":false,"pointer":"/paths/~1addresses~1{address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get address.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get address."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address","in":"path","schemaId":"schema_80","description":"The ID of an address. UUID Version 4.","required":true}],"pointer":"/paths/~1addresses~1{address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addresses/{address}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"address","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404","422","500"],"pointer":"/addresses/{address}","href":"addresses/addresses-address-get","openApiOperationId":"addresses-address-get","summary":"Get address."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AddressResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressResource"}},"schemaId":"components/schemas/AddressResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1addresses~1{address}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/addresses/addresses-address-get"}],"panels":[]}]},"httpPath":"/addresses/{address}"},{"label":"Update address.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/addresses/addresses-address-patch","routeSlug":"/api/aryeo/addresses/addresses-address-patch","metadata":{"seo":{"title":"Update address.","description":"Update address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addresses-address-patch","name":"Update address.","isWebhook":false,"pointer":"/paths/~1addresses~1{address}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update address.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update address."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address","in":"path","schemaId":"schema_80","description":"The ID of an address. UUID Version 4.","required":true}],"pointer":"/paths/~1addresses~1{address}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressPatchPayload"}},"schemaId":"components/schemas/AddressPatchPayload","pointer":"/paths/~1addresses~1{address}/patch/requestBody","description":"AddressPatchPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/addresses/{address}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"address","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AddressPatchPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/addresses/{address}","href":"addresses/addresses-address-patch","openApiOperationId":"addresses-address-patch","summary":"Update address."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AddressPatchPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressPatchPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AddressResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressResource"}},"schemaId":"components/schemas/AddressResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1addresses~1{address}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/addresses/addresses-address-patch"}],"panels":[]}]},"httpPath":"/addresses/{address}"}],"content":{"contentType":"group","meta":{"name":"Addresses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Addresses","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to addresses. Addresses provide standardized address data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/addresses","summary":"Create address.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/addresses/post-addresses","deprecated":false},{"title":"/addresses/{address}","summary":"Get address.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/addresses/addresses-address-get","deprecated":false},{"title":"/addresses/{address}","summary":"Update address.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/addresses/addresses-address-patch","deprecated":false}]}]}]}]}},{"type":"group","label":"Appointments","link":"/api/aryeo/appointments","routeSlug":"/api/aryeo/appointments","items":[{"label":"List appointments.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/get-appointments","routeSlug":"/api/aryeo/appointments/get-appointments","metadata":{"seo":{"title":"List appointments.","description":"List appointments. By default, returns a list of appointments that have been scheduled and have not been canceled"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-appointments","name":"List appointments.","isWebhook":false,"pointer":"/paths/~1appointments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List appointments.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List appointments. By default, returns a list of appointments that have been scheduled and have not been canceled"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_81","description":"Comma separated list of optional data to include in the response."},{"name":"filter[tense]","in":"query","schemaId":"schema_82","description":"Return appointments that are upcoming or in the past."},{"name":"filter[statuses][]","in":"query","schemaId":"schema_83","description":"Filters appointment by status, defaults to SCHEDULED."},{"name":"filter[start_at_gte]","in":"query","schemaId":"schema_84","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return appointments where the start_at field is greater than or equal to this value. Effectively, appointments that start after this date."},"children":[]}]}]}]},{"name":"filter[start_at_lte]","in":"query","schemaId":"schema_85","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return appointments where the start_at field is less than or equal to this value. Effectively, appointments that start before this date."},"children":[]}]}]}]},{"name":"filter[user_ids][]","in":"query","schemaId":"schema_86","description":"The IDs of users whose appointments will be listed. UUID Version 4."},{"name":"sort","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-start_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_88","description":"The number of items per page. Defaults to 25."},{"name":"page","in":"query","schemaId":"schema_89","description":"The requested page. Defaults to 1."}],"pointer":"/paths/~1appointments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appointments","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"owner,items,users,order,order.address,order.customer,order.customerGroup,order.listing,order.items,order.items.appointment","schemaId":"schema_81"},{"name":"filter[tense]","in":"query","example":"UPCOMING","schemaId":"schema_82"},{"name":"filter[statuses][]","in":"query","schemaId":"schema_83"},{"name":"filter[start_at_gte]","in":"query","example":"2021-01-01T13:00:00Z","schemaId":"schema_84"},{"name":"filter[start_at_lte]","in":"query","example":"2021-01-02T13:00:00Z","schemaId":"schema_85"},{"name":"filter[user_ids][]","in":"query","schemaId":"schema_86"},{"name":"sort","in":"query","example":"-created_at","schemaId":"schema_87"},{"name":"per_page","in":"query","example":"25","schemaId":"schema_88"},{"name":"page","in":"query","example":"2","schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/appointments","href":"appointments/get-appointments","openApiOperationId":"get-appointments","summary":"List appointments."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentCollection"}},"schemaId":"components/schemas/AppointmentCollection"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentCollection"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/get-appointments"}],"panels":[]}]},"httpPath":"/appointments"},{"label":"Get appointment.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/get-appointments-id","routeSlug":"/api/aryeo/appointments/get-appointments-id","metadata":{"seo":{"title":"Get appointment.","description":"Get appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-appointments-id","name":"Get appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_90","description":"Comma separated list of optional data to include in the response."}],"pointer":"/paths/~1appointments~1{appointment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appointments/{appointment_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"include","in":"query","example":"owner,items,users,order,order.address,order.customer,order.customerGroup, order.listing,order.items,.order.items.appointment","schemaId":"schema_90"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/appointments/{appointment_id}","href":"appointments/get-appointments-id","openApiOperationId":"get-appointments-id","summary":"Get appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/get-appointments-id"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}"},{"label":"Update appointment.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/put-appointments-appointment_id","routeSlug":"/api/aryeo/appointments/put-appointments-appointment_id","metadata":{"seo":{"title":"Update appointment.","description":"Update appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-appointments-appointment_id","name":"Update appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentUpdatePutPayload"}},"schemaId":"components/schemas/AppointmentUpdatePutPayload","pointer":"/paths/~1appointments~1{appointment_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentUpdatePutPayload"}},"responseCodes":["200","403","404","422","500"],"pointer":"/appointments/{appointment_id}","href":"appointments/put-appointments-appointment_id","openApiOperationId":"put-appointments-appointment_id","summary":"Update appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentUpdatePutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentUpdatePutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/put-appointments-appointment_id"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}"},{"label":"Cancel appointment.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/put-appointments-appointment-id-cancel","routeSlug":"/api/aryeo/appointments/put-appointments-appointment-id-cancel","metadata":{"seo":{"title":"Cancel appointment.","description":"Cancel appointment. The appointments order's customer can be optionally notified of this change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-appointments-appointment-id-cancel","name":"Cancel appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel appointment. The appointments order's customer can be optionally notified of this change."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentCancelPutPayload"}},"schemaId":"components/schemas/AppointmentCancelPutPayload","pointer":"/paths/~1appointments~1{appointment_id}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}/cancel","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentCancelPutPayload"}},"responseCodes":["200","403","404","409","422","500"],"pointer":"/appointments/{appointment_id}/cancel","href":"appointments/put-appointments-appointment-id-cancel","openApiOperationId":"put-appointments-appointment-id-cancel","summary":"Cancel appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentCancelPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentCancelPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"409","description":"ApiError409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}},"schemaId":"components/schemas/ApiError409"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"409","schemaId":"components/schemas/ApiError409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/put-appointments-appointment-id-cancel"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/cancel"},{"label":"Postpone appointment.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-appointment-id-postpone-put","routeSlug":"/api/aryeo/appointments/appointments-appointment-id-postpone-put","metadata":{"seo":{"title":"Postpone appointment.","description":"Postpone appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-appointment-id-postpone-put","name":"Postpone appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1postpone/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Postpone appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Postpone appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1postpone/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentPostponePutPayload"}},"schemaId":"components/schemas/AppointmentPostponePutPayload","pointer":"/paths/~1appointments~1{appointment_id}~1postpone/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}/postpone","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentPostponePutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/appointments/{appointment_id}/postpone","href":"appointments/appointments-appointment-id-postpone-put","openApiOperationId":"appointments-appointment-id-postpone-put","summary":"Postpone appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentPostponePutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentPostponePutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~1postpone/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-appointment-id-postpone-put"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/postpone"},{"label":"Reschedule appointment.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/put-appointments-appointment-id-reschedule","routeSlug":"/api/aryeo/appointments/put-appointments-appointment-id-reschedule","metadata":{"seo":{"title":"Reschedule appointment.","description":"Reschedule appointment. The appointments order's customer can be optionally notified of this change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-appointments-appointment-id-reschedule","name":"Reschedule appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1reschedule/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reschedule appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reschedule appointment. The appointments order's customer can be optionally notified of this change."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1reschedule/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentReschedulePutPayload"}},"schemaId":"components/schemas/AppointmentReschedulePutPayload","pointer":"/paths/~1appointments~1{appointment_id}~1reschedule/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}/reschedule","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentReschedulePutPayload"}},"responseCodes":["200","403","404","409","422","500"],"pointer":"/appointments/{appointment_id}/reschedule","href":"appointments/put-appointments-appointment-id-reschedule","openApiOperationId":"put-appointments-appointment-id-reschedule","summary":"Reschedule appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentReschedulePutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentReschedulePutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"409","description":"ApiError409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}},"schemaId":"components/schemas/ApiError409"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~1reschedule/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"409","schemaId":"components/schemas/ApiError409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/put-appointments-appointment-id-reschedule"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/reschedule"},{"label":"Accept appointment.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-appointment-id-accept-put","routeSlug":"/api/aryeo/appointments/appointments-appointment-id-accept-put","metadata":{"seo":{"title":"Accept appointment.","description":"Accept appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-appointment-id-accept-put","name":"Accept appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1accept/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accept appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1accept/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentAcceptPutPayload"}},"schemaId":"components/schemas/AppointmentAcceptPutPayload","pointer":"/paths/~1appointments~1{appointment_id}~1accept/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}/accept","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentAcceptPutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/appointments/{appointment_id}/accept","href":"appointments/appointments-appointment-id-accept-put","openApiOperationId":"appointments-appointment-id-accept-put","summary":"Accept appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentAcceptPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentAcceptPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~1accept/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-appointment-id-accept-put"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/accept"},{"label":"Decline appointment.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-appointment-id-decline-put","routeSlug":"/api/aryeo/appointments/appointments-appointment-id-decline-put","metadata":{"seo":{"title":"Decline appointment.","description":"Decline appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-appointment-id-decline-put","name":"Decline appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1decline/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decline appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Decline appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1decline/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentDeclinePutPayload"}},"schemaId":"components/schemas/AppointmentDeclinePutPayload","pointer":"/paths/~1appointments~1{appointment_id}~1decline/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}/decline","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentDeclinePutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/appointments/{appointment_id}/decline","href":"appointments/appointments-appointment-id-decline-put","openApiOperationId":"appointments-appointment-id-decline-put","summary":"Decline appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentDeclinePutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentDeclinePutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~1decline/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-appointment-id-decline-put"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/decline"},{"label":"Schedule appointment.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-appointment-id-schedule-put","routeSlug":"/api/aryeo/appointments/appointments-appointment-id-schedule-put","metadata":{"seo":{"title":"Schedule appointment.","description":"Schedule appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-appointment-id-schedule-put","name":"Schedule appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1schedule/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedule appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Schedule appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1schedule/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentSchedulePutPayload"}},"schemaId":"components/schemas/AppointmentSchedulePutPayload","pointer":"/paths/~1appointments~1{appointment_id}~1schedule/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}/schedule","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentSchedulePutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/appointments/{appointment_id}/schedule","href":"appointments/appointments-appointment-id-schedule-put","openApiOperationId":"appointments-appointment-id-schedule-put","summary":"Schedule appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentSchedulePutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentSchedulePutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~1schedule/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-appointment-id-schedule-put"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/schedule"},{"label":"Check appointment availability.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-appointment-id-availability-get","routeSlug":"/api/aryeo/appointments/appointments-appointment-id-availability-get","metadata":{"seo":{"title":"Check appointment availability.","description":"Check appointment availability."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-appointment-id-availability-get","name":"Check appointment availability.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check appointment availability.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Check appointment availability."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1availability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assignee_id","in":"query","schemaId":"schema_80","description":"The ID of a company team member. UUID Version 4.","required":true},{"name":"duration","in":"query","schemaId":"schema_91","description":"The duration of the event to schedule.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appointments/{appointment_id}/availability","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"assignee_id","in":"query","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"},{"name":"duration","in":"query","required":true,"example":60,"schemaId":"schema_91"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/appointments/{appointment_id}/availability","href":"appointments/appointments-appointment-id-availability-get","openApiOperationId":"appointments-appointment-id-availability-get","summary":"Check appointment availability."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AvailabilityResponse","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailabilityResponse"}},"schemaId":"components/schemas/AvailabilityResponse"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AvailabilityResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailabilityResponse"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-appointment-id-availability-get"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/availability"},{"label":"Get appointment 3D Home Capture link.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-appointment-id-3dh-tour-link-get","routeSlug":"/api/aryeo/appointments/appointments-appointment-id-3dh-tour-link-get","metadata":{"seo":{"title":"Get appointment 3D Home Capture link.","description":"Get appointment 3D Home Capture link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-appointment-id-3dh-tour-link-get","name":"Get appointment 3D Home Capture link.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~13dh-tour-link/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get appointment 3D Home Capture link.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get appointment 3D Home Capture link."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~13dh-tour-link/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appointments/{appointment_id}/3dh-tour-link","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/appointments/{appointment_id}/3dh-tour-link","href":"appointments/appointments-appointment-id-3dh-tour-link-get","openApiOperationId":"appointments-appointment-id-3dh-tour-link-get","summary":"Get appointment 3D Home Capture link."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Appointment3dhTourLinkResponse","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appointment3dhTourLinkResponse"}},"schemaId":"components/schemas/Appointment3dhTourLinkResponse"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~13dh-tour-link/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Appointment3dhTourLinkResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appointment3dhTourLinkResponse"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-appointment-id-3dh-tour-link-get"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/3dh-tour-link"},{"label":"Update appointment items.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-appointment-id-items-put","routeSlug":"/api/aryeo/appointments/appointments-appointment-id-items-put","metadata":{"seo":{"title":"Update appointment items.","description":"Sync the items attached to an appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-appointment-id-items-put","name":"Update appointment items.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1items/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update appointment items.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":true,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sync the items attached to an appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment. UUID Version 4.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1items/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentItemsPutPayload"}},"schemaId":"components/schemas/AppointmentItemsPutPayload","pointer":"/paths/~1appointments~1{appointment_id}~1items/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}/items","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentItemsPutPayload"}},"responseCodes":["200","403","404","422","500"],"pointer":"/appointments/{appointment_id}/items","href":"appointments/appointments-appointment-id-items-put","openApiOperationId":"appointments-appointment-id-items-put","summary":"Update appointment items."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentItemsPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentItemsPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1{appointment_id}~1items/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-appointment-id-items-put"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/items"},{"label":"Create appointment.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-store-post","routeSlug":"/api/aryeo/appointments/appointments-store-post","metadata":{"seo":{"title":"Create appointment.","description":"Create appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-store-post","name":"Create appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1store/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentStorePostPayload"}},"schemaId":"components/schemas/AppointmentStorePostPayload","pointer":"/paths/~1appointments~1store/post/requestBody","description":"AppointmentStorePostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appointments/store","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppointmentStorePostPayload"}},"responseCodes":["200","422","500"],"pointer":"/appointments/store","href":"appointments/appointments-store-post","openApiOperationId":"appointments-store-post","summary":"Create appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/AppointmentStorePostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppointmentStorePostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1appointments~1store/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-store-post"}],"panels":[]}]},"httpPath":"/appointments/store"},{"label":"Create a draft appointment.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-store-draft-post","routeSlug":"/api/aryeo/appointments/appointments-store-draft-post","metadata":{"seo":{"title":"Create a draft appointment.","description":"Create a draft appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-store-draft-post","name":"Create a draft appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1store-draft/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a draft appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":true,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a draft appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appointments/store-draft","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/appointments/store-draft","href":"appointments/appointments-store-draft-post","openApiOperationId":"appointments-store-draft-post","summary":"Create a draft appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"}],"pointer":"/paths/~1appointments~1store-draft/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-store-draft-post"}],"panels":[]}]},"httpPath":"/appointments/store-draft"},{"label":"Create multiple draft appointments.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/appointments-store-drafts-post","routeSlug":"/api/aryeo/appointments/appointments-store-drafts-post","metadata":{"seo":{"title":"Create multiple draft appointments.","description":"Create multiple draft appointments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"appointments-store-drafts-post","name":"Create multiple draft appointments.","isWebhook":false,"pointer":"/paths/~1appointments~1store-drafts/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create multiple draft appointments.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":true,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create multiple draft appointments."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appointments/store-drafts","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/appointments/store-drafts","href":"appointments/appointments-store-drafts-post","openApiOperationId":"appointments-store-drafts-post","summary":"Create multiple draft appointments."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentCollection"}},"schemaId":"components/schemas/AppointmentCollection"}],"pointer":"/paths/~1appointments~1store-drafts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/appointments-store-drafts-post"}],"panels":[]}]},"httpPath":"/appointments/store-drafts"},{"label":"Update a draft appointment.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/put-appointments-appointment_id-draft","routeSlug":"/api/aryeo/appointments/put-appointments-appointment_id-draft","metadata":{"seo":{"title":"Update a draft appointment.","description":"Update a draft appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-appointments-appointment_id-draft","name":"Update a draft appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1draft/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a draft appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":true,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a draft appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1draft/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appointments/{appointment_id}/draft","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/appointments/{appointment_id}/draft","href":"appointments/put-appointments-appointment_id-draft","openApiOperationId":"put-appointments-appointment_id-draft","summary":"Update a draft appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AppointmentResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}},"schemaId":"components/schemas/AppointmentResource"}],"pointer":"/paths/~1appointments~1{appointment_id}~1draft/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResource"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/put-appointments-appointment_id-draft"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/draft"},{"label":"Delete a draft appointment.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/appointments/delete-appointments-appointment_id-draft","routeSlug":"/api/aryeo/appointments/delete-appointments-appointment_id-draft","metadata":{"seo":{"title":"Delete a draft appointment.","description":"Delete a draft appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-appointments-appointment_id-draft","name":"Delete a draft appointment.","isWebhook":false,"pointer":"/paths/~1appointments~1{appointment_id}~1draft/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a draft appointment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":true,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a draft appointment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_80","description":"The ID of an appointment.","required":true}],"pointer":"/paths/~1appointments~1{appointment_id}~1draft/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/appointments/{appointment_id}/draft","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/appointments/{appointment_id}/draft","href":"appointments/delete-appointments-appointment_id-draft","openApiOperationId":"delete-appointments-appointment_id-draft","summary":"Delete a draft appointment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"}],"pointer":"/paths/~1appointments~1{appointment_id}~1draft/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/delete-appointments-appointment_id-draft"}],"panels":[]}]},"httpPath":"/appointments/{appointment_id}/draft"}],"content":{"contentType":"group","meta":{"name":"Appointments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appointments","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to appointments. Appointments are bookings for services that can be rescheduled, cancelled, and confirmed."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/appointments","summary":"List appointments.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get-appointments","deprecated":false},{"title":"/appointments/{appointment_id}","summary":"Get appointment.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get-appointments-id","deprecated":false},{"title":"/appointments/{appointment_id}","summary":"Update appointment.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/put-appointments-appointment_id","deprecated":false},{"title":"/appointments/{appointment_id}/cancel","summary":"Cancel appointment.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/put-appointments-appointment-id-cancel","deprecated":false},{"title":"/appointments/{appointment_id}/postpone","summary":"Postpone appointment.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/appointments-appointment-id-postpone-put","deprecated":false},{"title":"/appointments/{appointment_id}/reschedule","summary":"Reschedule appointment.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/put-appointments-appointment-id-reschedule","deprecated":false},{"title":"/appointments/{appointment_id}/accept","summary":"Accept appointment.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/appointments-appointment-id-accept-put","deprecated":false},{"title":"/appointments/{appointment_id}/decline","summary":"Decline appointment.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/appointments-appointment-id-decline-put","deprecated":false},{"title":"/appointments/{appointment_id}/schedule","summary":"Schedule appointment.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/appointments-appointment-id-schedule-put","deprecated":false},{"title":"/appointments/{appointment_id}/availability","summary":"Check appointment availability.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/appointments-appointment-id-availability-get","deprecated":false},{"title":"/appointments/{appointment_id}/3dh-tour-link","summary":"Get appointment 3D Home Capture link.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/appointments-appointment-id-3dh-tour-link-get","deprecated":false},{"title":"/appointments/{appointment_id}/items","summary":"Update appointment items.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/appointments-appointment-id-items-put","deprecated":false},{"title":"/appointments/store","summary":"Create appointment.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/appointments-store-post","deprecated":false},{"title":"/appointments/store-draft","summary":"Create a draft appointment.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/appointments-store-draft-post","deprecated":false},{"title":"/appointments/store-drafts","summary":"Create multiple draft appointments.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/appointments-store-drafts-post","deprecated":false},{"title":"/appointments/{appointment_id}/draft","summary":"Update a draft appointment.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/put-appointments-appointment_id-draft","deprecated":false},{"title":"/appointments/{appointment_id}/draft","summary":"Delete a draft appointment.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appointments/delete-appointments-appointment_id-draft","deprecated":false}]}]}]}]}},{"type":"group","label":"Company Users","link":"/api/aryeo/company-users","routeSlug":"/api/aryeo/company-users","items":[{"label":"List company team members.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/company-users/company-team-members-get","routeSlug":"/api/aryeo/company-users/company-team-members-get","metadata":{"seo":{"title":"List company team members.","description":"List company team members."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company-team-members-get","name":"List company team members.","isWebhook":false,"pointer":"/paths/~1company-team-members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List company team members.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List company team members."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[search]","in":"query","schemaId":"schema_92","description":"Return company team members with a match on the search term."},{"name":"filter[ids]","in":"query","schemaId":"schema_93","description":"Return company team members with a match on the search term."},{"name":"include","in":"query","schemaId":"schema_94","description":"Comma separated list of optional data to include in the response."},{"name":"per_page","in":"query","schemaId":"schema_88","description":"The number of items per page. Defaults to 25."},{"name":"page","in":"query","schemaId":"schema_89","description":"The requested page. Defaults to 1."}],"pointer":"/paths/~1company-team-members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company-team-members","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"filter[search]","in":"query","example":"Brendan","schemaId":"schema_92"},{"name":"filter[ids]","in":"query","example":"00000000-0000-4000-8000-000000000000,00000000-0000-4000-8000-000000000001","schemaId":"schema_93"},{"name":"include","in":"query","example":"company","schemaId":"schema_94"},{"name":"per_page","in":"query","example":"25","schemaId":"schema_88"},{"name":"page","in":"query","example":"2","schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/company-team-members","href":"company-users/company-team-members-get","openApiOperationId":"company-team-members-get","summary":"List company team members."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CompanyTeamMemberCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyTeamMemberCollection"}},"schemaId":"components/schemas/CompanyTeamMemberCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1company-team-members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyTeamMemberCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyTeamMemberCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-users/company-team-members-get"}],"panels":[]}]},"httpPath":"/company-team-members"},{"label":"Get company team member.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/company-users/company-team-members-company-team-member-id-get","routeSlug":"/api/aryeo/company-users/company-team-members-company-team-member-id-get","metadata":{"seo":{"title":"Get company team member.","description":"Get company team member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company-team-members-company-team-member-id-get","name":"Get company team member.","isWebhook":false,"pointer":"/paths/~1company-team-members~1{company_team_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get company team member.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get company team member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_team_member_id","in":"path","schemaId":"schema_80","description":"The ID of a company team member. UUID Version 4.","required":true}],"pointer":"/paths/~1company-team-members~1{company_team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_94","description":"Comma separated list of optional data to include in the response."}],"pointer":"/paths/~1company-team-members~1{company_team_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company-team-members/{company_team_member_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"company_team_member_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"include","in":"query","example":"company","schemaId":"schema_94"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/company-team-members/{company_team_member_id}","href":"company-users/company-team-members-company-team-member-id-get","openApiOperationId":"company-team-members-company-team-member-id-get","summary":"Get company team member."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CompanyTeamMemberResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyTeamMemberResource"}},"schemaId":"components/schemas/CompanyTeamMemberResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1company-team-members~1{company_team_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyTeamMemberResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyTeamMemberResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-users/company-team-members-company-team-member-id-get"}],"panels":[]}]},"httpPath":"/company-team-members/{company_team_member_id}"},{"label":"List company team member events.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/company-users/company-team-members-company-team-member-id-events-get","routeSlug":"/api/aryeo/company-users/company-team-members-company-team-member-id-events-get","metadata":{"seo":{"title":"List company team member events.","description":"List company team member events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"company-team-members-company-team-member-id-events-get","name":"List company team member events.","isWebhook":false,"pointer":"/paths/~1company-team-members~1{company_team_member_id}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List company team member events.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List company team member events."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_team_member_id","in":"path","schemaId":"schema_80","description":"The ID of a company team member. UUID Version 4.","required":true}],"pointer":"/paths/~1company-team-members~1{company_team_member_id}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_95","description":"The start date and time of the calendar events. ISO 8601 format."},{"name":"end","in":"query","schemaId":"schema_96","description":"The end date and time of the calendar events. ISO 8601 format."},{"name":"type","in":"query","schemaId":"schema_97","description":"The type of the calendar events."},{"name":"include_unscheduled","in":"query","schemaId":"schema_98","description":"Include unscheduled appointments."}],"pointer":"/paths/~1company-team-members~1{company_team_member_id}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company-team-members/{company_team_member_id}/events","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"company_team_member_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"start","in":"query","example":"2020-12-29T00:00:00-00:00","schemaId":"schema_95"},{"name":"end","in":"query","example":"2020-12-31T00:00:00-00:00","schemaId":"schema_96"},{"name":"type","in":"query","example":"APPOINTMENT","schemaId":"schema_97"},{"name":"include_unscheduled","in":"query","example":true,"schemaId":"schema_98"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/company-team-members/{company_team_member_id}/events","href":"company-users/company-team-members-company-team-member-id-events-get","openApiOperationId":"company-team-members-company-team-member-id-events-get","summary":"List company team member events."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CalendarEventCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarEventCollection"}},"schemaId":"components/schemas/CalendarEventCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1company-team-members~1{company_team_member_id}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CalendarEventCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarEventCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-users/company-team-members-company-team-member-id-events-get"}],"panels":[]}]},"httpPath":"/company-team-members/{company_team_member_id}/events"}],"content":{"contentType":"group","meta":{"name":"Company Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Users","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to company users. Companies capture media for their customers. Company users represent photographers, videographers, administrators, and other staff."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/company-team-members","summary":"List company team members.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-users/company-team-members-get","deprecated":false},{"title":"/company-team-members/{company_team_member_id}","summary":"Get company team member.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-users/company-team-members-company-team-member-id-get","deprecated":false},{"title":"/company-team-members/{company_team_member_id}/events","summary":"List company team member events.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-users/company-team-members-company-team-member-id-events-get","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer Users","link":"/api/aryeo/customer-users","routeSlug":"/api/aryeo/customer-users","items":[{"label":"Get customer team member.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/customer-users/customer-team-members-customer-team-member-id-get","routeSlug":"/api/aryeo/customer-users/customer-team-members-customer-team-member-id-get","metadata":{"seo":{"title":"Get customer team member.","description":"Get customer team member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-team-members-customer-team-member-id-get","name":"Get customer team member.","isWebhook":false,"pointer":"/paths/~1customer-team-members~1{customer_team_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get customer team member.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get customer team member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_team_member_id","in":"path","schemaId":"schema_80","description":"The ID of a customer team member. UUID Version 4.","required":true}],"pointer":"/paths/~1customer-team-members~1{customer_team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_99","description":"Comma separated list of optional data to include in the response"}],"pointer":"/paths/~1customer-team-members~1{customer_team_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customer-team-members/{customer_team_member_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"customer_team_member_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"include","in":"query","example":"customer","schemaId":"schema_99"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/customer-team-members/{customer_team_member_id}","href":"customer-users/customer-team-members-customer-team-member-id-get","openApiOperationId":"customer-team-members-customer-team-member-id-get","summary":"Get customer team member."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CustomerTeamMembershipResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTeamMembershipResource"}},"schemaId":"components/schemas/CustomerTeamMembershipResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-team-members~1{customer_team_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerTeamMembershipResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTeamMembershipResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-users/customer-team-members-customer-team-member-id-get"}],"panels":[]}]},"httpPath":"/customer-team-members/{customer_team_member_id}"},{"label":"List customer team memberships.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/customer-users/customer-teams-customer-team-id-memberships-get","routeSlug":"/api/aryeo/customer-users/customer-teams-customer-team-id-memberships-get","metadata":{"seo":{"title":"List customer team memberships.","description":"List customer team memberships."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-teams-customer-team-id-memberships-get","name":"List customer team memberships.","isWebhook":false,"pointer":"/paths/~1customer-teams~1{customer_team_id}~1memberships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customer team memberships.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List customer team memberships."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_team_id","in":"path","schemaId":"schema_80","description":"The ID of a customer team. UUID Version 4.","required":true}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1memberships/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[search]","in":"query","schemaId":"schema_100","description":"The search query to filter the customer team memberships."},{"name":"filter[email_domains][]","in":"query","schemaId":"schema_101","description":"The email domains to filter the customer team memberships."},{"name":"sort","in":"query","schemaId":"schema_102","description":"The field to sort the customer team memberships by."},{"name":"per_page","in":"query","schemaId":"schema_103","description":"The number of customer team memberships to return per page."},{"name":"page","in":"query","schemaId":"schema_104","description":"The page number to return."}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1memberships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customer-teams/{customer_team_id}/memberships","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"customer_team_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"filter[search]","in":"query","example":"search","schemaId":"schema_100"},{"name":"filter[email_domains][]","in":"query","example":"google.com","schemaId":"schema_101"},{"name":"sort","in":"query","example":"name","schemaId":"schema_102"},{"name":"per_page","in":"query","example":10,"schemaId":"schema_103"},{"name":"page","in":"query","example":1,"schemaId":"schema_104"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/customer-teams/{customer_team_id}/memberships","href":"customer-users/customer-teams-customer-team-id-memberships-get","openApiOperationId":"customer-teams-customer-team-id-memberships-get","summary":"List customer team memberships."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CustomerTeamMembershipCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTeamMembershipCollection"}},"schemaId":"components/schemas/CustomerTeamMembershipCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1memberships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerTeamMembershipCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTeamMembershipCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-users/customer-teams-customer-team-id-memberships-get"}],"panels":[]}]},"httpPath":"/customer-teams/{customer_team_id}/memberships"},{"label":"Create customer team affiliate membership.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/customer-users/customer-teams-affiliate-memberships-post","routeSlug":"/api/aryeo/customer-users/customer-teams-affiliate-memberships-post","metadata":{"seo":{"title":"Create customer team affiliate membership.","description":"Create customer team affiliate membership."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-teams-affiliate-memberships-post","name":"Create customer team affiliate membership.","isWebhook":false,"pointer":"/paths/~1customer-teams~1affiliate-memberships/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create customer team affiliate membership.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create customer team affiliate membership."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerTeamAffiliateMembershipPostPayload"}},"schemaId":"components/schemas/CustomerTeamAffiliateMembershipPostPayload","pointer":"/paths/~1customer-teams~1affiliate-memberships/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customer-teams/affiliate-memberships","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerTeamAffiliateMembershipPostPayload"}},"responseCodes":["201","422","500"],"pointer":"/customer-teams/affiliate-memberships","href":"customer-users/customer-teams-affiliate-memberships-post","openApiOperationId":"customer-teams-affiliate-memberships-post","summary":"Create customer team affiliate membership."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/CustomerTeamAffiliateMembershipPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerTeamAffiliateMembershipPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"CustomerTeamMembershipResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTeamMembershipResource"}},"schemaId":"components/schemas/CustomerTeamMembershipResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-teams~1affiliate-memberships/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomerTeamMembershipResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTeamMembershipResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-users/customer-teams-affiliate-memberships-post"}],"panels":[]}]},"httpPath":"/customer-teams/affiliate-memberships"},{"label":"List customer users.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/customer-users/customer-users-get","routeSlug":"/api/aryeo/customer-users/customer-users-get","metadata":{"seo":{"title":"List customer users.","description":"List customer users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-users-get","name":"List customer users.","isWebhook":false,"pointer":"/paths/~1customer-users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customer users.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List customer users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_105","description":"Comma separated list of optional data to include in the response."},{"name":"filter[exclude_customers_in_team]","in":"query","schemaId":"schema_106","description":"Filter customers by customer team ID."},{"name":"filter[exclude_customers_in_pricing_plan]","in":"query","schemaId":"schema_106","description":"Filter customers by pricing plan ID."},{"name":"filter[exclude_customers_with_individual_pricing_plan]","in":"query","schemaId":"schema_98","description":"Filter customers that do not have an individual pricing plan."},{"name":"filter[exclude_customers_with_team_pricing_plan]","in":"query","schemaId":"schema_98","description":"Filter customers that do not have a team pricing plan."},{"name":"filter[customer_team_ids]","in":"query","schemaId":"schema_106","description":"Comma separated list of customer team IDs."},{"name":"filter[has_active_team_memberships]","in":"query","schemaId":"schema_98","description":"Filter customers that have active team memberships."},{"name":"filter[search]","in":"query","schemaId":"schema_107","description":"Filter customers by search."},{"name":"sort","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1customer-users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customer-users","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"users","schemaId":"schema_105"},{"name":"filter[exclude_customers_in_team]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_106"},{"name":"filter[exclude_customers_in_pricing_plan]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_106"},{"name":"filter[exclude_customers_with_individual_pricing_plan]","in":"query","example":true,"schemaId":"schema_98"},{"name":"filter[exclude_customers_with_team_pricing_plan]","in":"query","example":true,"schemaId":"schema_98"},{"name":"filter[customer_team_ids]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_106"},{"name":"filter[has_active_team_memberships]","in":"query","example":true,"schemaId":"schema_98"},{"name":"filter[search]","in":"query","example":"john","schemaId":"schema_107"},{"name":"sort","in":"query","example":"-created_at","schemaId":"schema_87"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/customer-users","href":"customer-users/customer-users-get","openApiOperationId":"customer-users-get","summary":"List customer users."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CustomerUserCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerUserCollection"}},"schemaId":"components/schemas/CustomerUserCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerUserCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerUserCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-users/customer-users-get"}],"panels":[]}]},"httpPath":"/customer-users"},{"label":"Create customer user.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/customer-users/customer-users-post","routeSlug":"/api/aryeo/customer-users/customer-users-post","metadata":{"seo":{"title":"Create customer user.","description":"Create customer user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-users-post","name":"Create customer user.","isWebhook":false,"pointer":"/paths/~1customer-users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create customer user.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create customer user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerUserPostPayload"}},"schemaId":"components/schemas/CustomerUserPostPayload","pointer":"/paths/~1customer-users/post/requestBody","description":"CustomerUserPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customer-users","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerUserPostPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/customer-users","href":"customer-users/customer-users-post","openApiOperationId":"customer-users-post","summary":"Create customer user."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/CustomerUserPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerUserPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"GroupCustomer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupCustomer"}},"schemaId":"components/schemas/GroupCustomer"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupCustomer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupCustomer"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-users/customer-users-post"}],"panels":[]}]},"httpPath":"/customer-users"},{"label":"Store customer user credit transaction.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/customer-users/customer-users-user-credit-transactions-store-post","routeSlug":"/api/aryeo/customer-users/customer-users-user-credit-transactions-store-post","metadata":{"seo":{"title":"Store customer user credit transaction.","description":"Store customer user credit transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-users-user-credit-transactions-store-post","name":"Store customer user credit transaction.","isWebhook":false,"pointer":"/paths/~1customer-users~1{user}~1credit-transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Store customer user credit transaction.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Store customer user credit transaction."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user","in":"path","schemaId":"schema_80","description":"The ID of a user. UUID Version 4.","required":true}],"pointer":"/paths/~1customer-users~1{user}~1credit-transactions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_108"}},"schemaId":"schema_108","pointer":"/paths/~1customer-users~1{user}~1credit-transactions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customer-users/{user}/credit-transactions","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"user","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_108"}},"responseCodes":["201","422","500"],"pointer":"/customer-users/{user}/credit-transactions","href":"customer-users/customer-users-user-credit-transactions-store-post","openApiOperationId":"customer-users-user-credit-transactions-store-post","summary":"Store customer user credit transaction."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"schema_108","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_108"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Credit transaction created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditTransactionResource"}},"schemaId":"components/schemas/CreditTransactionResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-users~1{user}~1credit-transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreditTransactionResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditTransactionResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-users/customer-users-user-credit-transactions-store-post"}],"panels":[]}]},"httpPath":"/customer-users/{user}/credit-transactions"},{"label":"List customers.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/customer-users/customers-get","routeSlug":"/api/aryeo/customer-users/customers-get","metadata":{"seo":{"title":"List customers.","description":"List customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customers-get","name":"List customers.","isWebhook":false,"pointer":"/paths/~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customers.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List customers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_105","description":"Comma separated list of optional data to include in the response."},{"name":"filter[exclude_ids]","in":"query","schemaId":"schema_106","description":"Comma separated list of customer user IDs to exclude from the response."},{"name":"filter[email_domain]","in":"query","schemaId":"schema_109","description":"Filter customers by email domain."},{"name":"filter[search]","in":"query","schemaId":"schema_107","description":"Filter customers by search."},{"name":"filter[email]","in":"query","schemaId":"schema_110","description":"Filter customers by email."},{"name":"filter[phone]","in":"query","schemaId":"schema_111","description":"Filter customers by phone."},{"name":"filter[customer_team_ids]","in":"query","schemaId":"schema_106","description":"Filter customers by customer team IDs."},{"name":"filter[name]","in":"query","schemaId":"schema_112","description":"Filter customers by name."},{"name":"sort","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"users","schemaId":"schema_105"},{"name":"filter[exclude_ids]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_106"},{"name":"filter[email_domain]","in":"query","example":"gmail.com","schemaId":"schema_109"},{"name":"filter[search]","in":"query","example":"john","schemaId":"schema_107"},{"name":"filter[email]","in":"query","example":"john.doe@gmail.com","schemaId":"schema_110"},{"name":"filter[phone]","in":"query","example":"1234567890","schemaId":"schema_111"},{"name":"filter[customer_team_ids]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_106"},{"name":"filter[name]","in":"query","example":"John Doe","schemaId":"schema_112"},{"name":"sort","in":"query","example":"-created_at","schemaId":"schema_87"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/customers","href":"customer-users/customers-get","openApiOperationId":"customers-get","summary":"List customers."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"GroupCustomerCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupCustomerCollection"}},"schemaId":"components/schemas/GroupCustomerCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupCustomerCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupCustomerCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-users/customers-get"}],"panels":[]}]},"httpPath":"/customers"},{"label":"Create a customer.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/customer-users/customers-post","routeSlug":"/api/aryeo/customer-users/customers-post","metadata":{"seo":{"title":"Create a customer.","description":"Create a customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customers-post","name":"Create a customer.","isWebhook":false,"pointer":"/paths/~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a customer.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerPostPayload"}},"schemaId":"components/schemas/CustomerPostPayload","pointer":"/paths/~1customers/post/requestBody","description":"CustomerPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomerPostPayload"}},"responseCodes":["200","422","500"],"pointer":"/customers","href":"customer-users/customers-post","openApiOperationId":"customers-post","summary":"Create a customer."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/CustomerPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomerPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"GroupCustomerResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupCustomerResource"}},"schemaId":"components/schemas/GroupCustomerResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupCustomerResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupCustomerResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-users/customers-post"}],"panels":[]}]},"httpPath":"/customers"}],"content":{"contentType":"group","meta":{"name":"Customer Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer Users","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to customer users. Customers receive media from companies. Customer users represent real-estate agents, assistants, listing coordinators, and brokerage members."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customer-team-members/{customer_team_member_id}","summary":"Get customer team member.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-users/customer-team-members-customer-team-member-id-get","deprecated":false},{"title":"/customer-teams/{customer_team_id}/memberships","summary":"List customer team memberships.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-users/customer-teams-customer-team-id-memberships-get","deprecated":false},{"title":"/customer-teams/affiliate-memberships","summary":"Create customer team affiliate membership.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-users/customer-teams-affiliate-memberships-post","deprecated":false},{"title":"/customer-users","summary":"List customer users.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-users/customer-users-get","deprecated":false},{"title":"/customer-users","summary":"Create customer user.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-users/customer-users-post","deprecated":false},{"title":"/customer-users/{user}/credit-transactions","summary":"Store customer user credit transaction.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-users/customer-users-user-credit-transactions-store-post","deprecated":false},{"title":"/customers","summary":"List customers.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-users/customers-get","deprecated":false},{"title":"/customers","summary":"Create a customer.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-users/customers-post","deprecated":false}]}]}]}]}},{"type":"group","label":"Discounts","link":"/api/aryeo/discounts","routeSlug":"/api/aryeo/discounts","items":[{"label":"List coupons.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/discounts/get-coupons","routeSlug":"/api/aryeo/discounts/get-coupons","metadata":{"seo":{"title":"List coupons.","description":"List coupons."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-coupons","name":"List coupons.","isWebhook":false,"pointer":"/paths/~1coupons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List coupons.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List coupons."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[search]","in":"query","schemaId":"schema_113","description":"Return coupons that have a name matching this field."},{"name":"include","in":"query","schemaId":"schema_114","description":"Comma separated list of optional data to include in the response."},{"name":"sort","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_88","description":"The number of items per page. Defaults to 25."},{"name":"page","in":"query","schemaId":"schema_89","description":"The requested page. Defaults to 1."}],"pointer":"/paths/~1coupons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"filter[search]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_113"},{"name":"include","in":"query","example":"promotion_codes","schemaId":"schema_114"},{"name":"sort","in":"query","example":"-created_at","schemaId":"schema_87"},{"name":"per_page","in":"query","example":"25","schemaId":"schema_88"},{"name":"page","in":"query","example":"2","schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/coupons","href":"discounts/get-coupons","openApiOperationId":"get-coupons","summary":"List coupons."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CouponCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCollection"}},"schemaId":"components/schemas/CouponCollection"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1coupons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CouponCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CouponCollection"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discounts/get-coupons"}],"panels":[]}]},"httpPath":"/coupons"},{"label":"Create discount.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/discounts/post-discounts","routeSlug":"/api/aryeo/discounts/post-discounts","metadata":{"seo":{"title":"Create discount.","description":"Create discount."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-discounts","name":"Create discount.","isWebhook":false,"pointer":"/paths/~1discounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create discount.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create discount."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DiscountPostPayload"}},"schemaId":"components/schemas/DiscountPostPayload","pointer":"/paths/~1discounts/post/requestBody","description":"DiscountPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/discounts","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DiscountPostPayload"}},"responseCodes":["201","403","404","422","500"],"pointer":"/discounts","href":"discounts/post-discounts","openApiOperationId":"post-discounts","summary":"Create discount."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/DiscountPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DiscountPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"DiscountResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountResource"}},"schemaId":"components/schemas/DiscountResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1discounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/DiscountResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DiscountResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discounts/post-discounts"}],"panels":[]}]},"httpPath":"/discounts"},{"label":"Delete discount.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/discounts/delete-discounts-discount-id","routeSlug":"/api/aryeo/discounts/delete-discounts-discount-id","metadata":{"seo":{"title":"Delete discount.","description":"Delete discount."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-discounts-discount-id","name":"Delete discount.","isWebhook":false,"pointer":"/paths/~1discounts~1{discount_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete discount.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete discount."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"discount_id","in":"path","schemaId":"schema_80","description":"The ID of a discount. UUID Version 4.","required":true}],"pointer":"/paths/~1discounts~1{discount_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/discounts/{discount_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"discount_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","403","404","422","500"],"pointer":"/discounts/{discount_id}","href":"discounts/delete-discounts-discount-id","openApiOperationId":"delete-discounts-discount-id","summary":"Delete discount."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1discounts~1{discount_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discounts/delete-discounts-discount-id"}],"panels":[]}]},"httpPath":"/discounts/{discount_id}"},{"label":"Delete order discount.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/discounts/orders-order-discounts-discount-delete","routeSlug":"/api/aryeo/discounts/orders-order-discounts-discount-delete","metadata":{"seo":{"title":"Delete order discount.","description":"Delete order discount."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orders-order-discounts-discount-delete","name":"Delete order discount.","isWebhook":false,"pointer":"/paths/~1orders~1{order}~1discounts~1{discount}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete order discount.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete order discount."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true},{"name":"discount","in":"path","schemaId":"schema_80","description":"The ID of a discount. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order}~1discounts~1{discount}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orders/{order}/discounts/{discount}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"},{"name":"discount","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/orders/{order}/discounts/{discount}","href":"discounts/orders-order-discounts-discount-delete","openApiOperationId":"orders-order-discounts-discount-delete","summary":"Delete order discount."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}},"schemaId":"components/schemas/OrderResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order}~1discounts~1{discount}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discounts/orders-order-discounts-discount-delete"}],"panels":[]}]},"httpPath":"/orders/{order}/discounts/{discount}"},{"label":"Redeem promotion code.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/discounts/promotion-codes-redeem-discountedtype-discounted-post","routeSlug":"/api/aryeo/discounts/promotion-codes-redeem-discountedtype-discounted-post","metadata":{"seo":{"title":"Redeem promotion code.","description":"Redeem promotion code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"promotion-codes-redeem-discountedType-discounted-post","name":"Redeem promotion code.","isWebhook":false,"pointer":"/paths/~1promotion-codes~1redeem~1{discountedType}~1{discounted}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redeem promotion code.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Redeem promotion code."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"discountedType","in":"path","schemaId":"schema_115","description":"The type of discountable.","required":true},{"name":"discounted","in":"path","schemaId":"schema_80","description":"The ID of a discountable. UUID Version 4.","required":true}],"pointer":"/paths/~1promotion-codes~1redeem~1{discountedType}~1{discounted}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromotionCodeRedeemPostPayload"}},"schemaId":"components/schemas/PromotionCodeRedeemPostPayload","pointer":"/paths/~1promotion-codes~1redeem~1{discountedType}~1{discounted}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/promotion-codes/redeem/{discountedType}/{discounted}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"discountedType","in":"path","required":true,"example":"product","schemaId":"schema_115"},{"name":"discounted","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PromotionCodeRedeemPostPayload"}},"responseCodes":["200","403","404","422","500"],"pointer":"/promotion-codes/redeem/{discountedType}/{discounted}","href":"discounts/promotion-codes-redeem-discountedtype-discounted-post","openApiOperationId":"promotion-codes-redeem-discountedType-discounted-post","summary":"Redeem promotion code."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/PromotionCodeRedeemPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PromotionCodeRedeemPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1promotion-codes~1redeem~1{discountedType}~1{discounted}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discounts/promotion-codes-redeem-discountedtype-discounted-post"}],"panels":[]}]},"httpPath":"/promotion-codes/redeem/{discountedType}/{discounted}"},{"label":"Refund order payment.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/discounts/refunds-orderpayment-post","routeSlug":"/api/aryeo/discounts/refunds-orderpayment-post","metadata":{"seo":{"title":"Refund order payment.","description":"Refund order payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refunds-orderPayment-post","name":"Refund order payment.","isWebhook":false,"pointer":"/paths/~1refunds~1{orderPayment}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund order payment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Refund order payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderPayment","in":"path","schemaId":"schema_80","description":"The ID of an order payment. UUID Version 4.","required":true}],"pointer":"/paths/~1refunds~1{orderPayment}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderRefundPostPayload"}},"schemaId":"components/schemas/OrderRefundPostPayload","pointer":"/paths/~1refunds~1{orderPayment}/post/requestBody","description":"OrderRefundPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds/{orderPayment}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"orderPayment","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderRefundPostPayload"}},"responseCodes":["201","422","500"],"pointer":"/refunds/{orderPayment}","href":"discounts/refunds-orderpayment-post","openApiOperationId":"refunds-orderPayment-post","summary":"Refund order payment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/OrderRefundPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderRefundPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderRefundResource"}},"schemaId":"components/schemas/OrderRefundResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1refunds~1{orderPayment}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderRefundResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderRefundResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discounts/refunds-orderpayment-post"}],"panels":[]}]},"httpPath":"/refunds/{orderPayment}"}],"content":{"contentType":"group","meta":{"name":"Discounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discounts","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to discounts. Discounts support percentage or fixed-amount discounts, and coupon codes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/coupons","summary":"List coupons.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discounts/get-coupons","deprecated":false},{"title":"/discounts","summary":"Create discount.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discounts/post-discounts","deprecated":false},{"title":"/discounts/{discount_id}","summary":"Delete discount.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/discounts/delete-discounts-discount-id","deprecated":false},{"title":"/orders/{order}/discounts/{discount}","summary":"Delete order discount.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/discounts/orders-order-discounts-discount-delete","deprecated":false},{"title":"/promotion-codes/redeem/{discountedType}/{discounted}","summary":"Redeem promotion code.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discounts/promotion-codes-redeem-discountedtype-discounted-post","deprecated":false},{"title":"/refunds/{orderPayment}","summary":"Refund order payment.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discounts/refunds-orderpayment-post","deprecated":false}]}]}]}]}},{"type":"group","label":"Listings","link":"/api/aryeo/listings","routeSlug":"/api/aryeo/listings","items":[{"label":"List listings.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/listings/get-listings","routeSlug":"/api/aryeo/listings/get-listings","metadata":{"seo":{"title":"List listings.","description":"Lists all listings available to a group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-listings","name":"List listings.","isWebhook":false,"pointer":"/paths/~1listings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List listings.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all listings available to a group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_117","description":"Comma separated list of optional data to include in the response."},{"name":"filter[search]","in":"query","schemaId":"schema_118","description":"Return listings that have fields matching this term."},{"name":"filter[address]","in":"query","schemaId":"schema_118","description":"Return listings that have an address matching this term."},{"name":"filter[list_agent]","in":"query","schemaId":"schema_119","description":"Return listings that have a listing agent or co-listing agent matching this term."},{"name":"filter[status]","in":"query","schemaId":"schema_120","description":"Return listings that have a certain status."},{"name":"filter[active]","in":"query","schemaId":"schema_98","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set as true to return listings that have an active status (e.g. active statuses include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMING_SOON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FOR_SALE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FOR_LEASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_SALE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_LEASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SOLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LEASED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"filter[price_gte]","in":"query","schemaId":"schema_121","description":"Return listings where the price field is greater than or equal to this value."},{"name":"filter[price_lte]","in":"query","schemaId":"schema_122","description":"Return listings where the price field is less than or equal to this value."},{"name":"filter[square_feet_gte]","in":"query","schemaId":"schema_123","description":"Return listings where the square feet field is greater than or equal to this value."},{"name":"filter[square_feet_lte]","in":"query","schemaId":"schema_124","description":"Return listings where the square feet field is less than or equal to this value."},{"name":"filter[bedrooms_gte]","in":"query","schemaId":"schema_125","description":"Return listings where the bedrooms field is greater than or equal to this value."},{"name":"filter[bedrooms_lte]","in":"query","schemaId":"schema_126","description":"Return listings where the bedrooms field is less than or equal to this value."},{"name":"filter[bathrooms_gte]","in":"query","schemaId":"schema_127","description":"Return listings where the bathrooms field is greater than or equal to this value."},{"name":"filter[bathrooms_lte]","in":"query","schemaId":"schema_128","description":"Return listings where the bathrooms field is less than or equal to this value."},{"name":"filter[delivery_status]","in":"query","schemaId":"schema_129","description":"Return listings where the delivery status is equal to this value."},{"name":"filter[showcase]","in":"query","schemaId":"schema_98","description":"Return listings associated with a Showcase media request."},{"name":"sort","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_88","description":"The number of items per page. Defaults to 25."},{"name":"page","in":"query","schemaId":"schema_89","description":"The requested page. Defaults to 1."}],"pointer":"/paths/~1listings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/listings","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"list_agent,list_agent.social_profiles,list_agent.owner,co_list_agent,co_list_agent.social_profiles,co_list_agent.owner,images,files,videos,floor_plans,interactive_content,property_website","schemaId":"schema_117"},{"name":"filter[search]","in":"query","example":"123 Main St","schemaId":"schema_118"},{"name":"filter[address]","in":"query","example":"123 Main St","schemaId":"schema_118"},{"name":"filter[list_agent]","in":"query","example":"John Doe","schemaId":"schema_119"},{"name":"filter[status]","in":"query","example":"FOR_SALE","schemaId":"schema_120"},{"name":"filter[active]","in":"query","example":true,"schemaId":"schema_98"},{"name":"filter[price_gte]","in":"query","example":100000,"schemaId":"schema_121"},{"name":"filter[price_lte]","in":"query","example":4000000,"schemaId":"schema_122"},{"name":"filter[square_feet_gte]","in":"query","example":1000,"schemaId":"schema_123"},{"name":"filter[square_feet_lte]","in":"query","example":5000,"schemaId":"schema_124"},{"name":"filter[bedrooms_gte]","in":"query","example":2,"schemaId":"schema_125"},{"name":"filter[bedrooms_lte]","in":"query","example":4,"schemaId":"schema_126"},{"name":"filter[bathrooms_gte]","in":"query","example":2.5,"schemaId":"schema_127"},{"name":"filter[bathrooms_lte]","in":"query","example":5,"schemaId":"schema_128"},{"name":"filter[delivery_status]","in":"query","example":"DELIVERED","schemaId":"schema_129"},{"name":"filter[showcase]","in":"query","example":true,"schemaId":"schema_98"},{"name":"sort","in":"query","example":"-created_at","schemaId":"schema_87"},{"name":"per_page","in":"query","example":"25","schemaId":"schema_88"},{"name":"page","in":"query","example":"2","schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/listings","href":"listings/get-listings","openApiOperationId":"get-listings","summary":"List listings."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ListingCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingCollection"}},"schemaId":"components/schemas/ListingCollection"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1listings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListingCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingCollection"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listings/get-listings"}],"panels":[]}]},"httpPath":"/listings"},{"label":"Create listing.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/listings/post-listings","routeSlug":"/api/aryeo/listings/post-listings","metadata":{"seo":{"title":"Create listing.","description":"Create listing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-listings","name":"Create listing.","isWebhook":false,"pointer":"/paths/~1listings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create listing.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create listing."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListingPostPayload"}},"schemaId":"components/schemas/ListingPostPayload","pointer":"/paths/~1listings/post/requestBody","description":"ListingPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/listings","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListingPostPayload"}},"responseCodes":["201","403","404","409","422","500"],"pointer":"/listings","href":"listings/post-listings","openApiOperationId":"post-listings","summary":"Create listing."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/ListingPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListingPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"ListingResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingResource"}},"schemaId":"components/schemas/ListingResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"409","description":"ApiError409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}},"schemaId":"components/schemas/ApiError409"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1listings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ListingResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"409","schemaId":"components/schemas/ApiError409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listings/post-listings"}],"panels":[]}]},"httpPath":"/listings"},{"label":"Get listing.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/listings/get-listings-id","routeSlug":"/api/aryeo/listings/get-listings-id","metadata":{"seo":{"title":"Get listing.","description":"Get listing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-listings-id","name":"Get listing.","isWebhook":false,"pointer":"/paths/~1listings~1{listing_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get listing.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get listing."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"listing_id","in":"path","schemaId":"schema_80","description":"The ID of a listing. UUID Version 4.","required":true}],"pointer":"/paths/~1listings~1{listing_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_130","description":"Comma separated list of optional data to include in the response."}],"pointer":"/paths/~1listings~1{listing_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/listings/{listing_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"listing_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"include","in":"query","example":"list_agent,list_agent.social_profiles,list_agent.owner,co_list_agent,co_list_agent.social_profiles,co_list_agent.owner,images,files,videos,floor_plans,interactive_content,property_website,orders.appointments","schemaId":"schema_130"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/listings/{listing_id}","href":"listings/get-listings-id","openApiOperationId":"get-listings-id","summary":"Get listing."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ListingResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingResource"}},"schemaId":"components/schemas/ListingResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1listings~1{listing_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListingResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listings/get-listings-id"}],"panels":[]}]},"httpPath":"/listings/{listing_id}"},{"label":"Update listing.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/listings/update-listings","routeSlug":"/api/aryeo/listings/update-listings","metadata":{"seo":{"title":"Update listing.","description":"Update listing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-listings","name":"Update listing.","isWebhook":false,"pointer":"/paths/~1listings~1{listing_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update listing.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update listing."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"listing_id","in":"path","schemaId":"schema_80","description":"The ID of a listing. UUID Version 4.","required":true}],"pointer":"/paths/~1listings~1{listing_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListingPutPayload"}},"schemaId":"components/schemas/ListingPutPayload","pointer":"/paths/~1listings~1{listing_id}/put/requestBody","description":"ListingPutPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/listings/{listing_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"listing_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListingPutPayload"}},"responseCodes":["200","403","404","409","422","500"],"pointer":"/listings/{listing_id}","href":"listings/update-listings","openApiOperationId":"update-listings","summary":"Update listing."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/ListingPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListingPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ListingResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingResource"}},"schemaId":"components/schemas/ListingResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"409","description":"ApiError409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}},"schemaId":"components/schemas/ApiError409"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1listings~1{listing_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListingResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"409","schemaId":"components/schemas/ApiError409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listings/update-listings"}],"panels":[]}]},"httpPath":"/listings/{listing_id}"},{"label":"Get listing Cubicasa information.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/listings/listings-listing-id-cubi-casa-get","routeSlug":"/api/aryeo/listings/listings-listing-id-cubi-casa-get","metadata":{"seo":{"title":"Get listing Cubicasa information.","description":"Get listing Cubicasa information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listings-listing-id-cubi-casa-get","name":"Get listing Cubicasa information.","isWebhook":false,"pointer":"/paths/~1listings~1{listing_id}~1cubi-casa/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get listing Cubicasa information.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get listing Cubicasa information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"listing_id","in":"path","schemaId":"schema_80","description":"The ID of a listing. UUID Version 4.","required":true}],"pointer":"/paths/~1listings~1{listing_id}~1cubi-casa/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/listings/{listing_id}/cubi-casa","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"listing_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/listings/{listing_id}/cubi-casa","href":"listings/listings-listing-id-cubi-casa-get","openApiOperationId":"listings-listing-id-cubi-casa-get","summary":"Get listing Cubicasa information."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CubiCasaFloorplanResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CubiCasaFloorplanResource"}},"schemaId":"components/schemas/CubiCasaFloorplanResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1listings~1{listing_id}~1cubi-casa/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CubiCasaFloorplanResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CubiCasaFloorplanResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listings/listings-listing-id-cubi-casa-get"}],"panels":[]}]},"httpPath":"/listings/{listing_id}/cubi-casa"},{"label":"Search listing details.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/listings/listings-listing-id-details-search-get","routeSlug":"/api/aryeo/listings/listings-listing-id-details-search-get","metadata":{"seo":{"title":"Search listing details.","description":"Search listing details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listings-listing-id-details-search-get","name":"Search listing details.","isWebhook":false,"pointer":"/paths/~1listings~1{listing_id}~1details~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search listing details.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search listing details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"listing_id","in":"path","schemaId":"schema_80","description":"The ID of a listing. UUID Version 4.","required":true}],"pointer":"/paths/~1listings~1{listing_id}~1details~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/listings/{listing_id}/details/search","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"listing_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/listings/{listing_id}/details/search","href":"listings/listings-listing-id-details-search-get","openApiOperationId":"listings-listing-id-details-search-get","summary":"Search listing details."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ListingDetailSearchResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingDetailSearchResource"}},"schemaId":"components/schemas/ListingDetailSearchResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1listings~1{listing_id}~1details~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListingDetailSearchResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingDetailSearchResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listings/listings-listing-id-details-search-get"}],"panels":[]}]},"httpPath":"/listings/{listing_id}/details/search"},{"label":"Get listing statistics.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/listings/listings-listing-id-stats-get","routeSlug":"/api/aryeo/listings/listings-listing-id-stats-get","metadata":{"seo":{"title":"Get listing statistics.","description":"Get listing statistics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listings-listing-id-stats-get","name":"Get listing statistics.","isWebhook":false,"pointer":"/paths/~1listings~1{listing_id}~1stats/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get listing statistics.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get listing statistics."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"listing_id","in":"path","schemaId":"schema_80","description":"The ID of a listing. UUID Version 4.","required":true}],"pointer":"/paths/~1listings~1{listing_id}~1stats/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/listings/{listing_id}/stats","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"listing_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/listings/{listing_id}/stats","href":"listings/listings-listing-id-stats-get","openApiOperationId":"listings-listing-id-stats-get","summary":"Get listing statistics."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ListingStatsResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingStatsResource"}},"schemaId":"components/schemas/ListingStatsResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1listings~1{listing_id}~1stats/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListingStatsResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListingStatsResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/listings/listings-listing-id-stats-get"}],"panels":[]}]},"httpPath":"/listings/{listing_id}/stats"}],"content":{"contentType":"group","meta":{"name":"Listings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Listings","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to listings. Listings are the core entity that connects properties with media services."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/listings","summary":"List listings.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/listings/get-listings","deprecated":false},{"title":"/listings","summary":"Create listing.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/listings/post-listings","deprecated":false},{"title":"/listings/{listing_id}","summary":"Get listing.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/listings/get-listings-id","deprecated":false},{"title":"/listings/{listing_id}","summary":"Update listing.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/listings/update-listings","deprecated":false},{"title":"/listings/{listing_id}/cubi-casa","summary":"Get listing Cubicasa information.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/listings/listings-listing-id-cubi-casa-get","deprecated":false},{"title":"/listings/{listing_id}/details/search","summary":"Search listing details.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/listings/listings-listing-id-details-search-get","deprecated":false},{"title":"/listings/{listing_id}/stats","summary":"Get listing statistics.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/listings/listings-listing-id-stats-get","deprecated":false}]}]}]}]}},{"type":"group","label":"Notes","link":"/api/aryeo/notes","routeSlug":"/api/aryeo/notes","items":[{"label":"Update order notes.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/notes/orders-order-id-notes-put","routeSlug":"/api/aryeo/notes/orders-order-id-notes-put","metadata":{"seo":{"title":"Update order notes.","description":"Update order notes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orders-order-id-notes-put","name":"Update order notes.","isWebhook":false,"pointer":"/paths/~1orders~1{order_id}~1notes/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update order notes.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update order notes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order_id}~1notes/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderNotesPutPayload"}},"schemaId":"components/schemas/OrderNotesPutPayload","pointer":"/paths/~1orders~1{order_id}~1notes/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/{order_id}/notes","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderNotesPutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/orders/{order_id}/notes","href":"notes/orders-order-id-notes-put","openApiOperationId":"orders-order-id-notes-put","summary":"Update order notes."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/OrderNotesPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderNotesPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}},"schemaId":"components/schemas/OrderResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order_id}~1notes/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notes/orders-order-id-notes-put"}],"panels":[]}]},"httpPath":"/orders/{order_id}/notes"}],"content":{"contentType":"group","meta":{"name":"Notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notes","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to notes. Notes are contextual comments across various entities including orders, listings, customers, and appointments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders/{order_id}/notes","summary":"Update order notes.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notes/orders-order-id-notes-put","deprecated":false}]}]}]}]}},{"type":"group","label":"Order Forms","link":"/api/aryeo/order-forms","routeSlug":"/api/aryeo/order-forms","items":[{"label":"Create order form session.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/order-forms/post-order-form-sessions","routeSlug":"/api/aryeo/order-forms/post-order-form-sessions","metadata":{"seo":{"title":"Create order form session.","description":"Create order form session"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-order-form-sessions","name":"Create order form session.","isWebhook":false,"pointer":"/paths/~1order-form-sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order form session.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create order form session"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderFormSessionPostPayload"}},"schemaId":"components/schemas/OrderFormSessionPostPayload","pointer":"/paths/~1order-form-sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order-form-sessions","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderFormSessionPostPayload"}},"responseCodes":["201","403","404","422","500"],"pointer":"/order-form-sessions","href":"order-forms/post-order-form-sessions","openApiOperationId":"post-order-form-sessions","summary":"Create order form session."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/OrderFormSessionPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderFormSessionPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderFormSessionResource"}},"schemaId":"components/schemas/OrderFormSessionResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1order-form-sessions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderFormSessionResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderFormSessionResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-forms/post-order-form-sessions"}],"panels":[]}]},"httpPath":"/order-form-sessions"},{"label":"List order forms.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/order-forms/get-order-forms","routeSlug":"/api/aryeo/order-forms/get-order-forms","metadata":{"seo":{"title":"List order forms.","description":"Lists all order forms for the current group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-order-forms","name":"List order forms.","isWebhook":false,"pointer":"/paths/~1order-forms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List order forms.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all order forms for the current group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/order-forms","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/order-forms","href":"order-forms/get-order-forms","openApiOperationId":"get-order-forms","summary":"List order forms."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderFormCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderFormCollection"}},"schemaId":"components/schemas/OrderFormCollection"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1order-forms/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderFormCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderFormCollection"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-forms/get-order-forms"}],"panels":[]}]},"httpPath":"/order-forms"}],"content":{"contentType":"group","meta":{"name":"Order Forms"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Forms","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to order forms. Order forms are the customer-facing booking interfaces for service requests, product selection, and appointment scheduling."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/order-form-sessions","summary":"Create order form session.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-forms/post-order-form-sessions","deprecated":false},{"title":"/order-forms","summary":"List order forms.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-forms/get-order-forms","deprecated":false}]}]}]}]}},{"type":"group","label":"Order Items","link":"/api/aryeo/order-items","routeSlug":"/api/aryeo/order-items","items":[{"label":"Create order item.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/order-items/post-order-items","routeSlug":"/api/aryeo/order-items/post-order-items","metadata":{"seo":{"title":"Create order item.","description":"Create order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-order-items","name":"Create order item.","isWebhook":false,"pointer":"/paths/~1order-items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order item.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemPostPayload"}},"schemaId":"components/schemas/OrderItemPostPayload","pointer":"/paths/~1order-items/post/requestBody","description":"OrderPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order-items","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderItemPostPayload"}},"responseCodes":["201","403","404","409","422","500"],"pointer":"/order-items","href":"order-items/post-order-items","openApiOperationId":"post-order-items","summary":"Create order item."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/OrderItemPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OrderItemResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemResource"}},"schemaId":"components/schemas/OrderItemResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"409","description":"ApiError409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}},"schemaId":"components/schemas/ApiError409"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1order-items/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderItemResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"409","schemaId":"components/schemas/ApiError409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/post-order-items"}],"panels":[]}]},"httpPath":"/order-items"},{"label":"Get order item.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/order-items/get-order-items-order-item-id","routeSlug":"/api/aryeo/order-items/get-order-items-order-item-id","metadata":{"seo":{"title":"Get order item.","description":"Get order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-order-items-order-item-id","name":"Get order item.","isWebhook":false,"pointer":"/paths/~1order-items~1{order_item_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order item.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_item_id","in":"path","schemaId":"schema_80","description":"The ID of an order item. UUID Version 4.","required":true}],"pointer":"/paths/~1order-items~1{order_item_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_131","description":"Comma separated list of optional data to include in the response."}],"pointer":"/paths/~1order-items~1{order_item_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/order-items/{order_item_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_item_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"include","in":"query","example":"resource","schemaId":"schema_131"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/order-items/{order_item_id}","href":"order-items/get-order-items-order-item-id","openApiOperationId":"get-order-items-order-item-id","summary":"Get order item."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderItemResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemResource"}},"schemaId":"components/schemas/OrderItemResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1order-items~1{order_item_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/get-order-items-order-item-id"}],"panels":[]}]},"httpPath":"/order-items/{order_item_id}"},{"label":"Update order item.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/order-items/put-order-items-order-item-id","routeSlug":"/api/aryeo/order-items/put-order-items-order-item-id","metadata":{"seo":{"title":"Update order item.","description":"Update order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-order-items-order-item-id","name":"Update order item.","isWebhook":false,"pointer":"/paths/~1order-items~1{order_item_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update order item.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_item_id","in":"path","schemaId":"schema_80","description":"The ID of an order item. UUID Version 4.","required":true}],"pointer":"/paths/~1order-items~1{order_item_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/order-items/{order_item_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_item_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/order-items/{order_item_id}","href":"order-items/put-order-items-order-item-id","openApiOperationId":"put-order-items-order-item-id","summary":"Update order item."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderItemResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemResource"}},"schemaId":"components/schemas/OrderItemResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1order-items~1{order_item_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/put-order-items-order-item-id"}],"panels":[]}]},"httpPath":"/order-items/{order_item_id}"},{"label":"Delete order item.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/order-items/delete-order-items-order-item-id","routeSlug":"/api/aryeo/order-items/delete-order-items-order-item-id","metadata":{"seo":{"title":"Delete order item.","description":"Delete order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-order-items-order-item-id","name":"Delete order item.","isWebhook":false,"pointer":"/paths/~1order-items~1{order_item_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete order item.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_item_id","in":"path","schemaId":"schema_80","description":"The ID of an order item. UUID Version 4.","required":true}],"pointer":"/paths/~1order-items~1{order_item_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/order-items/{order_item_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_item_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","403","404","422","500"],"pointer":"/order-items/{order_item_id}","href":"order-items/delete-order-items-order-item-id","openApiOperationId":"delete-order-items-order-item-id","summary":"Delete order item."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1order-items~1{order_item_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/delete-order-items-order-item-id"}],"panels":[]}]},"httpPath":"/order-items/{order_item_id}"}],"content":{"contentType":"group","meta":{"name":"Order Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Items","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to order items. Order items are the individual line items within orders."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/order-items","summary":"Create order item.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-items/post-order-items","deprecated":false},{"title":"/order-items/{order_item_id}","summary":"Get order item.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-items/get-order-items-order-item-id","deprecated":false},{"title":"/order-items/{order_item_id}","summary":"Update order item.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-items/put-order-items-order-item-id","deprecated":false},{"title":"/order-items/{order_item_id}","summary":"Delete order item.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-items/delete-order-items-order-item-id","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/api/aryeo/orders","routeSlug":"/api/aryeo/orders","items":[{"label":"List orders.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/orders/get-orders","routeSlug":"/api/aryeo/orders/get-orders","metadata":{"seo":{"title":"List orders.","description":"Lists all orders of a group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-orders","name":"List orders.","isWebhook":false,"pointer":"/paths/~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all orders of a group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_132","description":"Comma separated list of optional data to include in the response."},{"name":"filter[search]","in":"query","schemaId":"schema_133","description":"Return orders with addresses or customers that match on this string."},{"name":"filter[payment_status]","in":"query","schemaId":"schema_134","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return orders with the specified payment status. Available payment statuses are PAID, PARTIALLY_PAID, and UNPAID."},"children":[]}]}]}]},{"name":"filter[fulfillment_status]","in":"query","schemaId":"schema_133","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return orders with the specified fulfillment status. Available fulfillment statuses are FULFILLED, PARTIALLY_FULFILLED, and UNFULFILLED."},"children":[]}]}]}]},{"name":"filter[appointment_start_at_gte]","in":"query","schemaId":"schema_84","description":"Return orders with an appointment starting after this date."},{"name":"filter[appointment_start_at_lte]","in":"query","schemaId":"schema_84","description":"Return orders with an appointment starting before this date."},{"name":"filter[creator_group_id]","in":"query","schemaId":"schema_135","description":"Creator group ID used to list orders owned by a specific creator."},{"name":"filter[tag_ids][]","in":"query","schemaId":"schema_136","description":"Set to include orders with tags that match any of the tags provided."},{"name":"filter[user_ids][]","in":"query","schemaId":"schema_86","description":"Set to include orders that have appointments with the given users."},{"name":"sort","in":"query","schemaId":"schema_137","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_88","description":"The number of items per page. Defaults to 25."},{"name":"page","in":"query","schemaId":"schema_89","description":"The requested page. Defaults to 1."}],"pointer":"/paths/~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"items,listing,customer,appointments,appointments.users,unconfirmed_appointments,order_form,discounts,discounts.coupon","schemaId":"schema_132"},{"name":"filter[search]","in":"query","example":"123 Imperial","schemaId":"schema_133"},{"name":"filter[payment_status]","in":"query","example":"PAID","schemaId":"schema_134"},{"name":"filter[fulfillment_status]","in":"query","example":"123 Imperial","schemaId":"schema_133"},{"name":"filter[appointment_start_at_gte]","in":"query","example":"2021-01-01T13:00:00Z","schemaId":"schema_84"},{"name":"filter[appointment_start_at_lte]","in":"query","example":"2021-01-01T13:00:00Z","schemaId":"schema_84"},{"name":"filter[creator_group_id]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_135"},{"name":"filter[tag_ids][]","in":"query","schemaId":"schema_136"},{"name":"filter[user_ids][]","in":"query","schemaId":"schema_86"},{"name":"sort","in":"query","example":"appointment_start","schemaId":"schema_137"},{"name":"per_page","in":"query","example":"25","schemaId":"schema_88"},{"name":"page","in":"query","example":"2","schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/orders","href":"orders/get-orders","openApiOperationId":"get-orders","summary":"List orders."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCollection"}},"schemaId":"components/schemas/OrderCollection"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCollection"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get-orders"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Create order.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/orders/post-orders","routeSlug":"/api/aryeo/orders/post-orders","metadata":{"seo":{"title":"Create order.","description":"Create order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-orders","name":"Create order.","isWebhook":false,"pointer":"/paths/~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderPostPayload"}},"schemaId":"components/schemas/OrderPostPayload","pointer":"/paths/~1orders/post/requestBody","description":"OrderPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderPostPayload"}},"responseCodes":["201","403","404","409","422","500"],"pointer":"/orders","href":"orders/post-orders","openApiOperationId":"post-orders","summary":"Create order."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/OrderPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OrderResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}},"schemaId":"components/schemas/OrderResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"409","description":"ApiError409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}},"schemaId":"components/schemas/ApiError409"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"409","schemaId":"components/schemas/ApiError409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError409"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/post-orders"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Get order.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/orders/get-orders-id","routeSlug":"/api/aryeo/orders/get-orders-id","metadata":{"seo":{"title":"Get order.","description":"Get order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-orders-id","name":"Get order.","isWebhook":false,"pointer":"/paths/~1orders~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_132","description":"Comma separated list of optional data to include in the response."}],"pointer":"/paths/~1orders~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{order_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[{"name":"include","in":"query","example":"items,listing,customer,appointments,appointments.users,unconfirmed_appointments,order_form,discounts,discounts.coupon","schemaId":"schema_132"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/orders/{order_id}","href":"orders/get-orders-id","openApiOperationId":"get-orders-id","summary":"Get order."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}},"schemaId":"components/schemas/OrderResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get-orders-id"}],"panels":[]}]},"httpPath":"/orders/{order_id}"},{"label":"Create a manual order payment.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/orders/orders-order-payments-post","routeSlug":"/api/aryeo/orders/orders-order-payments-post","metadata":{"seo":{"title":"Create a manual order payment.","description":"Create a manual order payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orders-order-payments-post","name":"Create a manual order payment.","isWebhook":false,"pointer":"/paths/~1orders~1{order}~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a manual order payment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a manual order payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order}~1payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138","pointer":"/paths/~1orders~1{order}~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{order}/payments","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_138"}},"responseCodes":["201","404","422","500"],"pointer":"/orders/{order}/payments","href":"orders/orders-order-payments-post","openApiOperationId":"orders-order-payments-post","summary":"Create a manual order payment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_138"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResource"}},"schemaId":"components/schemas/PaymentResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order}~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/orders-order-payments-post"}],"panels":[]}]},"httpPath":"/orders/{order}/payments"},{"label":"Update order billing address.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/orders/orders-order-billing-address-put","routeSlug":"/api/aryeo/orders/orders-order-billing-address-put","metadata":{"seo":{"title":"Update order billing address.","description":"Update order billing address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orders-order-billing-address-put","name":"Update order billing address.","isWebhook":false,"pointer":"/paths/~1orders~1{order}~1billing-address/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update order billing address.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update order billing address."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order}~1billing-address/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderBillingAddressPutPayload"}},"schemaId":"components/schemas/OrderBillingAddressPutPayload","pointer":"/paths/~1orders~1{order}~1billing-address/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/{order}/billing-address","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderBillingAddressPutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/orders/{order}/billing-address","href":"orders/orders-order-billing-address-put","openApiOperationId":"orders-order-billing-address-put","summary":"Update order billing address."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/OrderBillingAddressPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderBillingAddressPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}},"schemaId":"components/schemas/OrderResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order}~1billing-address/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/orders-order-billing-address-put"}],"panels":[]}]},"httpPath":"/orders/{order}/billing-address"},{"label":"Get payment information an order.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/orders/orders-order-payment-info-get","routeSlug":"/api/aryeo/orders/orders-order-payment-info-get","metadata":{"seo":{"title":"Get payment information an order.","description":"Get payment information an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orders-order-payment-info-get","name":"Get payment information an order.","isWebhook":false,"pointer":"/paths/~1orders~1{order}~1payment-info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment information an order.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get payment information an order."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order}~1payment-info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{order}/payment-info","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404","422","500"],"pointer":"/orders/{order}/payment-info","href":"orders/orders-order-payment-info-get","openApiOperationId":"orders-order-payment-info-get","summary":"Get payment information an order."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"PaymentInfoResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInfoResource"}},"schemaId":"components/schemas/PaymentInfoResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order}~1payment-info/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentInfoResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInfoResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/orders-order-payment-info-get"}],"panels":[]}]},"httpPath":"/orders/{order}/payment-info"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to orders. Orders are the service orders from customers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders","summary":"List orders.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get-orders","deprecated":false},{"title":"/orders","summary":"Create order.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/post-orders","deprecated":false},{"title":"/orders/{order_id}","summary":"Get order.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get-orders-id","deprecated":false},{"title":"/orders/{order}/payments","summary":"Create a manual order payment.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/orders-order-payments-post","deprecated":false},{"title":"/orders/{order}/billing-address","summary":"Update order billing address.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/orders-order-billing-address-put","deprecated":false},{"title":"/orders/{order}/payment-info","summary":"Get payment information an order.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/orders-order-payment-info-get","deprecated":false}]}]}]}]}},{"type":"group","label":"Payroll","link":"/api/aryeo/payroll","routeSlug":"/api/aryeo/payroll","items":[{"label":"Create billing setup intent.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/payroll/billing-setup-intents-post","routeSlug":"/api/aryeo/payroll/billing-setup-intents-post","metadata":{"seo":{"title":"Create billing setup intent.","description":"Create billing setup intent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"billing-setup-intents-post","name":"Create billing setup intent.","isWebhook":false,"pointer":"/paths/~1billing~1setup-intents/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create billing setup intent.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create billing setup intent."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billing/setup-intents","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422","500"],"pointer":"/billing/setup-intents","href":"payroll/billing-setup-intents-post","openApiOperationId":"billing-setup-intents-post","summary":"Create billing setup intent."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SetupIntentResponse","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SetupIntentResponse"}},"schemaId":"components/schemas/SetupIntentResponse"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1billing~1setup-intents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SetupIntentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SetupIntentResponse"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payroll/billing-setup-intents-post"}],"panels":[]}]},"httpPath":"/billing/setup-intents"},{"label":"List order item pay run item defaults.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/payroll/order-items-order-item-id-pay-run-item-defaults-get","routeSlug":"/api/aryeo/payroll/order-items-order-item-id-pay-run-item-defaults-get","metadata":{"seo":{"title":"List order item pay run item defaults.","description":"List order item pay run item defaults."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"order-items-order-item-id-pay-run-item-defaults-get","name":"List order item pay run item defaults.","isWebhook":false,"pointer":"/paths/~1order-items~1{order_item_id}~1pay-run-item-defaults/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List order item pay run item defaults.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List order item pay run item defaults."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_item_id","in":"path","schemaId":"schema_80","description":"The ID of an order item. UUID Version 4.","required":true}],"pointer":"/paths/~1order-items~1{order_item_id}~1pay-run-item-defaults/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/order-items/{order_item_id}/pay-run-item-defaults","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_item_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/order-items/{order_item_id}/pay-run-item-defaults","href":"payroll/order-items-order-item-id-pay-run-item-defaults-get","openApiOperationId":"order-items-order-item-id-pay-run-item-defaults-get","summary":"List order item pay run item defaults."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderItemPayRunItemDefaults","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemPayRunItemDefaults"}},"schemaId":"components/schemas/OrderItemPayRunItemDefaults"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1order-items~1{order_item_id}~1pay-run-item-defaults/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemPayRunItemDefaults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemPayRunItemDefaults"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payroll/order-items-order-item-id-pay-run-item-defaults-get"}],"panels":[]}]},"httpPath":"/order-items/{order_item_id}/pay-run-item-defaults"}],"content":{"contentType":"group","meta":{"name":"Payroll"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payroll","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to payroll."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billing/setup-intents","summary":"Create billing setup intent.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payroll/billing-setup-intents-post","deprecated":false},{"title":"/order-items/{order_item_id}/pay-run-item-defaults","summary":"List order item pay run item defaults.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payroll/order-items-order-item-id-pay-run-item-defaults-get","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/api/aryeo/products","routeSlug":"/api/aryeo/products","items":[{"label":"List products.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/products/get-products","routeSlug":"/api/aryeo/products/get-products","metadata":{"seo":{"title":"List products.","description":"List products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-products","name":"List products.","isWebhook":false,"pointer":"/paths/~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List products.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List products."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_88","description":"The number of items per page. Defaults to 25."},{"name":"page","in":"query","schemaId":"schema_89","description":"The requested page. Defaults to 1."},{"name":"filter[search]","in":"query","schemaId":"schema_139","description":"Return products that have fields matching this term."},{"name":"filter[include_inactive]","in":"query","schemaId":"schema_98","description":"Include inactive products (in addition to active products) when returning products."},{"name":"filter[category_ids][]","in":"query","schemaId":"schema_140","description":"Return products in the given categories."},{"name":"filter[type]","in":"query","schemaId":"schema_141","description":"Return products matching the given type. Allowed values are: MAIN, ADDON."},{"name":"filter[always_display_addons]","in":"query","schemaId":"schema_98","description":"Return products that always display addons."},{"name":"filter[main_product_ids][]","in":"query","schemaId":"schema_142","description":"Return products that are associated with the given main products."}],"pointer":"/paths/~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","example":"-created_at","schemaId":"schema_87"},{"name":"per_page","in":"query","example":"25","schemaId":"schema_88"},{"name":"page","in":"query","example":"2","schemaId":"schema_89"},{"name":"filter[search]","in":"query","example":"Photography","schemaId":"schema_139"},{"name":"filter[include_inactive]","in":"query","example":true,"schemaId":"schema_98"},{"name":"filter[category_ids][]","in":"query","schemaId":"schema_140"},{"name":"filter[type]","in":"query","example":"MAIN","schemaId":"schema_141"},{"name":"filter[always_display_addons]","in":"query","example":true,"schemaId":"schema_98"},{"name":"filter[main_product_ids][]","in":"query","schemaId":"schema_142"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/products","href":"products/get-products","openApiOperationId":"get-products","summary":"List products."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ProductCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCollection"}},"schemaId":"components/schemas/ProductCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/get-products"}],"panels":[]}]},"httpPath":"/products"},{"label":"List product categories.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/products/get-product-categories","routeSlug":"/api/aryeo/products/get-product-categories","metadata":{"seo":{"title":"List product categories.","description":"List product categories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-product-categories","name":"List product categories.","isWebhook":false,"pointer":"/paths/~1product-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product categories.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List product categories."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sort","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_88","description":"The number of items per page. Defaults to 25."},{"name":"page","in":"query","schemaId":"schema_89","description":"The requested page. Defaults to 1."},{"name":"filter[search]","in":"query","schemaId":"schema_139","description":"Return product categories that have fields matching this term."}],"pointer":"/paths/~1product-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/product-categories","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"sort","in":"query","example":"-created_at","schemaId":"schema_87"},{"name":"per_page","in":"query","example":"25","schemaId":"schema_88"},{"name":"page","in":"query","example":"2","schemaId":"schema_89"},{"name":"filter[search]","in":"query","example":"Photography","schemaId":"schema_139"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/product-categories","href":"products/get-product-categories","openApiOperationId":"get-product-categories","summary":"List product categories."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ProductCategoryCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategoryCollection"}},"schemaId":"components/schemas/ProductCategoryCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1product-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductCategoryCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductCategoryCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/get-product-categories"}],"panels":[]}]},"httpPath":"/product-categories"},{"label":"Create tax.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/products/post-taxes","routeSlug":"/api/aryeo/products/post-taxes","metadata":{"seo":{"title":"Create tax.","description":"Create tax."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-taxes","name":"Create tax.","isWebhook":false,"pointer":"/paths/~1taxes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create tax.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create tax."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxPostPayload"}},"schemaId":"components/schemas/TaxPostPayload","pointer":"/paths/~1taxes/post/requestBody","description":"TaxPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/taxes","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaxPostPayload"}},"responseCodes":["201","403","404","422","500"],"pointer":"/taxes","href":"products/post-taxes","openApiOperationId":"post-taxes","summary":"Create tax."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TaxPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaxPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"TaxResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxResource"}},"schemaId":"components/schemas/TaxResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1taxes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TaxResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaxResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/post-taxes"}],"panels":[]}]},"httpPath":"/taxes"},{"label":"Delete tax.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/products/delete-taxes-tax-id","routeSlug":"/api/aryeo/products/delete-taxes-tax-id","metadata":{"seo":{"title":"Delete tax.","description":"Delete tax."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-taxes-tax-id","name":"Delete tax.","isWebhook":false,"pointer":"/paths/~1taxes~1{tax_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tax.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete tax."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tax_id","in":"path","schemaId":"schema_80","description":"The ID of a tax. UUID Version 4.","required":true}],"pointer":"/paths/~1taxes~1{tax_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/taxes/{tax_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"tax_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","403","404","422","500"],"pointer":"/taxes/{tax_id}","href":"products/delete-taxes-tax-id","openApiOperationId":"delete-taxes-tax-id","summary":"Delete tax."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1taxes~1{tax_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/delete-taxes-tax-id"}],"panels":[]}]},"httpPath":"/taxes/{tax_id}"},{"label":"List territories.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/products/get-territories","routeSlug":"/api/aryeo/products/get-territories","metadata":{"seo":{"title":"List territories.","description":"List territories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-territories","name":"List territories.","isWebhook":false,"pointer":"/paths/~1territories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List territories.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List territories."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[address_id]","in":"query","schemaId":"schema_113","description":"An address ID. When set, only territories that contain this address within their bounds are returned."}],"pointer":"/paths/~1territories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/territories","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"filter[address_id]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_113"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/territories","href":"products/get-territories","openApiOperationId":"get-territories","summary":"List territories."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TerritoryCollection"}},"schemaId":"components/schemas/TerritoryCollection"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1territories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TerritoryCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TerritoryCollection"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/get-territories"}],"panels":[]}]},"httpPath":"/territories"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to products. Products consist of the categories and offerings for services and products."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/products","summary":"List products.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get-products","deprecated":false},{"title":"/product-categories","summary":"List product categories.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get-product-categories","deprecated":false},{"title":"/taxes","summary":"Create tax.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/post-taxes","deprecated":false},{"title":"/taxes/{tax_id}","summary":"Delete tax.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/delete-taxes-tax-id","deprecated":false},{"title":"/territories","summary":"List territories.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get-territories","deprecated":false}]}]}]}]}},{"type":"group","label":"Scheduling","link":"/api/aryeo/scheduling","routeSlug":"/api/aryeo/scheduling","items":[{"label":"Create block.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/blocks-post","routeSlug":"/api/aryeo/scheduling/blocks-post","metadata":{"seo":{"title":"Create block.","description":"Create block."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"blocks-post","name":"Create block.","isWebhook":false,"pointer":"/paths/~1blocks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create block.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create block."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlockPostPayload"}},"schemaId":"components/schemas/BlockPostPayload","pointer":"/paths/~1blocks/post/requestBody","description":"BlockPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/blocks","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BlockPostPayload"}},"responseCodes":["201","422","500"],"pointer":"/blocks","href":"scheduling/blocks-post","openApiOperationId":"blocks-post","summary":"Create block."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/BlockPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlockPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"CalendarEventResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarEventResource"}},"schemaId":"components/schemas/CalendarEventResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1blocks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CalendarEventResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarEventResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/blocks-post"}],"panels":[]}]},"httpPath":"/blocks"},{"label":"Delete block.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/blocks-block-id-delete","routeSlug":"/api/aryeo/scheduling/blocks-block-id-delete","metadata":{"seo":{"title":"Delete block.","description":"Delete block."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"blocks-block-id-delete","name":"Delete block.","isWebhook":false,"pointer":"/paths/~1blocks~1{block_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete block.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete block."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"block_id","in":"path","schemaId":"schema_80","description":"The ID of a block. UUID Version 4.","required":true}],"pointer":"/paths/~1blocks~1{block_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/blocks/{block_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"block_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","422","500"],"pointer":"/blocks/{block_id}","href":"scheduling/blocks-block-id-delete","openApiOperationId":"blocks-block-id-delete","summary":"Delete block."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1blocks~1{block_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/blocks-block-id-delete"}],"panels":[]}]},"httpPath":"/blocks/{block_id}"},{"label":"Get block.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/blocks-block-id-get","routeSlug":"/api/aryeo/scheduling/blocks-block-id-get","metadata":{"seo":{"title":"Get block.","description":"Get block."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"blocks-block-id-get","name":"Get block.","isWebhook":false,"pointer":"/paths/~1blocks~1{block_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get block.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get block."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"block_id","in":"path","schemaId":"schema_80","description":"The ID of a block. UUID Version 4.","required":true}],"pointer":"/paths/~1blocks~1{block_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/blocks/{block_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"block_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/blocks/{block_id}","href":"scheduling/blocks-block-id-get","openApiOperationId":"blocks-block-id-get","summary":"Get block."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CalendarBlockResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarBlockResource"}},"schemaId":"components/schemas/CalendarBlockResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1blocks~1{block_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CalendarBlockResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarBlockResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/blocks-block-id-get"}],"panels":[]}]},"httpPath":"/blocks/{block_id}"},{"label":"Update block.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/blocks-block-id-put","routeSlug":"/api/aryeo/scheduling/blocks-block-id-put","metadata":{"seo":{"title":"Update block.","description":"Update block."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"blocks-block-id-put","name":"Update block.","isWebhook":false,"pointer":"/paths/~1blocks~1{block_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update block.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update block."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"block_id","in":"path","schemaId":"schema_80","description":"The ID of a block. UUID Version 4.","required":true}],"pointer":"/paths/~1blocks~1{block_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/blocks/{block_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"block_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/blocks/{block_id}","href":"scheduling/blocks-block-id-put","openApiOperationId":"blocks-block-id-put","summary":"Update block."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CalendarEventResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarEventResource"}},"schemaId":"components/schemas/CalendarEventResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1blocks~1{block_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CalendarEventResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarEventResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/blocks-block-id-put"}],"panels":[]}]},"httpPath":"/blocks/{block_id}"},{"label":"List regions.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/regions-get","routeSlug":"/api/aryeo/scheduling/regions-get","metadata":{"seo":{"title":"List regions.","description":"List regions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"regions-get","name":"List regions.","isWebhook":false,"pointer":"/paths/~1regions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List regions.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List regions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[type]","in":"query","schemaId":"schema_143","description":"The type of the region."},{"name":"filter[country_code]","in":"query","schemaId":"schema_144","description":"The country code of the region."},{"name":"filter[state_code]","in":"query","schemaId":"schema_145","description":"The state code of the region."},{"name":"per_page","in":"query","schemaId":"schema_88","description":"The number of items per page. Defaults to 25."},{"name":"page","in":"query","schemaId":"schema_89","description":"The requested page. Defaults to 1."}],"pointer":"/paths/~1regions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/regions","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"filter[type]","in":"query","required":false,"example":"COUNTRY","schemaId":"schema_143"},{"name":"filter[country_code]","in":"query","required":false,"example":"US","schemaId":"schema_144"},{"name":"filter[state_code]","in":"query","required":false,"example":"CA","schemaId":"schema_145"},{"name":"per_page","in":"query","example":"25","schemaId":"schema_88"},{"name":"page","in":"query","example":"2","schemaId":"schema_89"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/regions","href":"scheduling/regions-get","openApiOperationId":"regions-get","summary":"List regions."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"RegionCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionCollection"}},"schemaId":"components/schemas/RegionCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1regions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegionCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegionCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/regions-get"}],"panels":[]}]},"httpPath":"/regions"},{"label":"Get scheduling assignment.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/scheduling-assignment-get","routeSlug":"/api/aryeo/scheduling/scheduling-assignment-get","metadata":{"seo":{"title":"Get scheduling assignment.","description":"Get scheduling assignment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scheduling-assignment-get","name":"Get scheduling assignment.","isWebhook":false,"pointer":"/paths/~1scheduling~1assignment/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get scheduling assignment.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get scheduling assignment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"order_id","in":"query","schemaId":"schema_146","description":"The ID of an order. UUID Version 4."},{"name":"company_team_member_ids","in":"query","schemaId":"schema_147","description":"The IDs of company team members. UUID Version 4."},{"name":"strategy_type","in":"query","schemaId":"schema_148","description":"The strategy type to use for the scheduling assignment."},{"name":"appointment_date","in":"query","schemaId":"schema_149","description":"The date of the appointment."},{"name":"appointment_duration","in":"query","schemaId":"schema_150","description":"The duration of the appointment in minutes."}],"pointer":"/paths/~1scheduling~1assignment/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scheduling/assignment","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"order_id","in":"query","required":false,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_146"},{"name":"company_team_member_ids","in":"query","required":false,"schemaId":"schema_147"},{"name":"strategy_type","in":"query","required":false,"example":"DISTANCE","schemaId":"schema_148"},{"name":"appointment_date","in":"query","required":false,"example":"2020-01-05T12:00:00Z","schemaId":"schema_149"},{"name":"appointment_duration","in":"query","required":false,"example":60,"schemaId":"schema_150"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/scheduling/assignment","href":"scheduling/scheduling-assignment-get","openApiOperationId":"scheduling-assignment-get","summary":"Get scheduling assignment."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CompanyTeamMemberResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyTeamMemberResource"}},"schemaId":"components/schemas/CompanyTeamMemberResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1scheduling~1assignment/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyTeamMemberResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyTeamMemberResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/scheduling-assignment-get"}],"panels":[]}]},"httpPath":"/scheduling/assignment"},{"label":"List available dates.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/get-available-dates","routeSlug":"/api/aryeo/scheduling/get-available-dates","metadata":{"seo":{"title":"List available dates.","description":"List available dates. Availability can be listed using a specific start & end date range, or using a timeframe. When using a timeframe, the page parameter can be used to flip through weeks, months, etc."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-available-dates","name":"List available dates.","isWebhook":false,"pointer":"/paths/~1scheduling~1available-dates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available dates.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List available dates. Availability can be listed using a specific start & end date range, or using a timeframe. When using a timeframe, the page parameter can be used to flip through weeks, months, etc."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[user_ids][]","in":"query","schemaId":"schema_86","description":"The IDs of users whose availability will be listed. UUID Version 4."},{"name":"filter[appointment_id]","in":"query","schemaId":"schema_151","description":"Appointment ID used to list availability for an existing order"},{"name":"filter[start_at]","in":"query","schemaId":"schema_84","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns availability after start_at"},"children":[]}]}]}]},{"name":"filter[end_at]","in":"query","schemaId":"schema_85","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns availability before end_at"},"children":[]}]}]}]},{"name":"filter[timeframe]","in":"query","schemaId":"schema_152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns availability for a specific timeframe. Used instead of start_at & end_at"},"children":[]}]}]}]},{"name":"duration","in":"query","schemaId":"schema_91","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the event to schedule. Required if appointment_id isn't specified"},"children":[]}]}]}]},{"name":"interval","in":"query","schemaId":"schema_153","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interval of bookable timeslots starting at x minutes on the hour . Required if appointment_id isn't specified"},"children":[]}]}]}]},{"name":"timezone","in":"query","schemaId":"schema_154","description":"The timezone of the client. Available dates results will be localized to this timezone","required":true},{"name":"page","in":"query","schemaId":"schema_104","description":"The requested page of results. Use this parameter to flip through pages when using the timeframe filter"},{"name":"per_page","in":"query","schemaId":"schema_155","description":"The number of results per page. Only applies when using a date range"}],"pointer":"/paths/~1scheduling~1available-dates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scheduling/available-dates","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"filter[user_ids][]","in":"query","schemaId":"schema_86"},{"name":"filter[appointment_id]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_151"},{"name":"filter[start_at]","in":"query","example":"2021-01-01T13:00:00Z","schemaId":"schema_84"},{"name":"filter[end_at]","in":"query","example":"2021-01-02T13:00:00Z","schemaId":"schema_85"},{"name":"filter[timeframe]","in":"query","example":"MONTH","schemaId":"schema_152"},{"name":"duration","in":"query","example":60,"schemaId":"schema_91"},{"name":"interval","in":"query","example":15,"schemaId":"schema_153"},{"name":"timezone","in":"query","required":true,"example":"CST","schemaId":"schema_154"},{"name":"page","in":"query","example":1,"schemaId":"schema_104"},{"name":"per_page","in":"query","example":5,"schemaId":"schema_155"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/scheduling/available-dates","href":"scheduling/get-available-dates","openApiOperationId":"get-available-dates","summary":"List available dates."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CalendarDayCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarDayCollection"}},"schemaId":"components/schemas/CalendarDayCollection"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1scheduling~1available-dates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CalendarDayCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalendarDayCollection"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/get-available-dates"}],"panels":[]}]},"httpPath":"/scheduling/available-dates"},{"label":"List available timeslots.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/get-available-timeslots","routeSlug":"/api/aryeo/scheduling/get-available-timeslots","metadata":{"seo":{"title":"List available timeslots.","description":"List available timeslots. Timeslots are returned for the entire day in the local timezone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-available-timeslots","name":"List available timeslots.","isWebhook":false,"pointer":"/paths/~1scheduling~1available-timeslots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available timeslots.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List available timeslots. Timeslots are returned for the entire day in the local timezone. \n\nResults are returned in UTC!"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[user_ids][]","in":"query","schemaId":"schema_86","description":"The IDs of users whose appointments will be listed. UUID Version 4."},{"name":"filter[appointment_id]","in":"query","schemaId":"schema_151","description":"Appointment ID used to list availability for an existing order"},{"name":"duration","in":"query","schemaId":"schema_91","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of the event to schedule. Required if appointment_id isn't specified"},"children":[]}]}]}]},{"name":"interval","in":"query","schemaId":"schema_156","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interval of bookable timeslots starting at x minutes on the hour . Required if appointment_id isn't specified"},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_104","description":"The requested page of results"},{"name":"per_page","in":"query","schemaId":"schema_157","description":"The number of results per page. Only applies when using a date range"},{"name":"date","in":"query","schemaId":"schema_158","description":"The date to list available timeslots","required":true},{"name":"timezone","in":"query","schemaId":"schema_154","description":"The timezone is used to determine the start and end time of the specified date to list a full day of results.","required":true}],"pointer":"/paths/~1scheduling~1available-timeslots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scheduling/available-timeslots","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"filter[user_ids][]","in":"query","schemaId":"schema_86"},{"name":"filter[appointment_id]","in":"query","example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_151"},{"name":"duration","in":"query","example":60,"schemaId":"schema_91"},{"name":"interval","in":"query","example":25,"schemaId":"schema_156"},{"name":"page","in":"query","example":1,"schemaId":"schema_104"},{"name":"per_page","in":"query","example":5,"schemaId":"schema_157"},{"name":"date","in":"query","required":true,"example":"2021-01-01","schemaId":"schema_158"},{"name":"timezone","in":"query","required":true,"example":"CST","schemaId":"schema_154"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/scheduling/available-timeslots","href":"scheduling/get-available-timeslots","openApiOperationId":"get-available-timeslots","summary":"List available timeslots."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"TimeslotCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeslotCollection"}},"schemaId":"components/schemas/TimeslotCollection"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1scheduling~1available-timeslots/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TimeslotCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeslotCollection"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/get-available-timeslots"}],"panels":[]}]},"httpPath":"/scheduling/available-timeslots"},{"label":"List schedule item groupings.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/scheduling/scheduling-item-groupings-get","routeSlug":"/api/aryeo/scheduling/scheduling-item-groupings-get","metadata":{"seo":{"title":"List schedule item groupings.","description":"List schedule item groupings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scheduling-item-groupings-get","name":"List schedule item groupings.","isWebhook":false,"pointer":"/paths/~1scheduling~1item-groupings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List schedule item groupings.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List schedule item groupings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"item_ids","in":"query","schemaId":"schema_147","description":"The IDs of the items to group.","required":true},{"name":"appointment_id","in":"query","schemaId":"schema_146","description":"The ID of the appointment to group."}],"pointer":"/paths/~1scheduling~1item-groupings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/scheduling/item-groupings","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"item_ids","in":"query","required":true,"schemaId":"schema_147"},{"name":"appointment_id","in":"query","required":false,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_146"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/scheduling/item-groupings","href":"scheduling/scheduling-item-groupings-get","openApiOperationId":"scheduling-item-groupings-get","summary":"List schedule item groupings."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderItemGroupingCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemGroupingCollection"}},"schemaId":"components/schemas/OrderItemGroupingCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1scheduling~1item-groupings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemGroupingCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemGroupingCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scheduling/scheduling-item-groupings-get"}],"panels":[]}]},"httpPath":"/scheduling/item-groupings"}],"content":{"contentType":"group","meta":{"name":"Scheduling"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scheduling","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to scheduling. Scheduling operations provide information about service provider availability."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/blocks","summary":"Create block.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scheduling/blocks-post","deprecated":false},{"title":"/blocks/{block_id}","summary":"Delete block.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/scheduling/blocks-block-id-delete","deprecated":false},{"title":"/blocks/{block_id}","summary":"Get block.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scheduling/blocks-block-id-get","deprecated":false},{"title":"/blocks/{block_id}","summary":"Update block.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/scheduling/blocks-block-id-put","deprecated":false},{"title":"/regions","summary":"List regions.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scheduling/regions-get","deprecated":false},{"title":"/scheduling/assignment","summary":"Get scheduling assignment.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scheduling/scheduling-assignment-get","deprecated":false},{"title":"/scheduling/available-dates","summary":"List available dates.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scheduling/get-available-dates","deprecated":false},{"title":"/scheduling/available-timeslots","summary":"List available timeslots.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scheduling/get-available-timeslots","deprecated":false},{"title":"/scheduling/item-groupings","summary":"List schedule item groupings.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scheduling/scheduling-item-groupings-get","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/api/aryeo/tags","routeSlug":"/api/aryeo/tags","items":[{"label":"Create customer team tag.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/customer-teams-customer-team-id-tags-post","routeSlug":"/api/aryeo/tags/customer-teams-customer-team-id-tags-post","metadata":{"seo":{"title":"Create customer team tag.","description":"Create customer team tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-teams-customer-team-id-tags-post","name":"Create customer team tag.","isWebhook":false,"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create customer team tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create customer team tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_team_id","in":"path","schemaId":"schema_80","description":"The ID of a customer team. UUID Version 4.","required":true}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPostPayload"}},"schemaId":"components/schemas/TagsPostPayload","pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customer-teams/{customer_team_id}/tags","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"customer_team_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagsPostPayload"}},"responseCodes":["200","422","500"],"pointer":"/customer-teams/{customer_team_id}/tags","href":"tags/customer-teams-customer-team-id-tags-post","openApiOperationId":"customer-teams-customer-team-id-tags-post","summary":"Create customer team tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TagsPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CustomerTeamResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTeamResource"}},"schemaId":"components/schemas/CustomerTeamResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerTeamResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerTeamResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/customer-teams-customer-team-id-tags-post"}],"panels":[]}]},"httpPath":"/customer-teams/{customer_team_id}/tags"},{"label":"Update customer team tag.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/customer-teams-customer-team-id-tags-put","routeSlug":"/api/aryeo/tags/customer-teams-customer-team-id-tags-put","metadata":{"seo":{"title":"Update customer team tag.","description":"Update customer team tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-teams-customer-team-id-tags-put","name":"Update customer team tag.","isWebhook":false,"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update customer team tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update customer team tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_team_id","in":"path","schemaId":"schema_80","description":"The ID of a customer team. UUID Version 4.","required":true}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"schemaId":"components/schemas/TagsPutPayload","pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/customer-teams/{customer_team_id}/tags","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"customer_team_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/customer-teams/{customer_team_id}/tags","href":"tags/customer-teams-customer-team-id-tags-put","openApiOperationId":"customer-teams-customer-team-id-tags-put","summary":"Update customer team tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TagsPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/customer-teams-customer-team-id-tags-put"}],"panels":[]}]},"httpPath":"/customer-teams/{customer_team_id}/tags"},{"label":"Delete customer team tag.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/customer-teams-customer-team-id-tags-tag-id-delete","routeSlug":"/api/aryeo/tags/customer-teams-customer-team-id-tags-tag-id-delete","metadata":{"seo":{"title":"Delete customer team tag.","description":"Delete customer team tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customer-teams-customer-team-id-tags-tag-id-delete","name":"Delete customer team tag.","isWebhook":false,"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags~1{tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete customer team tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete customer team tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_team_id","in":"path","schemaId":"schema_80","description":"The ID of a customer team. UUID Version 4.","required":true},{"name":"tag_id","in":"path","schemaId":"schema_80","description":"The ID of a tag. UUID Version 4.","required":true}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags~1{tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customer-teams/{customer_team_id}/tags/{tag_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"customer_team_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"},{"name":"tag_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","422","500"],"pointer":"/customer-teams/{customer_team_id}/tags/{tag_id}","href":"tags/customer-teams-customer-team-id-tags-tag-id-delete","openApiOperationId":"customer-teams-customer-team-id-tags-tag-id-delete","summary":"Delete customer team tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"204"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1customer-teams~1{customer_team_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/customer-teams-customer-team-id-tags-tag-id-delete"}],"panels":[]}]},"httpPath":"/customer-teams/{customer_team_id}/tags/{tag_id}"},{"label":"Create tag for order.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/orders-order-id-tags-post","routeSlug":"/api/aryeo/tags/orders-order-id-tags-post","metadata":{"seo":{"title":"Create tag for order.","description":"Create tag for order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orders-order-id-tags-post","name":"Create tag for order.","isWebhook":false,"pointer":"/paths/~1orders~1{order_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create tag for order.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create tag for order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderTagsPostPayload"}},"schemaId":"components/schemas/OrderTagsPostPayload","pointer":"/paths/~1orders~1{order_id}~1tags/post/requestBody","description":"OrderTagsPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{order_id}/tags","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderTagsPostPayload"}},"responseCodes":["200","422","500"],"pointer":"/orders/{order_id}/tags","href":"tags/orders-order-id-tags-post","openApiOperationId":"orders-order-id-tags-post","summary":"Create tag for order."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/OrderTagsPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderTagsPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}},"schemaId":"components/schemas/OrderResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/orders-order-id-tags-post"}],"panels":[]}]},"httpPath":"/orders/{order_id}/tags"},{"label":"Update tag for order.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/put-order-tags-tag-id","routeSlug":"/api/aryeo/tags/put-order-tags-tag-id","metadata":{"seo":{"title":"Update tag for order.","description":"Update tag for order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-order-tags-tag-id","name":"Update tag for order.","isWebhook":false,"pointer":"/paths/~1orders~1{order_id}~1tags/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tag for order.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update tag for order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order_id}~1tags/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"schemaId":"components/schemas/TagsPutPayload","pointer":"/paths/~1orders~1{order_id}~1tags/put/requestBody","description":"TagsPutPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/{order_id}/tags","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"responseCodes":["200","403","404","422","500"],"pointer":"/orders/{order_id}/tags","href":"tags/put-order-tags-tag-id","openApiOperationId":"put-order-tags-tag-id","summary":"Update tag for order."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TagsPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OrderResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}},"schemaId":"components/schemas/OrderResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order_id}~1tags/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/put-order-tags-tag-id"}],"panels":[]}]},"httpPath":"/orders/{order_id}/tags"},{"label":"Delete tag for order.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/orders-order-id-tags-tag-id-delete","routeSlug":"/api/aryeo/tags/orders-order-id-tags-tag-id-delete","metadata":{"seo":{"title":"Delete tag for order.","description":"Delete tag for order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orders-order-id-tags-tag-id-delete","name":"Delete tag for order.","isWebhook":false,"pointer":"/paths/~1orders~1{order_id}~1tags~1{tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tag for order.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete tag for order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_id","in":"path","schemaId":"schema_80","description":"The ID of an order. UUID Version 4.","required":true},{"name":"tag_id","in":"path","schemaId":"schema_80","description":"The ID of a tag. UUID Version 4.","required":true}],"pointer":"/paths/~1orders~1{order_id}~1tags~1{tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orders/{order_id}/tags/{tag_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"order_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"},{"name":"tag_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","422","500"],"pointer":"/orders/{order_id}/tags/{tag_id}","href":"tags/orders-order-id-tags-tag-id-delete","openApiOperationId":"orders-order-id-tags-tag-id-delete","summary":"Delete tag for order."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"204"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1orders~1{order_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/orders-order-id-tags-tag-id-delete"}],"panels":[]}]},"httpPath":"/orders/{order_id}/tags/{tag_id}"},{"label":"Create tag.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/post-products-product-id-tags","routeSlug":"/api/aryeo/tags/post-products-product-id-tags","metadata":{"seo":{"title":"Create tag.","description":"Create tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-products-product-id-tags","name":"Create tag.","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_80","description":"The ID of a product. UUID Version 4.","required":true}],"pointer":"/paths/~1products~1{product_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPostPayload"}},"schemaId":"components/schemas/TagsPostPayload","pointer":"/paths/~1products~1{product_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{product_id}/tags","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagsPostPayload"}},"responseCodes":["200","422","500"],"pointer":"/products/{product_id}/tags","href":"tags/post-products-product-id-tags","openApiOperationId":"post-products-product-id-tags","summary":"Create tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TagsPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ProductResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductResource"}},"schemaId":"components/schemas/ProductResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1products~1{product_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/post-products-product-id-tags"}],"panels":[]}]},"httpPath":"/products/{product_id}/tags"},{"label":"Update product tag.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/put-products-product-id-tags","routeSlug":"/api/aryeo/tags/put-products-product-id-tags","metadata":{"seo":{"title":"Update product tag.","description":"Update product tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-products-product-id-tags","name":"Update product tag.","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1tags/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update product tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update product tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_80","description":"The ID of a product. UUID Version 4.","required":true}],"pointer":"/paths/~1products~1{product_id}~1tags/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"schemaId":"components/schemas/TagsPutPayload","pointer":"/paths/~1products~1{product_id}~1tags/put/requestBody","description":"TagsPutPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/products/{product_id}/tags","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/products/{product_id}/tags","href":"tags/put-products-product-id-tags","openApiOperationId":"put-products-product-id-tags","summary":"Update product tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TagsPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ProductResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductResource"}},"schemaId":"components/schemas/ProductResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1products~1{product_id}~1tags/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/put-products-product-id-tags"}],"panels":[]}]},"httpPath":"/products/{product_id}/tags"},{"label":"Update tag.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/put-products-product-id-tags-tag-id","routeSlug":"/api/aryeo/tags/put-products-product-id-tags-tag-id","metadata":{"seo":{"title":"Update tag.","description":"Update tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-products-product-id-tags-tag-id","name":"Update tag.","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1tags~1{tag_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_80","description":"The ID of a product. UUID Version 4.","required":true},{"name":"tag_id","in":"path","schemaId":"schema_80","description":"The ID of a tag.","required":true}],"pointer":"/paths/~1products~1{product_id}~1tags~1{tag_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"schemaId":"components/schemas/TagsPutPayload","pointer":"/paths/~1products~1{product_id}~1tags~1{tag_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/products/{product_id}/tags/{tag_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"},{"name":"tag_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/products/{product_id}/tags/{tag_id}","href":"tags/put-products-product-id-tags-tag-id","openApiOperationId":"put-products-product-id-tags-tag-id","summary":"Update tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TagsPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagsPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ProductResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductResource"}},"schemaId":"components/schemas/ProductResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1products~1{product_id}~1tags~1{tag_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/put-products-product-id-tags-tag-id"}],"panels":[]}]},"httpPath":"/products/{product_id}/tags/{tag_id}"},{"label":"Delete product tag.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/delete-products-product-id-tags-tag-id","routeSlug":"/api/aryeo/tags/delete-products-product-id-tags-tag-id","metadata":{"seo":{"title":"Delete product tag.","description":"Delete product tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-products-product-id-tags-tag-id","name":"Delete product tag.","isWebhook":false,"pointer":"/paths/~1products~1{product_id}~1tags~1{tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete product tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete product tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product_id","in":"path","schemaId":"schema_80","description":"The ID of a product. UUID Version 4.","required":true},{"name":"tag_id","in":"path","schemaId":"schema_80","description":"The ID of a tag.","required":true}],"pointer":"/paths/~1products~1{product_id}~1tags~1{tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/products/{product_id}/tags/{tag_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"product_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"},{"name":"tag_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","422","500"],"pointer":"/products/{product_id}/tags/{tag_id}","href":"tags/delete-products-product-id-tags-tag-id","openApiOperationId":"delete-products-product-id-tags-tag-id","summary":"Delete product tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1products~1{product_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/delete-products-product-id-tags-tag-id"}],"panels":[]}]},"httpPath":"/products/{product_id}/tags/{tag_id}"},{"label":"Create tag.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/tags-post","routeSlug":"/api/aryeo/tags/tags-post","metadata":{"seo":{"title":"Create tag.","description":"Create tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tags-post","name":"Create tag.","isWebhook":false,"pointer":"/paths/~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagOnlyPostPayload"}},"schemaId":"components/schemas/TagOnlyPostPayload","pointer":"/paths/~1tags/post/requestBody","description":"TagOnlyPostPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tags","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagOnlyPostPayload"}},"responseCodes":["201","422","500"],"pointer":"/tags","href":"tags/tags-post","openApiOperationId":"tags-post","summary":"Create tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TagOnlyPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagOnlyPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagResource"}},"schemaId":"components/schemas/TagResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TagResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/tags-post"}],"panels":[]}]},"httpPath":"/tags"},{"label":"Update tag.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tags/tags-tag-id-put","routeSlug":"/api/aryeo/tags/tags-tag-id-put","metadata":{"seo":{"title":"Update tag.","description":"Update tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tags-tag-id-put","name":"Update tag.","isWebhook":false,"pointer":"/paths/~1tags~1{tag_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tag.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true,"x-undocumented":false}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tag_id","in":"path","schemaId":"schema_80","description":"The ID of a tag.","required":true}],"pointer":"/paths/~1tags~1{tag_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagPutPayload"}},"schemaId":"components/schemas/TagPutPayload","pointer":"/paths/~1tags~1{tag_id}/put/requestBody","description":"TagPutPayload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tags/{tag_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"tag_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagPutPayload"}},"responseCodes":["204","404","422","500"],"pointer":"/tags/{tag_id}","href":"tags/tags-tag-id-put","openApiOperationId":"tags-tag-id-put","summary":"Update tag."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TagPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"204"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tags~1{tag_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/tags-tag-id-put"}],"panels":[]}]},"httpPath":"/tags/{tag_id}"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to tags. Tags are used to organize and categorize content using a flexible tagging system."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customer-teams/{customer_team_id}/tags","summary":"Create customer team tag.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/customer-teams-customer-team-id-tags-post","deprecated":false},{"title":"/customer-teams/{customer_team_id}/tags","summary":"Update customer team tag.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/customer-teams-customer-team-id-tags-put","deprecated":false},{"title":"/customer-teams/{customer_team_id}/tags/{tag_id}","summary":"Delete customer team tag.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/customer-teams-customer-team-id-tags-tag-id-delete","deprecated":false},{"title":"/orders/{order_id}/tags","summary":"Create tag for order.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/orders-order-id-tags-post","deprecated":false},{"title":"/orders/{order_id}/tags","summary":"Update tag for order.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/put-order-tags-tag-id","deprecated":false},{"title":"/orders/{order_id}/tags/{tag_id}","summary":"Delete tag for order.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/orders-order-id-tags-tag-id-delete","deprecated":false},{"title":"/products/{product_id}/tags","summary":"Create tag.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/post-products-product-id-tags","deprecated":false},{"title":"/products/{product_id}/tags","summary":"Update product tag.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/put-products-product-id-tags","deprecated":false},{"title":"/products/{product_id}/tags/{tag_id}","summary":"Update tag.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/put-products-product-id-tags-tag-id","deprecated":false},{"title":"/products/{product_id}/tags/{tag_id}","summary":"Delete product tag.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/delete-products-product-id-tags-tag-id","deprecated":false},{"title":"/tags","summary":"Create tag.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/tags-post","deprecated":false},{"title":"/tags/{tag_id}","summary":"Update tag.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/tags-tag-id-put","deprecated":false}]}]}]}]}},{"type":"group","label":"Tasks","link":"/api/aryeo/tasks","routeSlug":"/api/aryeo/tasks","items":[{"label":"List tasks.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tasks/tasks-get","routeSlug":"/api/aryeo/tasks/tasks-get","metadata":{"seo":{"title":"List tasks.","description":"List tasks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks-get","name":"List tasks.","isWebhook":false,"pointer":"/paths/~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tasks.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List tasks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tasks","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/tasks","href":"tasks/tasks-get","openApiOperationId":"tasks-get","summary":"List tasks."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"TaskCollection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskCollection"}},"schemaId":"components/schemas/TaskCollection"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskCollection"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks-get"}],"panels":[]}]},"httpPath":"/tasks"},{"label":"Create task.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tasks/tasks-post","routeSlug":"/api/aryeo/tasks/tasks-post","metadata":{"seo":{"title":"Create task.","description":"Create task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks-post","name":"Create task.","isWebhook":false,"pointer":"/paths/~1tasks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create task.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskPostPayload"}},"schemaId":"components/schemas/TaskPostPayload","pointer":"/paths/~1tasks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tasks","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskPostPayload"}},"responseCodes":["201","422","500"],"pointer":"/tasks","href":"tasks/tasks-post","openApiOperationId":"tasks-post","summary":"Create task."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TaskPostPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskPostPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"TaskResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}},"schemaId":"components/schemas/TaskResource"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tasks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TaskResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks-post"}],"panels":[]}]},"httpPath":"/tasks"},{"label":"Delete task.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tasks/tasks-task-id-delete","routeSlug":"/api/aryeo/tasks/tasks-task-id-delete","metadata":{"seo":{"title":"Delete task.","description":"Delete task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks-task-id-delete","name":"Delete task.","isWebhook":false,"pointer":"/paths/~1tasks~1{task_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete task.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_80","description":"The ID of a task. UUID Version 4.","required":true}],"pointer":"/paths/~1tasks~1{task_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tasks/{task_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","422","500"],"pointer":"/tasks/{task_id}","href":"tasks/tasks-task-id-delete","openApiOperationId":"tasks-task-id-delete","summary":"Delete task."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tasks~1{task_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks-task-id-delete"}],"panels":[]}]},"httpPath":"/tasks/{task_id}"},{"label":"Get task.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tasks/tasks-task-id-get","routeSlug":"/api/aryeo/tasks/tasks-task-id-get","metadata":{"seo":{"title":"Get task.","description":"Get task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks-task-id-get","name":"Get task.","isWebhook":false,"pointer":"/paths/~1tasks~1{task_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get task.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_80","description":"The ID of a task. UUID Version 4.","required":true}],"pointer":"/paths/~1tasks~1{task_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tasks/{task_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422","500"],"pointer":"/tasks/{task_id}","href":"tasks/tasks-task-id-get","openApiOperationId":"tasks-task-id-get","summary":"Get task."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"TaskResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}},"schemaId":"components/schemas/TaskResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tasks~1{task_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks-task-id-get"}],"panels":[]}]},"httpPath":"/tasks/{task_id}"},{"label":"Update task.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tasks/tasks-task-id-put","routeSlug":"/api/aryeo/tasks/tasks-task-id-put","metadata":{"seo":{"title":"Update task.","description":"Update task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks-task-id-put","name":"Update task.","isWebhook":false,"pointer":"/paths/~1tasks~1{task_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update task.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_80","description":"The ID of a task. UUID Version 4.","required":true}],"pointer":"/paths/~1tasks~1{task_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskPutPayload"}},"schemaId":"components/schemas/TaskPutPayload","pointer":"/paths/~1tasks~1{task_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tasks/{task_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskPutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/tasks/{task_id}","href":"tasks/tasks-task-id-put","openApiOperationId":"tasks-task-id-put","summary":"Update task."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TaskPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"TaskResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}},"schemaId":"components/schemas/TaskResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tasks~1{task_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks-task-id-put"}],"panels":[]}]},"httpPath":"/tasks/{task_id}"},{"label":"Complete task.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tasks/tasks-task-id-complete-put","routeSlug":"/api/aryeo/tasks/tasks-task-id-complete-put","metadata":{"seo":{"title":"Complete task.","description":"Complete task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks-task-id-complete-put","name":"Complete task.","isWebhook":false,"pointer":"/paths/~1tasks~1{task_id}~1complete/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete task.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Complete task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_80","description":"The ID of a task. UUID Version 4.","required":true}],"pointer":"/paths/~1tasks~1{task_id}~1complete/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskCompletePutPayload"}},"schemaId":"components/schemas/TaskCompletePutPayload","pointer":"/paths/~1tasks~1{task_id}~1complete/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tasks/{task_id}/complete","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskCompletePutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/tasks/{task_id}/complete","href":"tasks/tasks-task-id-complete-put","openApiOperationId":"tasks-task-id-complete-put","summary":"Complete task."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TaskCompletePutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskCompletePutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"TaskResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}},"schemaId":"components/schemas/TaskResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tasks~1{task_id}~1complete/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks-task-id-complete-put"}],"panels":[]}]},"httpPath":"/tasks/{task_id}/complete"},{"label":"Reinstate task.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/tasks/tasks-task-id-reinstate-put","routeSlug":"/api/aryeo/tasks/tasks-task-id-reinstate-put","metadata":{"seo":{"title":"Reinstate task.","description":"Reinstate task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks-task-id-reinstate-put","name":"Reinstate task.","isWebhook":false,"pointer":"/paths/~1tasks~1{task_id}~1reinstate/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reinstate task.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-undocumented":false,"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reinstate task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_80","description":"The ID of a task. UUID Version 4.","required":true}],"pointer":"/paths/~1tasks~1{task_id}~1reinstate/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskReinstatePutPayload"}},"schemaId":"components/schemas/TaskReinstatePutPayload","pointer":"/paths/~1tasks~1{task_id}~1reinstate/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tasks/{task_id}/reinstate","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TaskReinstatePutPayload"}},"responseCodes":["200","404","422","500"],"pointer":"/tasks/{task_id}/reinstate","href":"tasks/tasks-task-id-reinstate-put","openApiOperationId":"tasks-task-id-reinstate-put","summary":"Reinstate task."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/TaskReinstatePutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TaskReinstatePutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"TaskResource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}},"schemaId":"components/schemas/TaskResource"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1tasks~1{task_id}~1reinstate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskResource"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks-task-id-reinstate-put"}],"panels":[]}]},"httpPath":"/tasks/{task_id}/reinstate"}],"content":{"contentType":"group","meta":{"name":"Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tasks","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to tasks. Tasks are used to track work items, assignments, and completion status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tasks","summary":"List tasks.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/tasks-get","deprecated":false},{"title":"/tasks","summary":"Create task.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/tasks-post","deprecated":false},{"title":"/tasks/{task_id}","summary":"Delete task.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tasks/tasks-task-id-delete","deprecated":false},{"title":"/tasks/{task_id}","summary":"Get task.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/tasks-task-id-get","deprecated":false},{"title":"/tasks/{task_id}","summary":"Update task.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/tasks-task-id-put","deprecated":false},{"title":"/tasks/{task_id}/complete","summary":"Complete task.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/tasks-task-id-complete-put","deprecated":false},{"title":"/tasks/{task_id}/reinstate","summary":"Reinstate task.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/tasks-task-id-reinstate-put","deprecated":false}]}]}]}]}},{"type":"group","label":"Videos","link":"/api/aryeo/videos","routeSlug":"/api/aryeo/videos","items":[{"label":"Get video.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/videos/get-videos-video-id","routeSlug":"/api/aryeo/videos/get-videos-video-id","metadata":{"seo":{"title":"Get video.","description":"Get video."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-videos-video-id","name":"Get video.","isWebhook":false,"pointer":"/paths/~1videos~1{video_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get video.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get video."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"video_id","in":"path","schemaId":"schema_80","description":"The ID of a video. UUID Version 4.","required":true}],"pointer":"/paths/~1videos~1{video_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/videos/{video_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"video_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","403","404","422","500"],"pointer":"/videos/{video_id}","href":"videos/get-videos-video-id","openApiOperationId":"get-videos-video-id","summary":"Get video."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoResource"}},"schemaId":"components/schemas/VideoResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1videos~1{video_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VideoResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/videos/get-videos-video-id"}],"panels":[]}]},"httpPath":"/videos/{video_id}"},{"label":"Update video.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/videos/put-videos-video-id","routeSlug":"/api/aryeo/videos/put-videos-video-id","metadata":{"seo":{"title":"Update video.","description":"Update video."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-videos-video-id","name":"Update video.","isWebhook":false,"pointer":"/paths/~1videos~1{video_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update video.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update video."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"video_id","in":"path","schemaId":"schema_80","description":"The ID of a video. UUID Version 4.","required":true}],"pointer":"/paths/~1videos~1{video_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VideoPutPayload"}},"schemaId":"components/schemas/VideoPutPayload","pointer":"/paths/~1videos~1{video_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/videos/{video_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"video_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VideoPutPayload"}},"responseCodes":["200","403","404","422","500"],"pointer":"/videos/{video_id}","href":"videos/put-videos-video-id","openApiOperationId":"put-videos-video-id","summary":"Update video."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"schemaId":"components/schemas/VideoPutPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VideoPutPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoResource"}},"schemaId":"components/schemas/VideoResource"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1videos~1{video_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VideoResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoResource"}}},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/videos/put-videos-video-id"}],"panels":[]}]},"httpPath":"/videos/{video_id}"},{"label":"Delete video.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/aryeo/videos/delete-videos-video-id","routeSlug":"/api/aryeo/videos/delete-videos-video-id","metadata":{"seo":{"title":"Delete video.","description":"Delete video."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-videos-video-id","name":"Delete video.","isWebhook":false,"pointer":"/paths/~1videos~1{video_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete video.","isWebhook":false,"showPageActions":true},{"nodeType":"extensions","extensions":{"x-external":true}}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete video."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"video_id","in":"path","schemaId":"schema_80","description":"The ID of a video. UUID Version 4.","required":true}],"pointer":"/paths/~1videos~1{video_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/videos/{video_id}","servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"parameters":{"path":[{"name":"video_id","in":"path","required":true,"example":"00000000-0000-4000-8000-000000000000","schemaId":"schema_80"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","403","404","422","500"],"pointer":"/videos/{video_id}","href":"videos/delete-videos-video-id","openApiOperationId":"delete-videos-video-id","summary":"Delete video."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api/aryeo","description":"Mock server","isMockServer":true},{"url":"https://api.aryeo.com/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"403","description":"ApiError403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}},"schemaId":"components/schemas/ApiError403"},{"code":"404","description":"ApiError404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}},"schemaId":"components/schemas/ApiError404"},{"code":"422","description":"ApiFail422","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}},"schemaId":"components/schemas/ApiFail422"},{"code":"500","description":"ApiError500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}},"schemaId":"components/schemas/ApiError500"}],"pointer":"/paths/~1videos~1{video_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ApiError403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError403"}}},{"code":"404","schemaId":"components/schemas/ApiError404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError404"}}},{"code":"422","schemaId":"components/schemas/ApiFail422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFail422"}}},{"code":"500","schemaId":"components/schemas/ApiError500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/videos/delete-videos-video-id"}],"panels":[]}]},"httpPath":"/videos/{video_id}"}],"content":{"contentType":"group","meta":{"name":"Videos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Videos","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to videos."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/videos/{video_id}","summary":"Get video.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/videos/get-videos-video-id","deprecated":false},{"title":"/videos/{video_id}","summary":"Update video.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/videos/put-videos-video-id","deprecated":false},{"title":"/videos/{video_id}","summary":"Delete video.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/videos/delete-videos-video-id","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/SsoProvider":{"id":"components/schemas/SsoProvider","kind":"json-schema","title":"SsoProvider","data":{"type":"object","title":"SsoProvider","description":"A SSO Provider contains the information pertaining to the SSO connection.","properties":{"name":{"type":"string","minLength":0,"maxLength":255,"description":"Name of the provider","example":"Some Company"},"provider":{"type":"string","minLength":0,"maxLength":255,"description":"Technology of the provider","example":"Auth0"}},"required":["name","provider"],"additionalProperties":false}},"components/schemas/SsoUser":{"id":"components/schemas/SsoUser","kind":"json-schema","title":"SsoUser","data":{"type":"object","title":"SsoUser","description":"A SSO User contains the information pertaining to a users SSO account.","properties":{"sso_id":{"type":"string","minLength":0,"maxLength":255,"description":"SSO ID of the user","example":"1234"},"sso_provider":{"$ref":"#/components/schemas/SsoProvider"}},"required":["sso_id"],"additionalProperties":false}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":["object","null"],"title":"User","description":"A record of a person on the Aryeo platform.","properties":{"object":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"PERSONAL_ACCESS_TOKEN"},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"email":{"type":"string","format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"Email address of the user."},"first_name":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"John","description":"First name of the user."},"last_name":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"Doe","description":"Last name of the user."},"full_name":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"John Doe","description":"The full name of the user."},"internal_notes":{"type":["string","null"],"example":"Internal notes for the user.","minLength":0,"maxLength":65535,"description":"Internal notes for the user."},"status":{"type":"string","minLength":0,"maxLength":255,"enum":["active","inactive","new","sso"],"example":"active","description":"The status of the user."},"phone":{"type":["string","null"],"example":"123456789","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens)."},"children":[]}]}]}],"minLength":0,"maxLength":255},"avatar_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/300","description":"The avatar image URL of a user.","minLength":0,"maxLength":255},"relationship":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"owner","description":"Describes user's relationship (access level) to a specified group. Only returned if this resource is returned as a sub-resource of a group."},"sso_users":{"type":"array","description":"The list of SSO users associated with this user.","items":{"$ref":"#/components/schemas/SsoUser"}},"is_super":{"type":["boolean","null"],"example":true,"description":"Indicates if the user is a super user."},"verification_status":{"type":"string","description":"The verification status of the user.","minLength":0,"maxLength":255,"example":"verified","enum":["verified","unverified","new","sso"]},"password_expiration_days":{"type":["integer","null"],"description":"The number of days until the user's password expires.","example":30},"timezone":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The default timezone for the user.","example":"America/New_York"},"created_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the user was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["id","email"],"additionalProperties":false}},"components/schemas/FeatureFlags":{"id":"components/schemas/FeatureFlags","kind":"json-schema","title":"FeatureFlags","data":{"type":["array","null"],"description":"An array of feature flags for the group.","items":{"type":"string","description":"The name of the feature flag.","example":"customer_teams_order_form_landing_page_override","minLength":1,"maxLength":65535,"enum":["alternate_unbranded_property_site_url","avalara_tax_syncing","avalara_taxes","byop","calendar_event_title_modified","custom_field_uploads","customer_teams_order_form_landing_page_override","customer_teams_product_preselect","customer_teams_external_payments","customer_portal_mobile_app_automated_screenshots","database_external_calendar_events","default_reschedule_toggle_false","idp_migration_in_progress","listings_3_beta","marketing_kits","max_travel_distance","min_hour_targets","order_form_categories","require_photographer_confirmations","showcase_order_form_visibility_designations","team_member_restrictions","team_member_hide_customer_pii","virtual_staging_ai_v2","virtual_staging_ai_v2_pricing","virtuals1_custom_sms_notification_messages","quickbooks_app","webhooks","zillow_3d_home","zillow_streeteasy","zillow_rentals"]},"additionalProperties":false}},"components/schemas/SocialProfiles":{"id":"components/schemas/SocialProfiles","kind":"json-schema","title":"SocialProfiles","data":{"title":"SocialProfiles","type":["object","null"],"description":"External profile URLs for an agent or brokerage group.","properties":{"facebook_profile_url":{"type":["string","null"],"description":"URL for Facebook.","minLength":0,"maxLength":65535,"example":"https://www.facebook.com/johndoe","format":"uri"},"instagram_profile_url":{"type":["string","null"],"description":"URL for Instagram.","minLength":0,"maxLength":65535,"example":"https://www.instagram.com/johndoe","format":"uri"},"twitter_profile_url":{"type":["string","null"],"description":"URL for Twitter.","minLength":0,"maxLength":65535,"example":"https://twitter.com/johndoe","format":"uri"},"linkedin_profile_url":{"type":["string","null"],"description":"URL for LinkedIn.","minLength":0,"maxLength":65535,"example":"https://www.linkedin.com/in/johndoe/","format":"uri"},"zillow_profile_url":{"type":["string","null"],"description":"URL for Zillow.","minLength":0,"maxLength":65535,"example":"https://www.zillow.com/profile/johndoe","format":"uri"}},"additionalProperties":false}},"components/schemas/Group":{"id":"components/schemas/Group","kind":"json-schema","title":"Group","data":{"type":"object","title":"Group","description":"A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.","properties":{"object":{"type":"string","minLength":5,"maxLength":5,"enum":["GROUP"],"example":"GROUP","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"type":{"type":"string","example":"AGENT","description":"The type of the group. Can be CREATOR, AGENT, or BROKERAGE, and may dictate the attributes of the group returned.","minLength":0,"maxLength":255,"enum":["CREATOR","AGENT","BROKERAGE"]},"name":{"type":"string","maxLength":255,"minLength":0,"description":"The name of the group.","example":"John Doe Reality"},"email":{"type":["string","null"],"format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"The email address of a group."},"phone":{"type":["string","null"],"example":"6175550173","minLength":0,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A phone number represented in whichever standards specified by the group, typically ###-###-#### (separated by hyphens)."},"children":[]}]}]}]},"website_url":{"type":["string","null"],"example":"https://www.aryeo.com","minLength":0,"maxLength":255,"description":"The website URL of a group.","format":"uri"},"logo_url":{"type":["string","null"],"description":"The logo URL of a group.","format":"uri","minLength":0,"maxLength":255,"example":"https://picsum.photos/300"},"office_name":{"type":["string","null"],"example":"John Doe Brokerage","minLength":0,"maxLength":255,"description":"The name of the brokerage or team of a real estate agent. Only returned if group's type is AGENT."},"license_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"12345678","description":"The license number of a real estate agent. Only returned if group's type is AGENT."},"timezone":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The default timezone for the group.","example":"America/New_York"},"currency":{"type":"string","minLength":0,"maxLength":255,"example":"USD","description":"The default currency for the group.","enum":["USD","CAD","GBP","CHF","EUR","AUD","NZD","ZAR","DKK"]},"slug":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The slug for the group.","example":"example-photography"},"order_page_url":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The order page URL for the group.","example":"https://example-photography.aryeo.com/order"},"feature_flags":{"$ref":"#/components/schemas/FeatureFlags"},"order_page_background_color":{"type":["string","null"],"maxLength":7,"minLength":7,"description":"The background color for the order page (has a hex value) for the group.","example":"#FF0000"},"social_profiles":{"$ref":"#/components/schemas/SocialProfiles"},"default_order_form":{"$ref":"#/components/schemas/OrderForm"},"use_territory_awareness":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default uses territories to filter available users and products."},"availability_style":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"TIME","description":"The scheduling style the order form should use for timeslot selection by default.","enum":["TIME","TIME_OF_DAY","LEGACY"]},"slot_interval_minutes":{"type":["integer","null"],"example":60,"description":"How frequently slotted available times are on the order form by default."},"use_automated_user_assignment":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form uses auto-assignment of users to appointments."},"automated_user_assignment_strategy":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"RECOMMENDED","description":"The default assignment strategy the order form should use to assign users to appointments, if applicable.","enum":["RECOMMENDED","HOURS_PRIORITY","DISTANCE","ROUND_ROBIN","PRIORITY_LIST"]},"show_user_names":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default should display user's names after they have been assigned to an appointment."},"use_instant_appointment_scheduling":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default instantly schedules appointments as soon as the order is placed."},"allow_order_cancellation":{"type":["boolean","null"],"example":true,"description":"If the group is a company, then this indicates if company allows customers to cancel orders or order items."},"order_forms":{"type":["array","null"],"description":"An array of order forms a vendor group provides for placing orders. Only returned if group's type is CREATOR. ","items":{"$ref":"#/components/schemas/OrderForm"}},"owner":{"$ref":"#/components/schemas/User"},"users":{"type":["array","null"],"description":"The Aryeo users associated with this group.","items":{"$ref":"#/components/schemas/User"}},"is_brokerage_or_brokerage_agent":{"type":["boolean","null"],"example":true,"description":"Indicates if the group is a brokerage or brokerage agent."},"avatar_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/300","description":"The avatar image URL of a user.","minLength":0,"maxLength":255},"internal_notes":{"type":["string","null"],"description":"Internal notes about the group.","minLength":0,"maxLength":2550,"example":"Internal notes about the group."},"team_members":{"type":["array","null"],"description":"NOTE: Users do not have team members.","items":{"$ref":"#/components/schemas/User"}},"customer_group":{"type":["string","null"],"description":"NOTE: Users do not have customer groups and they are deprecated.","minLength":0,"maxLength":2550,"example":"null"},"custom_field_entries":{"type":["array","null"],"description":"NOTE: Need to make a migration plan for this.","items":{"type":"object","description":"Custom field entries for the group.","additionalProperties":false}},"created_at":{"type":["string","null"],"description":"The date and time the group was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"has_restricted_photographers":{"type":["boolean","null"],"description":"Whether the group is restricted from booking appointments with certain photographers.","example":true},"is_payroll_enabled":{"type":["boolean","null"],"description":"Indicates if the group has payroll enabled.","example":true},"is_visible":{"type":["boolean","null"],"description":"Indicates if the group is visible.","example":true},"order_index":{"type":["integer","null"],"description":"The order index of the group.","example":1}},"required":["id","type","name"],"additionalProperties":false}},"components/schemas/OrderForm":{"id":"components/schemas/OrderForm","kind":"json-schema","title":"OrderForm","data":{"title":"OrderForm","type":"object","description":"An order form is a form that is used to submit an order.","properties":{"object":{"type":"string","minLength":10,"maxLength":10,"enum":["ORDER_FORM"],"example":"ORDER_FORM","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"title":{"type":"string","minLength":0,"maxLength":255,"example":"BQ's Photography Order Form","description":"The title or name of the order form."},"type":{"type":"string","description":"The type of the order form, indicating whether the order form is an Aryeo order form or that of another scheduling service provider.","enum":["ARYEO","EXTERNAL"],"minLength":0,"maxLength":255,"example":"ARYEO"},"url":{"type":"string","format":"uri","minLength":0,"maxLength":255,"example":"https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000","description":"A URL of a publicly-accessible webpage for this order form."},"is_public":{"type":"boolean","example":true,"description":"Indicates if the order form is publicly visible to all customers on the order form page"},"thumbnail_url":{"type":["string","null"],"description":"A thumbnail image URL for the order form.","minLength":0,"maxLength":65535,"example":"https://picsum.photos/300","format":"uri"},"use_territory_awareness":{"type":"boolean","example":true,"description":"Indicates if the order form is uses territories to filter available users and products."},"availability_style":{"type":"string","minLength":0,"maxLength":255,"example":"TIME","description":"The scheduling style the order form should use to for timeslot selection.","enum":["TIME","TIME_OF_DAY","LEGACY","DATETIME_PICKER"]},"slot_interval_minutes":{"type":"integer","example":60,"description":"How frequently slotted available times are on the order form."},"use_automated_user_assignment":{"type":"boolean","example":true,"description":"Indicates if the order form users auto-assignment of users to appointments."},"automated_user_assignment_strategy":{"type":"string","minLength":0,"maxLength":255,"example":"RECOMMENDED","description":"The assignment strategy the order form should use to assign users to appointments, if applicable.","enum":["RECOMMENDED","HOURS_PRIORITY","DISTANCE","ROUND_ROBIN","PRIORITY_LIST"]},"show_user_names":{"type":"boolean","example":true,"description":"Indicates if the order form should display user's names after they have been assigned to an appointment."},"require_upfront_payment":{"type":"boolean","example":true,"description":"Indicates if the order form requires an upfront payment to place the order. "},"upfront_payment_percentage":{"type":["integer","null"],"example":50,"description":"The percentage of the order form's total price that should be paid upfront."},"use_instant_appointment_scheduling":{"type":"boolean","example":true,"description":"Indicates if the order form instantly schedules appointments as soon as the order is placed."},"form_settings":{"type":"object","description":"The settings for the order form.","additionalProperties":true},"owner":{"$ref":"#/components/schemas/Group"},"company":{"$ref":"#/components/schemas/Group"}},"required":["id","title","type","url"],"additionalProperties":false}},"components/schemas/Activity":{"id":"components/schemas/Activity","kind":"json-schema","title":"Activity","data":{"title":"Activity","type":"object","description":"An event tracked for the purposes of analytics.","properties":{"object":{"type":"string","description":"String representing type. Objects of the same type share the same schema.","example":"ACTIVITY","minLength":1,"maxLength":100},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":["string","null"],"description":"A title describing the activity.","example":"Appointment Update","minLength":0,"maxLength":65536},"name":{"type":"string","description":"The name of the activity.","example":"ORDER_MEDIA_DOWNLOADED","minLength":0,"maxLength":65536,"enum":["USER_LOGGED_IN","USER_LOGGED_OUT","USER_REGISTERED","ORDER_FEE_CREATED","ORDER_FEE_DELETED","ORDER_MEDIA_DOWNLOADED","ORDER_PLACED","ORDER_RECEIVED","ORDER_CREATED","ORDER_VIEWED","ORDER_REFUNDED","ORDER_PAYMENT_COMPLETED","ORDER_PAYMENT_DELETED","ORDER_PAYMENT_ENTERED","ORDER_ATTACHED_TO_LISTING","ORDER_SYNCED_TO_QUICKBOOKS","ORDER_SYNC_TO_QUICKBOOKS_FAILED","ORDER_PAYMENT_SYNCED_TO_QUICKBOOKS","APPOINTMENT_ACCEPTED","APPOINTMENT_DECLINED","APPOINTMENT_SCHEDULED","APPOINTMENT_REQUESTED","APPOINTMENT_RESCHEDULED","APPOINTMENT_POSTPONED","APPOINTMENT_CANCELED","APPOINTMENT_ASSIGNED","APPOINTMENT_UNASSIGNED","APPOINTMENT_CREATOR_REMINDER_SENT","APPOINTMENT_CUSTOMER_REMINDER_SENT","LISTING_CREATED","LISTING_UPDATED","LISTING_DELIVERED","LISTING_CONTENT_DOWNLOADED","LISTING_VIEWED","MARKETING_MATERIAL_CREATED","NOTIFICATION_SENT","CUSTOMER_TEAM_CREATED","CUSTOMER_TEAM_ARCHIVED","CUSTOMER_TEAM_PRICING_PLAN_APPLIED","CUSTOMER_TEAM_PRICING_PLAN_REMOVED","CUSTOMER_TEAM_INTERNAL_NOTE_UPDATED","CUSTOMER_TEAM_PRESELECTED_PRODUCTS_UPDATED","CUSTOMER_TEAM_DOWNLOAD_SETTINGS_UPDATED","CUSTOMER_TEAM_BILLING_TEAM_MEMBERSHIP_UPDATED","CUSTOMER_TEAM_BILLING_TEAM_MEMBERSHIP_REMOVED","CUSTOMER_TEAM_PRICE_OVERRIDES_UPDATED","CUSTOMER_TEAM_MEMBERSHIP_CREATED","CUSTOMER_TEAM_MEMBERSHIP_ARCHIVED","CUSTOMER_TEAM_MEMBERSHIP_DELETED","CUSTOMER_TEAM_MEMBERSHIP_REACTIVATED","CUSTOMER_TEAM_MEMBERSHIP_INVITATION_ACCEPTED","CUSTOMER_TEAM_MEMBERSHIP_REVOKED","DEFAULT_CUSTOMER_TEAM_MEMBERSHIP_ADDED","DEFAULT_CUSTOMER_TEAM_MEMBERSHIP_REMOVED","MEDIA_REQUEST_CREATED","MEDIA_REQUEST_CANCELED","MEDIA_REQUEST_ACCEPTED","MEDIA_REQUEST_ASSIGNED","MEDIA_REQUEST_DECLINED","MEDIA_REQUEST_DELIVERED","MEDIA_REQUEST_TRANSFERRED"]},"description":{"type":"string","description":"The description of the activity.","example":"Branick Weix has downloaded 34 images, 2 videos, and 1 floor plan from 123 Main St.","minLength":0,"maxLength":65536},"source":{"type":"string","minLength":1,"maxLength":255,"enum":["ANDROID","ANDROID_ARYEO_GO","API","IOS","IOS_ARYEO_GO","WEB"],"example":"API","description":"The source of the activity."},"occurred_at":{"type":"string","description":"The date and time (ISO 8601 format) when the activity was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"payload":{"type":"object","description":"A generic payload containing metadata about the activity.","additionalProperties":true},"html_payload":{"type":["object","null"],"description":"A generic payload, HTML format, containing metadata about the activity.","additionalProperties":true},"system_activity":{"type":"boolean","description":"Whether the activity was generated by the system.","example":true},"target_url":{"type":["string","null"],"description":"The URL of the target of the activity.","example":"https://www.aryeo.com/orders/123/edit","minLength":0,"maxLength":65536},"target_label":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The label to use to describe the target_url link."},"children":[]}]}]}],"example":"View Order","minLength":0,"maxLength":65536},"acting_user":{"$ref":"#/components/schemas/User"},"acting_group":{"$ref":"#/components/schemas/Group"},"group":{"$ref":"#/components/schemas/Group"},"resource":{"type":"object","description":"A resource related to the activity.","additionalProperties":true}},"additionalProperties":false,"required":["id","name","description","source","occurred_at"]}},"components/schemas/PaginationLink":{"id":"components/schemas/PaginationLink","kind":"json-schema","title":"PageLink","data":{"type":"object","title":"PageLink","description":"A page link.","properties":{"url":{"type":["string","null"],"description":"The URL of the page.","example":"https://admin.aryeo.test/api/v1/companies?page=2","minLength":1,"maxLength":65535},"label":{"type":"string","description":"The label of the page.","example":"2","minLength":1,"maxLength":65535},"active":{"type":"boolean","description":"Whether the page is active.","example":true},"page":{"type":["integer","null"],"description":"The page number this link points to.","example":2}},"required":["url","label","active"],"additionalProperties":false}},"components/schemas/PaginationMeta":{"id":"components/schemas/PaginationMeta","kind":"json-schema","title":"PaginationMeta","data":{"title":"PaginationMeta","type":"object","description":"Metadata about a paginated response.","properties":{"total":{"type":"integer","description":"Total number of records.","example":50},"per_page":{"type":"integer","description":"Number of records per page.","example":15},"current_page":{"type":"integer","description":"The current page.","example":1},"last_page":{"type":"integer","description":"The last page of records.","example":4},"from":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the first record on this page. This is specified as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand."},"children":[]}]}]}],"example":1},"to":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the last record on this page. This is specified as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand."},"children":[]}]}]}],"example":15},"path":{"type":"string","description":"The current paged path.","example":"https://api.aryeo.com/v1/{path}","minLength":1,"maxLength":65535},"links":{"type":["array","null"],"description":"Links.","items":{"$ref":"#/components/schemas/PaginationLink"}}},"required":["total","per_page","current_page","last_page","path"],"additionalProperties":false}},"components/schemas/PaginationLinks":{"id":"components/schemas/PaginationLinks","kind":"json-schema","title":"PaginationLinks","data":{"title":"PaginationLinks","type":"object","description":"Related links for a paginated response.","properties":{"first":{"type":"string","description":"The first page.","example":"https://api.aryeo.com/v1/{path}?page=1","minLength":1,"maxLength":65535},"last":{"type":"string","description":"The last page.","example":"https://api.aryeo.com/v1/{path}?page=10","minLength":1,"maxLength":65535},"prev":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The previous page. This is specified as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand."},"children":[]}]}]}],"example":"https://api.aryeo.com/v1/{path}?page=2","minLength":1,"maxLength":65535},"next":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The next page. This is specified as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand."},"children":[]}]}]}],"example":"https://api.aryeo.com/v1/{path}?page=3","minLength":1,"maxLength":65535}},"required":["first","last"],"additionalProperties":false}},"components/schemas/ActivityCollection":{"id":"components/schemas/ActivityCollection","kind":"json-schema","title":"ActivityCollection","data":{"title":"ActivityCollection","type":"object","description":"A collection of activities.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Activity"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"additionalProperties":false,"required":["status"]}},"components/schemas/ApiError404":{"id":"components/schemas/ApiError404","kind":"json-schema","title":"ApiError404","data":{"type":"object","title":"ApiError404","description":"A not found error returned by the API.","properties":{"status":{"type":"string","example":"error","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"message":{"type":"string","description":"The error message.","example":"{ApiError message.}","minLength":0,"maxLength":255},"code":{"type":["integer","null"],"description":"A numeric code corresponding to the error.","example":404}},"required":["status","message"],"additionalProperties":false}},"components/schemas/ApiFail422":{"id":"components/schemas/ApiFail422","kind":"json-schema","title":"ApiFail422","data":{"type":"object","title":"ApiFail422","description":"A processing or validation failure returned by the API.","properties":{"status":{"type":"string","example":"fail","minLength":0,"maxLength":255,"description":"What was the state of the request?"}},"required":["status"],"additionalProperties":false}},"components/schemas/ApiError500":{"id":"components/schemas/ApiError500","kind":"json-schema","title":"ApiError500","data":{"type":"object","title":"ApiError500","description":"An internal server error returned by the API.","properties":{"status":{"type":"string","example":"error","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"message":{"type":"string","description":"The error message.","example":"{ApiError message.}","minLength":0,"maxLength":255},"code":{"type":["integer","null"],"description":"A numeric code corresponding to the error.","example":500}},"required":["status","message"],"additionalProperties":false}},"components/schemas/ActivityPostPayload":{"id":"components/schemas/ActivityPostPayload","kind":"json-schema","title":"ActivityPostPayload","data":{"title":"ActivityPostPayload","type":"object","properties":{"name":{"type":"string","description":"The name of the activity.","example":"ORDER_MEDIA_DOWNLOADED","minLength":0,"maxLength":65536,"enum":["USER_LOGGED_IN","USER_LOGGED_OUT","USER_REGISTERED","ORDER_MEDIA_DOWNLOADED","ORDER_PLACED","ORDER_VIEWED"]},"description":{"type":"string","description":"The description of the activity.","example":"Branick Weix has downloaded 34 images, 2 videos, and 1 floor plan from 123 Main St.","minLength":0,"maxLength":65536},"source":{"type":"string","minLength":1,"maxLength":255,"enum":["WEB","IOS","API"],"example":"API","description":"The source of the activity."},"group_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of a group. UUID Version 4.","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"user_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of a user. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"payload":{"type":"object","description":"A generic payload containing metadata about the activity.","additionalProperties":true},"resource_type":{"type":"string","minLength":1,"maxLength":255,"enum":["LISTING","ORDER"],"example":"LISTING","description":"The resource type that corresponds to the activity."},"resource_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the corresponding resource. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"additionalProperties":false,"required":["name","description","source","group_id","user_id"]}},"components/schemas/ActivityResource":{"id":"components/schemas/ActivityResource","kind":"json-schema","title":"ActivityResource","data":{"title":"ActivityResource","type":"object","description":"An activity.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Activity"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"additionalProperties":false,"required":["status"]}},"components/schemas/ApiError403":{"id":"components/schemas/ApiError403","kind":"json-schema","title":"ApiError403","data":{"type":"object","title":"ApiError403","description":"A forbidden error returned by the API.","properties":{"status":{"type":"string","example":"error","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"message":{"type":"string","description":"The error message.","example":"{ApiError message.}","minLength":0,"maxLength":255},"code":{"type":["integer","null"],"description":"A numeric code corresponding to the error.","example":403}},"required":["status","message"],"additionalProperties":false}},"components/schemas/AddressPostPayload":{"id":"components/schemas/AddressPostPayload","kind":"json-schema","title":"AddressPostPayload","data":{"title":"AddressPostPayload","type":"object","properties":{"latitude":{"type":["number","null"],"description":"The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":42.35157458574123,"minimum":-180,"maximum":180},"longitude":{"type":["number","null"],"description":"The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":-71.05763741484657,"maximum":180,"minimum":-180},"street_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"107","description":"The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'."},"street_name":{"type":["string","null"],"description":"The street name portion of a location's address.","minLength":0,"maxLength":255,"example":"South St"},"unit_number":{"type":["string","null"],"description":"The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.","minLength":0,"maxLength":255,"example":"Unit 2F"},"postal_code":{"type":["string","null"],"description":"The postal code portion of a location's address.","example":"02111","minLength":0,"maxLength":255},"city":{"type":["string","null"],"description":"The city of a location's address.","example":"Boston","minLength":0,"maxLength":255},"city_region":{"type":["string","null"],"description":"A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.","minLength":0,"maxLength":255,"example":"Leather District"},"county_or_parish":{"type":["string","null"],"description":"The County, Parish or other regional authority of the location.","minLength":0,"maxLength":255,"example":"Suffolk County"},"state_or_province":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States."},"children":[]}]}]}],"minLength":0,"maxLength":255,"example":"MA"},"state_or_province_region":{"type":["string","null"],"description":"A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.","minLength":0,"maxLength":255,"example":"Cape Cod"},"country":{"type":["string","null"],"description":"The ISO 3166-1 country code for this for the country of the location.","minLength":0,"maxLength":255,"example":"US"},"country_region":{"type":["string","null"],"description":"A sub-section or area of a defined country. Examples would be Napa Valley in the US, or the Amalfi Coast in Italy.","example":"Napa Valley","minLength":0,"maxLength":255}},"required":["latitude","longitude"],"additionalProperties":false}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"title":"Address","type":"object","description":"A street address and additional metadata about a location.","properties":{"id":{"type":"string","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"latitude":{"type":["number","null"],"description":"The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":42.35157458574123,"minimum":-180,"maximum":180},"longitude":{"type":["number","null"],"description":"The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":-71.05763741484657,"maximum":180,"minimum":-180},"street_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"107","description":"The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'."},"street_name":{"type":["string","null"],"description":"The street name portion of a location's address.","minLength":0,"maxLength":255,"example":"South St"},"unit_number":{"type":["string","null"],"description":"The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.","minLength":0,"maxLength":255,"example":"Unit 2F"},"postal_code":{"type":["string","null"],"description":"The postal code portion of a location's address.","example":"02111","minLength":0,"maxLength":255},"city":{"type":["string","null"],"description":"The city of a location's address.","example":"Boston","minLength":0,"maxLength":255},"city_region":{"type":["string","null"],"description":"A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.","minLength":0,"maxLength":255,"example":"Leather District"},"county_or_parish":{"type":["string","null"],"description":"The County, Parish or other regional authority of the location.","minLength":0,"maxLength":255,"example":"Suffolk County"},"state_or_province":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States."},"children":[]}]}]}],"minLength":0,"maxLength":255,"example":"MA"},"state_or_province_region":{"type":["string","null"],"description":"A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.","minLength":0,"maxLength":255,"example":"Cape Cod"},"country":{"type":["string","null"],"description":"The ISO 3166-1 country code for this for the country of the location.","minLength":0,"maxLength":255,"example":"US"},"country_region":{"type":["string","null"],"description":"A sub-section or area of a defined country. Examples would be Napa Valley in the US, or the Amalfi Coast in Italy.","example":"Napa Valley","minLength":0,"maxLength":255},"timezone":{"type":["string","null"],"description":"The assumed timezone the address is located in.","minLength":0,"maxLength":255,"example":"America/New_York"},"unparsed_address":{"type":["string","null"],"description":"Unparsed text representation of the address. ","example":"107 South St, Boston MA, 02111","minLength":0,"maxLength":255},"unparsed_address_part_one":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"Unparsed text representation of the first part of the address, typically including the street number, street name, and unit number if applicable.  ","example":"107 South St, Unit 2F"},"unparsed_address_part_two":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"Unparsed text representation of the second part of the address, typically including the city, state or province, and postal code.  ","example":"Boston, MA 02111"},"is_map_dirty":{"type":["boolean","null"],"example":true,"description":"Does this address need to be geocoded?"}},"additionalProperties":false,"required":["id"]}},"components/schemas/AddressResource":{"id":"components/schemas/AddressResource","kind":"json-schema","title":"AddressResource","data":{"title":"AddressResource","type":"object","description":"An address.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Address"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/AddressPatchPayload":{"id":"components/schemas/AddressPatchPayload","kind":"json-schema","title":"AddressPatchPayload","data":{"title":"AddressPatchPayload","type":"object","properties":{"latitude":{"type":["number","null"],"description":"The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":42.35157458574123,"minimum":-180,"maximum":180},"longitude":{"type":["number","null"],"description":"The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":-71.05763741484657,"maximum":180,"minimum":-180},"street_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"107","description":"The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'."},"street_name":{"type":["string","null"],"description":"The street name portion of a location's address.","minLength":0,"maxLength":255,"example":"South St"},"unit_number":{"type":["string","null"],"description":"The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.","minLength":0,"maxLength":255,"example":"Unit 2F"},"postal_code":{"type":["string","null"],"description":"The postal code portion of a location's address.","example":"02111","minLength":0,"maxLength":255},"city":{"type":["string","null"],"description":"The city of a location's address.","example":"Boston","minLength":0,"maxLength":255},"city_region":{"type":["string","null"],"description":"A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.","minLength":0,"maxLength":255,"example":"Leather District"},"county_or_parish":{"type":["string","null"],"description":"The County, Parish or other regional authority of the location.","minLength":0,"maxLength":255,"example":"Suffolk County"},"state_or_province":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States."},"children":[]}]}]}],"minLength":0,"maxLength":255,"example":"MA"},"state_or_province_region":{"type":["string","null"],"description":"A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.","minLength":0,"maxLength":255,"example":"Cape Cod"},"country":{"type":["string","null"],"description":"The ISO 3166-1 country code for this for the country of the location.","minLength":0,"maxLength":255,"example":"US"},"country_region":{"type":["string","null"],"description":"A sub-section or area of a defined country. Examples would be Napa Valley in the US, or the Amalfi Coast in Italy.","example":"Napa Valley","minLength":0,"maxLength":255},"external_type":{"type":["string","null"],"description":"The type of external ID for the address.","enum":["GOOGLE"],"minLength":0,"maxLength":255},"external_id":{"type":["string","null"],"description":"The external ID for the address.","example":"1234567890","minLength":0,"maxLength":255},"external_url":{"type":["string","null"],"description":"The URL for the address.","example":"https://www.google.com","minLength":0,"maxLength":255},"external_data":{"type":["array","null"],"description":"The external data for the address.","items":{"type":"object","description":"A key-value pair of custom field data.","additionalProperties":false}},"is_map_dirty":{"type":["boolean","null"],"description":"Does this address need to be geocoded?","example":true}},"additionalProperties":false}},"components/schemas/AddressPredictionResult":{"id":"components/schemas/AddressPredictionResult","kind":"json-schema","title":"AddressPredictionResult","data":{"title":"AddressPredictionResult","type":"object","description":"Prediction result for an address.","properties":{"external_type":{"type":["string","null"],"description":"The type of external ID for the address.","enum":["GOOGLE"],"minLength":0,"maxLength":255},"external_id":{"type":["string","null"],"description":"The external ID for the address.","example":"1234567890","minLength":0,"maxLength":255},"unparsed_address":{"type":["string","null"],"description":"Unparsed text representation of the address. ","example":"107 South St, Boston MA, 02111","minLength":0,"maxLength":255},"unparsed_address_part_one":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"Unparsed text representation of the first part of the address, typically including the street number, street name, and unit number if applicable.  ","example":"107 South St, Unit 2F"},"unparsed_address_part_two":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"Unparsed text representation of the second part of the address, typically including the city, state or province, and postal code.  ","example":"Boston, MA 02111"}},"additionalProperties":false,"required":["external_type","external_id","unparsed_address","unparsed_address_part_one","unparsed_address_part_two"]}},"components/schemas/AddressPredictionResultCollection":{"id":"components/schemas/AddressPredictionResultCollection","kind":"json-schema","title":"AddressExternalCollection","data":{"title":"AddressExternalCollection","type":"object","description":"A collection of external data for addresses.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/AddressPredictionResult"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"additionalProperties":false,"required":["status"]}},"components/schemas/AddressSearchResult":{"id":"components/schemas/AddressSearchResult","kind":"json-schema","title":"AddressSearchResult","data":{"title":"AddressSearchResult","type":"object","description":"Search result for an address.","properties":{"latitude":{"type":["number","null"],"description":"The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":42.35157458574123,"minimum":-180,"maximum":180},"longitude":{"type":["number","null"],"description":"The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":-71.05763741484657,"maximum":180,"minimum":-180},"street_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"107","description":"The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'."},"street_name":{"type":["string","null"],"description":"The street name portion of a location's address.","minLength":0,"maxLength":255,"example":"South St"},"unit_number":{"type":["string","null"],"description":"The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.","minLength":0,"maxLength":255,"example":"Unit 2F"},"postal_code":{"type":["string","null"],"description":"The postal code portion of a location's address.","example":"02111","minLength":0,"maxLength":255},"city":{"type":["string","null"],"description":"The city of a location's address.","example":"Boston","minLength":0,"maxLength":255},"city_region":{"type":["string","null"],"description":"A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.","minLength":0,"maxLength":255,"example":"Leather District"},"county_or_parish":{"type":["string","null"],"description":"The County, Parish or other regional authority of the location.","minLength":0,"maxLength":255,"example":"Suffolk County"},"state_or_province":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States."},"children":[]}]}]}],"minLength":0,"maxLength":255,"example":"MA"},"state_or_province_region":{"type":["string","null"],"description":"A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.","minLength":0,"maxLength":255,"example":"Cape Cod"},"country":{"type":["string","null"],"description":"The ISO 3166-1 country code for this for the country of the location.","minLength":0,"maxLength":255,"example":"US"},"country_region":{"type":["string","null"],"description":"A sub-section or area of a defined country. Examples would be Napa Valley in the US, or the Amalfi Coast in Italy.","example":"Napa Valley","minLength":0,"maxLength":255},"timezone":{"type":["string","null"],"description":"The assumed timezone the address is located in.","minLength":0,"maxLength":255,"example":"America/New_York"},"unparsed_address":{"type":["string","null"],"description":"Unparsed text representation of the address. ","example":"107 South St, Boston MA, 02111","minLength":0,"maxLength":255},"unparsed_address_part_one":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"Unparsed text representation of the first part of the address, typically including the street number, street name, and unit number if applicable.  ","example":"107 South St, Unit 2F"},"unparsed_address_part_one_formatting":{"type":["string","null"],"description":"The formatting of the first part of the address.","example":"107 South St, Unit 2F","minLength":0,"maxLength":255},"unparsed_address_part_two":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"Unparsed text representation of the second part of the address, typically including the city, state or province, and postal code.  ","example":"Boston, MA 02111"},"unparsed_address_part_two_formatting":{"type":["string","null"],"description":"The formatting of the second part of the address.","example":"Boston, MA 02111","minLength":0,"maxLength":255},"is_map_dirty":{"type":["boolean","null"],"example":true,"description":"Does this address need to be geocoded?"},"external_type":{"type":["string","null"],"description":"The type of external ID for the address.","enum":["GOOGLE"],"minLength":0,"maxLength":255},"external_id":{"type":["string","null"],"description":"The external ID for the address.","example":"1234567890","minLength":0,"maxLength":255},"external_url":{"type":["string","null"],"description":"The URL for the address.","example":"https://maps.google.com/?cid=6291612540436414195","minLength":0,"maxLength":255,"format":"uri"},"external_data":{"type":["object","null"],"description":"The external data for the address."}},"additionalProperties":false}},"components/schemas/AddressSearchResultResource":{"id":"components/schemas/AddressSearchResultResource","kind":"json-schema","title":"AddressSearchResultResource","data":{"title":"AddressSearchResultResource","type":"object","description":"Search result for an address.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/AddressSearchResult"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"additionalProperties":false,"required":["status"]}},"components/schemas/ImpersonatePostPayload":{"id":"components/schemas/ImpersonatePostPayload","kind":"json-schema","title":"ImpersonatePostPayload","data":{"type":"object","title":"ImpersonatePostPayload","description":"Values needed to impersonate a company user.","properties":{"email":{"type":"string","description":"Admin user email.","format":"email","example":"john.doe@gmail.com","minLength":0,"maxLength":255},"password":{"type":"string","description":"Admin user password.","example":"P@$$w0Rd","minLength":0,"maxLength":255},"company_team_member_id":{"type":"string","description":"ID of company team member.","minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000"},"client":{"type":"string","description":"The type of client.","example":"IOS","minLength":1,"maxLength":255,"enum":["IOS","ANDROID","PHPUNIT"]}},"required":["email","password","company_team_member_id","client"],"additionalProperties":false}},"components/schemas/PersonalAccessToken":{"id":"components/schemas/PersonalAccessToken","kind":"json-schema","title":"PersonalAccessToken","data":{"type":"object","title":"PersonalAccessToken","description":"A personal access token, its user, and the it's users group (if applicable).","properties":{"object":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"PERSONAL_ACCESS_TOKEN"},"token":{"type":"string","minLength":0,"description":"Authorization token for a user.","example":"token","maxLength":8000},"user":{"$ref":"#/components/schemas/User"},"group":{"$ref":"#/components/schemas/Group"}},"required":["token","user"],"additionalProperties":false}},"components/schemas/PersonalAccessTokenResource":{"id":"components/schemas/PersonalAccessTokenResource","kind":"json-schema","title":"PersonalAccessTokenResource","data":{"title":"PersonalAccessTokenResource","type":"object","description":"A personal access token.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/PersonalAccessToken"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/ApiError409":{"id":"components/schemas/ApiError409","kind":"json-schema","title":"ApiError409","data":{"type":"object","title":"ApiError409","description":"A conflict error returned by the API.","properties":{"status":{"type":"string","example":"error","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"message":{"type":"string","description":"The error message.","example":"{ApiError message.}","minLength":0,"maxLength":255},"code":{"type":["integer","null"],"description":"A numeric code corresponding to the error.","example":409}},"required":["status","message"],"additionalProperties":false}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"title":"Tag","type":"object","description":"A label attached to something for the purpose of identification or categorization.","properties":{"object":{"type":"string","minLength":19,"maxLength":19,"enum":["APP\\TAGS\\MODELS\\TAG"],"example":"APP\\TAGS\\MODELS\\TAG","description":"A canonical value representing a resource."},"id":{"type":"string","description":"ID. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"name":{"type":"string","description":"The name of the tag.","example":"Photography","minLength":1,"maxLength":255},"slug":{"type":"string","description":"The slug of the tag.","example":"photography","minLength":1,"maxLength":255},"color":{"type":"string","description":"The background color of the tag.","example":"#8BC34A","minLength":7,"maxLength":7},"font_color":{"type":"string","description":"The font color of the tag.","example":"#FFFFFF","minLength":7,"maxLength":7},"type":{"type":"string","description":"The type of the tag.","example":"order","minLength":5,"maxLength":18,"enum":["order","customer_team","product","order_form","virtual_staging_ai"]}},"required":["id","name","slug","color","font_color"],"additionalProperties":false}},"components/schemas/CustomerGroup":{"id":"components/schemas/CustomerGroup","kind":"json-schema","title":"CustomerGroup","data":{"title":"CustomerGroup","type":"object","description":"A customer group is a legacy name for what is now a customer team. A customer team is a container for customers, allowing you to apply settings such as price overrides and billing customer configurations in bulk.","properties":{"object":{"type":"string","minLength":13,"maxLength":13,"enum":["CUSTOMER_TEAM"],"example":"CUSTOMER_TEAM","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"company_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"The ID of the company the customer team belongs to.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"name":{"type":"string","maxLength":255,"minLength":0,"description":"The name of the customer team.","example":"John Doe Customer Group"},"description":{"type":["string","null"],"maxLength":2550,"minLength":0,"description":"The description of the customer team.","example":"John Doe Customer Team is a customer team for John Doe."},"internal_notes":{"type":["string","null"],"maxLength":2550,"minLength":0,"description":"The internal notes of the customer team.","example":"John Doe's customer team normally doesn't work on Fridays."},"logo_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/640/480","description":"The logo image URL of the customer team.","minLength":0,"maxLength":255},"brokerage_name":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The name of the brokerage team.","example":"Grimes-Mante"},"brokerage_website":{"type":["string","null"],"format":"uri","example":"http://www.tillman.info/aut-odio-qui-voluptatibus","description":"The website URL of the brokerage team.","minLength":0,"maxLength":255},"affiliate_id":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The affliate ID for the customer team.","example":"JOHN_DOE"},"should_display_original_price":{"type":"boolean","description":"Indicates if original prices should be displayed for this customer team.","example":true},"should_disable_automated_payment_reminder_email":{"type":"boolean","description":"Indicates if automated payment reminder emails should be disabled for this customer team.","example":true},"should_lock_downloads_before_payment":{"type":["boolean","null"],"description":"Indicates if the downloads should be locked before payment for this customer team.","example":true},"order_form_id":{"type":["string","null"],"minLength":36,"maxLength":36,"format":"uuid","description":"The ID of the order form.","example":"00000000-0000-4000-8000-000000000000"},"created_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the customer team was created.","format":"date-time","minLength":27,"maxLength":27,"example":"2025-03-07T13:59:03.000000Z"},"is_showingtimeplus_team":{"type":"boolean","description":"Indicates if the customer team is a ShowingTime team.","example":true},"billing_customer":{"$ref":"#/components/schemas/Group"},"billing_customer_pays_externally":{"type":"boolean","description":"Indicates if the billing customer team membership pays externally.","example":true},"status":{"type":"string","description":"The status of the customer group.","example":"active","minLength":0,"maxLength":255,"enum":["any_status","active","archived"]},"is_archived":{"type":"boolean","description":"Indicates if the customer group is archived.","example":true},"website":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The website URL of the customer group.","example":"https://www.aryeo.com"},"is_default":{"type":["boolean","null"],"description":"Indicates if the customer group is the default customer group.","example":true},"company":{"$ref":"#/components/schemas/Group"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}},"required":["id","name"],"additionalProperties":false}},"components/schemas/ListingLot":{"id":"components/schemas/ListingLot","kind":"json-schema","title":"ListingLot","data":{"title":"ListingLot","type":"object","description":"Parcel data of the lot of a listing. Includes nearly everything about the land that makes up the listing.","properties":{"size_acres":{"type":["number","null"],"description":"Total area of the lot of a listing in acres. ","example":0.47,"minimum":0},"open_parking_spaces":{"type":["number","null"],"description":"Number of parking spaces.","example":3,"minimum":0}},"additionalProperties":false}},"components/schemas/ListingBuilding":{"id":"components/schemas/ListingBuilding","kind":"json-schema","title":"ListingBuilding","data":{"title":"ListingBuilding","type":"object","description":"Structural data of the primary building on a listing. Includes everything from square footage of certain spaces to construction dates. ","properties":{"bedrooms":{"type":["integer","null"],"description":"Total number of bedrooms.","example":4},"bathrooms":{"type":["number","null"],"description":"Sum of the number of bathrooms. Represented as a number in order to support half-baths.","example":3.5},"square_feet":{"type":["number","null"],"description":"Total number of square feet.","example":2511},"year_built":{"type":["integer","null"],"description":"Year the property was built.","example":1960},"bedrooms_number":{"type":"number","description":"Total number of bedrooms.","example":4,"deprecated":true}},"additionalProperties":false}},"components/schemas/ListingPrice":{"id":"components/schemas/ListingPrice","kind":"json-schema","title":"ListingPrice","data":{"title":"ListingPrice","type":"object","properties":{"list_price":{"type":["integer","null"],"description":"The current price of the listing.","example":250000,"minimum":0},"list_price_formatted":{"type":["string","null"],"description":"The current price of the listing formatted for display.","example":"$250,000","minLength":0,"maxLength":255}},"description":"Valuation data relating to the price of a listing.","additionalProperties":false}},"components/schemas/CustomerTeamMembership":{"id":"components/schemas/CustomerTeamMembership","kind":"json-schema","title":"CustomerTeamMembership","data":{"type":"object","title":"CustomerTeamMembership","description":"A record of a customer team membership on the Aryeo platform.","properties":{"object":{"type":"string","minLength":24,"maxLength":24,"enum":["CUSTOMER_TEAM_MEMBERSHIP"],"example":"CUSTOMER_TEAM_MEMBERSHIP","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"role":{"type":"string","minLength":0,"maxLength":255,"description":"The role of the customer team membership.","enum":["admin","member"],"example":"admin"},"invitation_accepted_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the invitation was accepted.","format":"date-time","minLength":27,"maxLength":27,"example":"2025-04-01T05:59:59.999999Z"},"status":{"type":"string","minLength":0,"maxLength":255,"description":"The status of the customer team membership.","enum":["deleted","archived","revoked","active","invited"],"example":"active"},"customer_team":{"$ref":"#/components/schemas/CustomerGroup"},"is_active":{"type":"boolean","description":"Whether the customer team membership is active.","example":true},"is_archived":{"type":"boolean","description":"Whether the customer team membership is archived.","example":true},"is_deleted":{"type":"boolean","description":"Whether the customer team membership is deleted.","example":true},"is_invited":{"type":"boolean","description":"Whether the customer team membership is invited.","example":true},"is_default":{"type":"boolean","description":"Whether the customer team membership is the default.","example":true},"created_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the customer team membership was created.","format":"date-time","minLength":27,"maxLength":27,"example":"2025-04-01T05:59:59.999999Z"},"customer_user":{"$ref":"#/components/schemas/CustomerUser"},"listing_delivery_notification_enabled":{"type":"boolean","description":"Whether the customer team membership has listing delivery notifications enabled.","example":true},"is_showingtimeplus_workspace_membership":{"type":"boolean","description":"Whether the customer team membership is a ShowingTime workspace membership.","example":true},"is_visible":{"type":["boolean","null"],"description":"Whether the customer team membership is visible.","example":true},"order_index":{"type":["integer","null"],"description":"The order index of the customer team membership.","example":1}},"required":["id","role","status"],"additionalProperties":false}},"components/schemas/CustomerUser":{"id":"components/schemas/CustomerUser","kind":"json-schema","title":"CustomerUser","data":{"type":"object","title":"CustomerUser","description":"A record of a customer on the Aryeo platform.","properties":{"object":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"USER"},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"name":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"John","description":"Name of the user."},"email":{"type":"string","format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"Email address of the user."},"avatar_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/300","description":"The avatar image URL of a user.","minLength":0,"maxLength":255},"phone":{"type":["string","null"],"example":"123456789","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens)."},"children":[]}]}]}],"minLength":0,"maxLength":255},"logo_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/300","description":"The logo URL of a user.","minLength":0,"maxLength":255},"timezone":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The default timezone for the customer.","example":"America/New_York"},"license_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"12345678","description":"The license number of a real estate agent. Only returned if group's type is AGENT."},"customer_team_memberships":{"type":"array","items":{"$ref":"#/components/schemas/CustomerTeamMembership"}},"created_at":{"type":"string","description":"The date and time (ISO 8601 format) when the customer record was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"is_visible":{"type":["boolean","null"],"description":"Indicates if the customer is visible.","example":true},"order_index":{"type":["integer","null"],"description":"The order index of the customer.","example":1},"verification_status":{"type":"string","description":"The verification status of the customer.","minLength":0,"maxLength":255,"example":"verified","enum":["verified","unverified","new","sso"]},"credit_balance_amount":{"type":["number","null"],"description":"The credit balance amount of the customer.","example":100},"total_balance_amount":{"type":["number","null"],"description":"The total balance amount of the customer.","example":100},"is_showingtimeplus_user":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer is a ShowingTime+ user."},"children":[]}]}]}],"example":true},"full_name":{"type":"string","description":"The full name of the customer.","minLength":0,"maxLength":255,"example":"John Doe"},"first_name":{"type":"string","description":"The first name of the customer.","minLength":0,"maxLength":255,"example":"John"},"last_name":{"type":"string","description":"The last name of the customer.","minLength":0,"maxLength":255,"example":"Doe"},"phone_number":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The phone number of the customer.","example":"1234567890"},"profile_link":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The profile link of the customer.","example":"https://picsum.photos/300"},"internal_notes":{"type":["string","null"],"minLength":0,"maxLength":2550,"description":"The internal notes of the customer.","example":"John Doe is a customer."},"agent_company_name":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The agent company name of the customer.","example":"John Doe Real Estate"},"agent_license_number":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The agent license number of the customer.","example":"1234567890"},"is_blocked_from_ordering":{"type":"boolean","description":"Whether the customer is blocked from ordering.","example":true},"has_restricted_photographers":{"type":"boolean","description":"Whether the customer is restricted from booking appointments with certain photographers.","example":true},"default_lock_downloads_before_payment":{"type":["boolean","null"],"description":"Whether the customer has locked media downloads before payment as the default download setting.","example":true},"default_allows_access_to_marketing_material":{"type":["boolean","null"],"description":"Whether the customer has access to the marketing material builder.","example":true},"avalara_customer_code":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The Avalara customer code of the customer.","example":"1234567890"},"quickbooks_customer_id":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The Quickbooks customer ID of the customer.","example":"1234567890"},"is_super":{"type":"boolean","description":"Whether the customer is a super user.","example":true},"status":{"type":"string","description":"The status of the customer.","example":"active","enum":["active","inactive","new","sso"],"minLength":0,"maxLength":255}},"required":["id","email"],"additionalProperties":false}},"components/schemas/Image":{"id":"components/schemas/Image","kind":"json-schema","title":"Image","data":{"title":"Image","type":"object","description":"A visual representation of something.","properties":{"object":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"IMAGE"},"id":{"type":"string","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"thumbnail_url":{"type":"string","description":"A URL for a thumbnail-sized version of the image.","example":"https://picsum.photos/250/200","minLength":1,"maxLength":65535,"format":"uri"},"large_url":{"type":"string","description":"A URL for a large version of the image.","example":"https://picsum.photos/1750/1400","minLength":1,"maxLength":65535,"format":"uri"},"filename":{"type":"string","description":"The name of the file.","example":"image.jpg","minLength":1,"maxLength":255},"original_url":{"type":"string","description":"A URL for the original, full-resolution version of the image. Useful for downloading.","example":"https://picsum.photos/2500/2000","minLength":1,"maxLength":65535,"format":"uri"},"index":{"type":["integer","null"],"description":"The order in which the image should be displayed amongst other related images.","example":2},"caption":{"type":["string","null"],"description":"A brief explanation of the image.","example":"This is the front of the house.","minLength":1,"maxLength":255},"display_in_gallery":{"type":"boolean","description":"Should the image be displayed in a gallery?","example":true}},"required":["id","thumbnail_url","large_url","filename","original_url","display_in_gallery"],"additionalProperties":false}},"components/schemas/File":{"id":"components/schemas/File","kind":"json-schema","title":"File","data":{"title":"File","type":"object","description":"A generic downloadable file associated with a resource (e.g., a listing).","properties":{"object":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"FILE"},"id":{"type":"string","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"0197f537-84c8-7329-b833-e28cd814a1ce"},"uuid":{"type":"string","description":"UUID of the file (duplicate of id in legacy contexts).","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"0197f537-84c8-7329-b833-e28cd814a1ce"},"filename":{"type":"string","description":"The file's name or key.","example":"f7149b39-c3bf-47a1-b023-2f2e476ed0e5","minLength":1,"maxLength":255},"file_type":{"type":"string","description":"The file type or extension.","example":"jpg","minLength":1,"maxLength":50},"description":{"type":["string","null"],"description":"A description of the file.","example":"Aut voluptatem numquam amet. Sed nihil ex ea maiores. Et corporis doloremque fugiat aut adipisci officia est ad.","minLength":1,"maxLength":65535},"display_type":{"type":["string","null"],"description":"How this file should be displayed in the UI.","enum":["none","both"],"example":"none","minLength":0,"maxLength":255},"url":{"type":"string","description":"A URL to access or download the file.","example":"https://cdn.aryeo.com/listings/cottagewood-rd-minnetrista-35649/resized/thumbnail/thumbnail-9c436b89-5717-403c-b5fa-054275a85ce3.jpg","minLength":1,"maxLength":65535,"format":"uri"}},"required":["id","uuid","filename","file_type","url"],"additionalProperties":false}},"components/schemas/Video":{"id":"components/schemas/Video","kind":"json-schema","title":"Video","data":{"title":"Video","type":"object","description":"A recording of moving visual images. Provided either as a download URL (MP4) or a link (e.g. YouTube, Vimeo).","properties":{"object":{"type":"string","minLength":5,"maxLength":5,"enum":["VIDEO"],"example":"VIDEO","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":["string","null"],"example":"The New Vimeo Player (You Know, For Videos)","description":"The title of the video given by the uploading user.","maxLength":255,"minLength":1},"duration":{"type":["integer","null"],"description":"The video's runtime in seconds.","example":360},"display_type":{"type":"string","example":"BRANDED","description":"The display type determines if the video is branded or unbranded (can also be none or both). This affects whether the video is displayed on branded or unbranded marketing materials such as the property website.","maxLength":255,"minLength":1,"enum":["BRANDED","UNBRANDED","BOTH","NONE"]},"source_type":{"type":"string","example":"OPTIMIZED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original upload source of the video, used to determine how to handle the playback_url of the video and other display properties."},"children":[]}]}]}],"maxLength":255,"minLength":1,"enum":["YOUTUBE","VIMEO","OPTIMIZED","UPLOADED","LINK"]},"thumbnail_url":{"type":"string","description":"A thumbnail image URL for the video.","minLength":0,"maxLength":65535,"example":"https://picsum.photos/300","format":"uri"},"playback_url":{"type":["string","null"],"description":"A URL linking to playback stream of the video.","minLength":0,"maxLength":65535,"example":"https://player.vimeo.com/video/76979871","format":"uri"},"download_url":{"type":["string","null"],"description":"A URL for downloading the video.","example":"https://videos.aryeo.com/listings/00000000-0000-4000-8000-000000000000/00000000-0000-4000-8000-000000000000.mp4","maxLength":65535,"format":"uri","minLength":1},"share_url":{"type":["string","null"],"format":"uri","description":"A URL linking to a public viewing optimized webpage the video.","example":"https://www.aryeo.com/v2/00000000-0000-4000-8000-000000000000/videos/1","minLength":0,"maxLength":65535}},"required":["id","display_type","source_type","thumbnail_url","playback_url"],"additionalProperties":false}},"components/schemas/FloorPlan":{"id":"components/schemas/FloorPlan","kind":"json-schema","title":"FloorPlan","data":{"title":"FloorPlan","type":"object","description":"A scale diagram of the arrangement of a building.","properties":{"object":{"type":"string","minLength":9,"maxLength":9,"enum":["FLOORPLAN"],"example":"FLOORPLAN","description":"A canonical value representing a resource."},"id":{"type":"string","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"original_url":{"type":"string","description":"A URL for the original, full-resolution version of the floor plan. Useful for downloading.","example":"https://picsum.photos/2500/2000","minLength":1,"maxLength":65535,"format":"uri"},"large_url":{"type":"string","description":"A URL for a large version of the floor plan.","example":"https://picsum.photos/1750/1400","minLength":1,"maxLength":65535,"format":"uri"},"thumbnail_url":{"type":"string","description":"A URL for a thumbnail-sized version of the floor plan.","example":"https://picsum.photos/250/200","minLength":1,"maxLength":65535,"format":"uri"},"title":{"type":["string","null"],"description":"The title (or caption) of the floor plan.","example":"Downstairs floorplan","minLength":1,"maxLength":255},"index":{"type":["integer","null"],"format":"int32","example":1,"minimum":0,"description":"Index order position of the floor plan."}},"required":["id","original_url","large_url","thumbnail_url"],"additionalProperties":false}},"components/schemas/InteractiveContent":{"id":"components/schemas/InteractiveContent","kind":"json-schema","title":"InteractiveContent","data":{"title":"InteractiveContent","type":"object","description":"A 3D virtual tour.","properties":{"id":{"type":"string","description":"ID of the entity. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":["string","null"],"example":"My Matterport","description":"The title of the interactive content given by the uploading user.","maxLength":255,"minLength":1},"display_type":{"type":"string","description":"Is the content branded, unbranded, or both?","minLength":1,"maxLength":65535,"enum":["BRANDED","UNBRANDED","BOTH"],"example":"BRANDED"},"content_type":{"type":"string","description":"The type of interactive content.","example":"MATTERPORT","minLength":1,"maxLength":65535,"enum":["MATTERPORT","OTHER"]},"url":{"type":"string","description":"URL for the content.","example":"https://my.matterport.com/show/?m=HFaxPzqNFfm","minLength":1,"maxLength":65535,"format":"uri"},"thumbnail_url":{"type":["string","null"],"description":"A URL for a thumbnail-sized preview of the content.","example":"https://picsum.photos/300","minLength":1,"maxLength":65535,"format":"uri"}},"required":["id","display_type","content_type","url"],"additionalProperties":false}},"components/schemas/PropertyWebsite":{"id":"components/schemas/PropertyWebsite","kind":"json-schema","title":"PropertyWebsite","data":{"title":"PropertyWebsite","type":"object","description":"Website (in branded and unbranded versions) that displays information about a property.","properties":{"id":{"type":"string","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"branded_url":{"type":"string","description":"URL for branded version of website.","minLength":1,"maxLength":65535,"example":"https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded","format":"uri"},"unbranded_url":{"type":"string","description":"URL for unbranded version of website.","minLength":1,"maxLength":65535,"example":"https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded","format":"uri"}},"required":["id","branded_url","unbranded_url"],"additionalProperties":false}},"components/schemas/PolotnoJson":{"id":"components/schemas/PolotnoJson","kind":"json-schema","title":"PolotnoJson","data":{"title":"PolotnoJson","type":"object","description":"The JSON representation of a Polotno canvas.","properties":{"width":{"type":"integer","example":500,"description":"The width of the canvas."},"height":{"type":"integer","example":500,"description":"The height of the canvas."}},"required":["width","height"],"additionalProperties":false}},"components/schemas/Export":{"id":"components/schemas/Export","kind":"json-schema","title":"Export","data":{"type":"object","properties":{"uuid":{"type":["string","null"],"minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"Unique identifier for the export."},"key":{"type":["string","null"],"minLength":1,"maxLength":65535,"description":"Key identifier for the export.","example":"export-123"},"file_path":{"type":"string","description":"Path to the exported file.","format":"uri","example":"https://aryeo.sfo2.cdn.digitaloceanspaces.com/marketing-material-templates/sirius-template-preview.jpg","minLength":1,"maxLength":65535},"content_type":{"type":["string","null"],"minLength":1,"maxLength":65535,"example":"application/pdf","description":"MIME type of the exported file."},"extension":{"type":["string","null"],"minLength":1,"maxLength":65535,"example":"pdf","description":"File extension of the exported file."}},"required":["uuid","key","file_path","content_type","extension"],"additionalProperties":false}},"components/schemas/MarketingMaterial":{"id":"components/schemas/MarketingMaterial","kind":"json-schema","title":"MarketingMaterial","data":{"title":"MarketingMaterial","type":"object","description":"A marketing material record.","properties":{"object":{"type":"string","minLength":18,"maxLength":18,"enum":["MARKETING_MATERIAL"],"example":"MARKETING_MATERIAL","description":"A canonical value representing a resource."},"id":{"type":["string","null"],"minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"The ID of the marketing material. UUID Version 4."},"name":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"New marketing material","description":"The name of the marketing material."},"thumbnail_url":{"type":["string","null"],"description":"A URL for a thumbnail-sized preview of the marketing material.","example":"https://picsum.photos/250/200","minLength":1,"maxLength":65535,"format":"uri"},"published_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the marketing material record was last published.","example":"2021-06-30T20:30:00Z","format":"date-time","minLength":20,"maxLength":20},"polotno_json":{"$ref":"#/components/schemas/PolotnoJson"},"listing_download_hash":{"type":["string","null"],"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"description":"The ID of the listing the marketing material belongs to. UUID Version 4."},"json_updated_at":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of when the polotno_json field was last updated."},"children":[]}]}]}],"example":1624057368000},"exports":{"type":"array","items":{"$ref":"#/components/schemas/Export"}}},"additionalProperties":false}},"components/schemas/EsoftOrderLine":{"id":"components/schemas/EsoftOrderLine","kind":"json-schema","title":"EsoftOrderLine","data":{"title":"EsoftOrderLine","type":"object","description":"An Esoft order line record.","properties":{"object":{"type":"string","minLength":16,"maxLength":16,"enum":["ESOFT_ORDER_LINE"],"example":"ESOFT_ORDER_LINE","description":"A canonical value representing a resource."},"id":{"type":["number","null"],"example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"The ID of the marketing material. UUID Version 4."},"esoft_order_line_id":{"type":["string","null"],"example":6141841,"description":"The Esoft order line ID from coconut."},"client_id":{"type":["string","null"],"example":701334,"description":"The Esoft client ID."},"reference":{"type":["string"],"description":"The Esoft order refrence.","example":"123 Main St","minLength":0,"maxLength":255},"status":{"type":"string","description":"The Esoft order status.","example":"complete","enum":["complete","cancelled","draft","error","submitted"],"minLength":5,"maxLength":9},"esoft_product_id":{"type":["number"],"example":700012,"description":"The Esoft product ID."},"esoft_product_name":{"type":["string"],"description":"The Esoft product name.","example":"Standard Photo Editing","minLength":0,"maxLength":255},"esoft_product_variant":{"type":["string"],"description":"The Esoft product variant.","example":"PH_VT","minLength":0,"maxLength":255},"quantity":{"type":["number"],"example":10,"description":"The quantity of the Esoft product ordered (varies by product and company)."},"comments":{"type":["string","null"],"description":"The Esoft order comments.","example":"Please add a watermark to the photos.","minLength":0,"maxLength":65535}},"additionalProperties":false}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"title":"Order","type":"object","description":"A payment request for some content or service.","properties":{"object":{"type":"string","minLength":5,"maxLength":5,"enum":["ORDER"],"example":"ORDER","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"identifier":{"type":["string","null"],"description":"A vanity id used for internal tracking of orders for a given vendor.","example":"Order #2","minLength":0,"maxLength":255},"number":{"type":["integer","null"],"description":"A vanity id used for internal tracking of orders for a given vendor.","example":100},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The title of the order, generated by combining the order's number property with the prefix 'Order #'."},"children":[]}]}]}],"example":"Order #100","minLength":0,"maxLength":255},"status":{"type":"string","description":"The status of the order.","enum":["CONFIRMED","GHOST"],"minLength":0,"maxLength":255,"example":"GHOST"},"order_status":{"type":"string","description":"The status of the order.","enum":["DRAFT","OPEN","CANCELED"],"minLength":0,"maxLength":255,"example":"OPEN"},"is_ghost":{"type":"boolean","description":"Indicates if the order is a ghost order.","example":true},"fulfilled_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the order was fulfilled.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"fulfillment_status":{"type":"string","description":"The fulfillment status of the order.","enum":["FULFILLED","PARTIALLY_FULFILLED","UNFULFILLED"],"minLength":0,"maxLength":255,"example":"FULFILLED"},"payment_status":{"type":"string","enum":["PAID","PARTIALLY_PAID","UNPAID"],"minLength":0,"maxLength":255,"example":"PAID","description":"The payment status of the order."},"internal_notes":{"type":["string","null"],"minLength":0,"maxLength":65535,"example":"Hey there notes!","description":"Internal order notes."},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code for the currency in which this order was or will be transacted. Must be a supported currency of Aryeo.","example":"USD","minLength":0,"maxLength":255,"enum":["USD","CAD","GBP","CHF","EUR","AUD","NZD","ZAR"]},"total_amount":{"type":"integer","example":2099,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the total order amount that was or will be charged. This accounts for order items and taxes."},"children":[]}]}]}],"minimum":0},"payment_url":{"type":["string","null"],"description":"A URL of a publicly-accessible webpage to pay for the order.","example":"https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order","maxLength":65535,"minLength":0},"status_url":{"type":["string","null"],"description":"A URL of a publicly-accessible webpage to see the order's status.","example":"https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status","maxLength":65535,"minLength":0},"invoice_url":{"type":["string","null"],"description":"A URL of a publicly-accessible pdf invoice of the order.","example":"https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download","maxLength":65535,"minLength":0},"downloads_allowed":{"type":"boolean","description":"Indicates if the current user is allowed to download content from the attached listing.","example":true},"payments_allowed":{"type":"boolean","description":"Indicates if the current user is allowed to make a payment for the order.","example":true},"address":{"$ref":"#/components/schemas/Address"},"customer":{"$ref":"#/components/schemas/Group"},"customer_group":{"$ref":"#/components/schemas/CustomerGroup"},"listing":{"$ref":"#/components/schemas/Listing"},"order_form":{"$ref":"#/components/schemas/OrderForm"},"discounts":{"type":"array","description":"The list of discounts applied to the order.","items":{"$ref":"#/components/schemas/Discount"}},"tags":{"type":"array","description":"The list of tags applied to the order.","items":{"$ref":"#/components/schemas/Tag"}},"items":{"type":"array","description":"items","items":{"$ref":"#/components/schemas/OrderItem"}},"custom_items":{"type":["array","null"],"description":"The list of custom items applied to the order.","items":{"$ref":"#/components/schemas/OrderItem"}},"appointments":{"type":"array","items":{"$ref":"#/components/schemas/Appointment"}},"unconfirmed_appointments":{"type":"array","items":{"$ref":"#/components/schemas/Appointment"}},"created_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the order was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"updated_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the order was last updated.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"custom_fields":{"type":["array","null"],"description":"The list of custom fields applied to the order.","items":{"type":"object","description":"A key-value pair of custom field data.","additionalProperties":false}},"taxes":{"type":"array","description":"The list of taxes applied to the order.","items":{"$ref":"#/components/schemas/Tax"}},"booking_limits":{"$ref":"#/components/schemas/BookingLimits"},"filter_by_square_feet":{"type":["boolean","null"],"description":"Indicates if the order should be filtered by square feet.","example":true},"filter_by_list_price":{"type":["boolean","null"],"description":"Indicates if the order should be filtered by list price.","example":true},"scheduling_assignment_strategy":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"RECOMMENDED","description":"The strategy used for scheduling assignment.","enum":["RECOMMENDED","HOURS_PRIORITY","DISTANCE","ROUND_ROBIN","PRIORITY_LIST"]},"balance_amount":{"type":["integer","null"],"description":"The balance amount of the order.","example":2099},"total_tax_amount":{"type":["integer","null"],"description":"The total tax amount of the order.","minimum":0,"example":2099},"total_discount_amount":{"type":["integer","null"],"description":"The total discount amount of the order.","minimum":0,"example":2099},"payments":{"type":"array","description":"The list of payments applied to the order.","items":{"$ref":"#/components/schemas/Payment"}}},"required":["id","title","fulfillment_status","payment_status","status_url","downloads_allowed","payments_allowed","created_at","updated_at"],"additionalProperties":false}},"components/schemas/Appointment":{"id":"components/schemas/Appointment","kind":"json-schema","title":"Appointment","data":{"title":"Appointment","type":"object","description":"An appointment.","properties":{"id":{"type":"string","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"status":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"SCHEDULED","description":"The status of the appointment.","enum":["SCHEDULED","UNSCHEDULED","CANCELED","DRAFT","POSTPONED","RESCHEDULED"]},"title":{"type":["string","null"],"minLength":0,"maxLength":65536,"example":"Appointment title","description":"The title of the appointment."},"description":{"type":["string","null"],"minLength":0,"maxLength":65536,"example":"Customer: John Doe\nOrder Details: Order #123","description":"The multi-line description of the appointment."},"start_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the appointment is set to start.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"end_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the appointment is set to end.","example":"2021-06-30T20:30:00Z","format":"date-time","minLength":20,"maxLength":20},"rescheduled_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the appointment was rescheduled.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"postponed_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the appointment was postponed.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"previous_start_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the appointment was previously scheduled for.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"preference_type":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"TIME","description":"The type of preferred scheduling information provided by a customer to aid in scheduling this appointment.","enum":["ASAP","TIME","TIME_OF_DAY","NONE"]},"preferred_start_at":{"type":["string","null"],"description":"A preferred date and time (ISO 8601 format) for when the appointment could start. Only returned if unconfirmed appointment's preference type is TIME. ","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"preferred_start_at_day":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A preferred date (ISO 8601 format) for when the appointment could start. Only returned if unconfirmed appointment's preference type is TIME_OF_DAY."},"children":[]}]}]}],"format":"date","minLength":10,"maxLength":10,"example":"2021-06-30"},"preferred_start_at_time_of_day":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A preferred time of day for when the appointment could start. Only returned if unconfirmed appointment's preference type is TIME_OF_DAY."},"children":[]}]}]}],"minLength":0,"maxLength":255,"example":"AFTERNOON","enum":["MORNING","MIDDAY","AFTERNOON","TWILIGHT"]},"duration":{"type":["integer","null"],"description":"The length of the appointment in minutes.","example":60},"user_has_appointments_manage_permission":{"type":"boolean","example":true,"description":"Does the authorized user have the availability to manage this appointment?"},"order":{"$ref":"#/components/schemas/Order"},"users":{"description":"Users attached to the appointment.","type":["array","null"],"items":{"$ref":"#/components/schemas/User"}},"items":{"type":"array","description":"Items attached to the appointment.","items":{"$ref":"#/components/schemas/OrderItem"}},"can_cancel":{"type":["boolean","null"],"example":true,"description":"Indicates if the request user can cancel the appointment."},"can_reschedule":{"type":["boolean","null"],"example":true,"description":"Indicates if the request user can reschedule the appointment."},"is_within_cancellation_lock_period":{"type":["boolean","null"],"example":true,"description":"Indicates if the appointment is within the cancellation lock period."},"is_within_rescheduling_lock_period":{"type":["boolean","null"],"example":true,"description":"Indicates if the appointment is within the cancellation lock period."},"deleted_at":{"type":["string","null"],"description":"A deleted date and time (ISO 8601 format) for when we use a filter to get changed appointments. ","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"requires_confirmation":{"type":["boolean","null"],"example":true,"description":"Indicates if the appointment requires confirmation."},"customer_choice_enabled":{"type":["boolean","null"],"example":false,"description":"Whether customer choice booking was enabled when this appointment was created."},"initial_requested_company_team_member_ids":{"type":["array","null"],"description":"Company team member IDs the customer requested when filtering to specific providers.","items":{"description":"ID of a company team member. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"assignment_type":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"specific_company_team_member","description":"How the customer selected a provider during customer choice booking.","enum":["first_available","specific_company_team_member"]},"initial_assigned_company_team_member_id":{"type":["string","null"],"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"description":"The company team member initially assigned when the appointment was booked."},"late_cancellation_fee":{"type":"array","description":"The late cancellation fee for the appointment.","items":{"type":"object","description":"A key-value pair of late cancellation fee data.","additionalProperties":false}},"updated_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the appointment was last updated.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"company_team_members":{"type":"array","description":"The team members associated with the appointment.","items":{"$ref":"#/components/schemas/CompanyTeamMember"}},"appointment_attendances":{"type":"array","description":"The attendances associated with the appointment.","items":{"$ref":"#/components/schemas/AppointmentAttendance"}}},"required":["id"],"additionalProperties":false}},"components/schemas/Listing":{"id":"components/schemas/Listing","kind":"json-schema","title":"Listing","data":{"title":"Listing","type":"object","description":"A real estate listing.","properties":{"object":{"type":"string","minLength":7,"maxLength":7,"enum":["LISTING"],"example":"LISTING","description":"A canonical value representing a resource."},"id":{"type":"string","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"address":{"$ref":"#/components/schemas/Address"},"mls_number":{"type":["string","null"],"description":"The identifier for a listing on its local MLS. ","minLength":1,"maxLength":100,"example":"1850209"},"type":{"type":["string","null"],"example":"SINGLE_FAMILY","description":"General type of the listing, primarily categorizing its use case. Examples include residential and commercial. ","minLength":1,"maxLength":100,"enum":["SINGLE_FAMILY","SINGLE_FAMILY_ATTACHED","SINGLE_FAMILY_DETACHED","COLONIAL","CONDO","TOWNHOME","TWINHOME","DUPLEX","LOT","LAND","MANUFACTURED_HOME","SEMI_DETACHED","MULTI_FAMILY","RENTAL","ROW_HOUSE","HORSE_FARM","OTHER"]},"sub_type":{"type":["string","null"],"example":"SINGLE_FAMILY_DETACHED","description":"Further specifies the listing type. Examples include family residence and condominium.","minLength":1,"maxLength":100,"enum":["SINGLE_FAMILY","SINGLE_FAMILY_ATTACHED","SINGLE_FAMILY_DETACHED","COLONIAL","CONDO","TOWNHOME","TWINHOME","DUPLEX","LOT","LAND","MANUFACTURED_HOME","SEMI_DETACHED","MULTI_FAMILY","RENTAL","ROW_HOUSE","HORSE_FARM","OTHER"]},"status":{"type":["string","null"],"example":"COMING_SOON","description":"Local, regional, or otherwise custom status for the listing used by the parties involved in the listing transaction. While variable, these statuses are typically mapped to the listing's standard status.","minLength":1,"maxLength":100,"enum":["DRAFT","COMING_SOON","FOR_SALE","FOR_LEASE","PENDING_SALE","PENDING_LEASE","FOR_RENT","SOLD","LEASED","OFF_MARKET"]},"standard_status":{"type":["string","null"],"example":"ACTIVE","description":"The status of the listing as it reflects the state of the contract between the listing agent and seller or an agreement with a buyer, including Active, Active Under Contract, Closed, Coming Soon, Hold, and Incomplete.","minLength":1,"maxLength":100,"enum":["ACTIVE","ACTIVE_UNDER_CONTRACT","CLOSED","COMING_SOON","HOLD","INCOMPLETE"]},"thumbnail_url":{"type":["string","null"],"minLength":1,"maxLength":65536,"example":"https://picsum.photos/640/480","description":"A URL for a thumbnail representing the listing."},"large_thumbnail_url":{"type":["string","null"],"minLength":1,"maxLength":65536,"example":"https://picsum.photos/1280/960","description":"A URL for a large thumbnail representing the listing."},"description":{"type":["string","null"],"description":"Description of the selling points of the building and/or land for sale. ","example":"There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.","minLength":1,"maxLength":65535},"lot":{"$ref":"#/components/schemas/ListingLot"},"building":{"$ref":"#/components/schemas/ListingBuilding"},"price":{"$ref":"#/components/schemas/ListingPrice"},"list_agent":{"$ref":"#/components/schemas/Group"},"co_list_agent":{"$ref":"#/components/schemas/Group"},"customer_team_memberships":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer_team_memberships"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CustomerTeamMembership"}},"images":{"type":"array","description":"images","items":{"$ref":"#/components/schemas/Image"}},"files":{"type":"array","description":"files","items":{"$ref":"#/components/schemas/File"}},"videos":{"type":"array","description":"videos","items":{"$ref":"#/components/schemas/Video"}},"floor_plans":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"floor_plans"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/FloorPlan"}},"interactive_content":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interactive_content"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/InteractiveContent"}},"property_website":{"$ref":"#/components/schemas/PropertyWebsite"},"marketing_materials":{"type":"array","description":"Marketing materials for this listing. ","items":{"$ref":"#/components/schemas/MarketingMaterial"}},"esoft_order_lines":{"type":"array","description":"Esoft order lines for this listing.","items":{"$ref":"#/components/schemas/EsoftOrderLine"}},"orders":{"type":"array","description":"orders","items":{"$ref":"#/components/schemas/Order"}},"appointments":{"type":"array","items":{"$ref":"#/components/schemas/Appointment"}},"unconfirmed_appointments":{"type":"array","items":{"$ref":"#/components/schemas/Appointment"}},"downloads_enabled":{"type":"boolean","description":"Are downloads enabled for this listing?","example":true},"downloads_enabled_setting":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The raw downloads_enabled setting on the listing, independent of payment state."},"children":[]}]}]}],"example":true},"allows_access_to_marketing_material":{"type":"boolean","description":"Indicates whether the listing allows customer access to marketing material.","example":true},"is_showcase":{"type":"boolean","description":"Indicates if this is a Showcase listing","example":true},"is_showcasable":{"type":"boolean","description":"Indicates if this listing can be showcased","example":true},"has_high_resolution_images":{"type":"boolean","description":"Indicates if this listing has high resolution images","example":true},"has_zillow_imx_tour":{"type":"boolean","description":"Indicates if this listing has a Zillow IMX tour","example":true},"delivery_status":{"type":["string","null"],"example":"DELIVERED","description":"The delivery status of the listing.","minLength":1,"maxLength":100,"enum":["DELIVERED","UNDELIVERED","SCHEDULED"]}},"required":["object","id","address","downloads_enabled"],"additionalProperties":false}},"components/schemas/PromotionCode":{"id":"components/schemas/PromotionCode","kind":"json-schema","title":"PromotionCode","data":{"title":"PromotionCode","type":"object","description":"A Promotion Code represents a customer-redeemable code for a coupon.","properties":{"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"code":{"type":"string","description":"The customer-facing code. This code must be unique across all active promotion codes.","example":"SPRING_SALE","minLength":0,"maxLength":255},"times_redeemed":{"type":"integer","description":"The number of times the coupon has been redeemed.","example":10},"start_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the promotion code will be active.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"end_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the promotion code will no longer be active.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"max_redemptions":{"type":["integer","null"],"description":"The maximum number of times the promotion code can be redeemed.","example":10},"max_redemptions_per_customer":{"type":["integer","null"],"description":"The maximum number of times the promotion code can be redeemed per customer.","example":10},"first_time_only":{"type":["boolean","null"],"description":"Indicates if the promotion code can only be redeemed once per customer.","example":true},"minimum_amount":{"type":["integer","null"],"description":"The minimum amount that must be in the cart before the promotion code can be applied.","example":1000},"is_portal_mobile_app_only":{"type":["boolean","null"],"description":"Indicates if the promotion code can only be redeemed on the portal mobile app.","example":true}},"required":["id","code"],"additionalProperties":false}},"components/schemas/ProductVariant":{"id":"components/schemas/ProductVariant","kind":"json-schema","title":"ProductVariant","data":{"title":"ProductVariant","type":"object","description":"A variant of a product.","properties":{"object":{"type":"string","minLength":15,"maxLength":15,"enum":["PRODUCT_VARIANT"],"example":"PRODUCT_VARIANT","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":"string","description":"The title of the product variant.","example":"House photos","minLength":0,"maxLength":255},"price":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant."},"children":[]}]}]}],"example":10000,"minimum":0},"price_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant."},"children":[]}]}]}],"example":10000,"minimum":0},"base_price_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the price of the product variant."},"children":[]}]}]}],"example":10000,"minimum":0},"base_is_hidden":{"type":"boolean","description":"Indicates if the base price of the product variant is hidden.","example":true},"display_original_price":{"type":"boolean","description":"Indicates if the original price of the product variant should be displayed.","example":true},"duration":{"type":"integer","example":60,"description":"The duration of the product item, in minutes.","minimum":0}},"required":["id","title"],"additionalProperties":false}},"components/schemas/ProductCategory":{"id":"components/schemas/ProductCategory","kind":"json-schema","title":"ProductCategory","data":{"title":"ProductCategory","type":"object","description":"A category for products.","properties":{"object":{"type":"string","minLength":16,"maxLength":16,"enum":["PRODUCT_CATEGORY"],"example":"PRODUCT_CATEGORY","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":"string","description":"The title of the product category.","example":"Photography","minLength":0,"maxLength":255},"name":{"type":"string","description":"The name of the product category.","example":"Photography","minLength":0,"maxLength":255},"slug":{"type":"string","description":"The slug of the product category.","example":"photography","minLength":0,"maxLength":255},"color":{"type":"string","description":"The color of the product category.","example":"#000000","minLength":0,"maxLength":255},"type":{"type":"string","description":"The type of the product category.","example":"product","minLength":0,"maxLength":255}},"required":["id","title"],"additionalProperties":false}},"components/schemas/QuickBooksItem":{"id":"components/schemas/QuickBooksItem","kind":"json-schema","title":"QuickBooksItem","data":{"type":["object","null"],"title":"QuickBooksItem","description":"A record of a QuickBooks item.","properties":{"object":{"type":"string","minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"QUICKBOOKS_ITEM"},"id":{"type":"string","minLength":0,"maxLength":255,"description":"ID of the QuickBooks item.","example":"1234567890"},"display_name":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"Consulting Hours","description":"Fully qualified display name of the QuickBooks item."},"name":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"Consulting","description":"Name of the QuickBooks item."},"description":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"Hourly consulting services","description":"Description of the QuickBooks item."},"type":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"Service","description":"Type of the QuickBooks item."},"active":{"type":"boolean","description":"Whether the QuickBooks item is active.","example":true}},"required":["id"],"additionalProperties":false}},"components/schemas/DiscountableItem":{"id":"components/schemas/DiscountableItem","kind":"json-schema","title":"DiscountableItem","data":{"title":"DiscountableItem","type":"object","description":"A discountable item.","properties":{"object":{"type":"string","minLength":0,"maxLength":255,"example":"PRODUCT","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":"string","description":"The title of the item.","example":"House photos","minLength":0,"maxLength":255},"description":{"type":"string","description":"The description of the item.","example":"Capture photos of a house for sale.","minLength":0,"maxLength":65536},"active":{"type":"boolean","description":"The active status of an item.","example":true},"type":{"type":"string","minLength":0,"maxLength":255,"description":"The type of item.","example":"MAIN"},"is_twilight":{"type":"boolean","description":"Whether the item is available during twilight hours.","example":true},"image_url":{"type":["string","null"],"description":"A URL for an example property image.","example":"https://picsum.photos/400/200","minLength":0,"maxLength":65536,"format":"uri"},"is_serviceable":{"type":"boolean","description":"Whether the item is serviceable.","example":true},"requires_separate_booking":{"type":"boolean","description":"Whether the item requires a separate booking.","example":true},"always_display_addons":{"type":"boolean","description":"Whether to always display addons for the item.","example":true},"variant_filter_type":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The type of variant filter.","example":"ALL"},"avalara_tax_code":{"type":["string","null"],"description":"The Avalara tax code for the item.","minLength":0,"maxLength":255,"example":"12345"},"limit_quantity_amount":{"type":["integer","null"],"description":"The limit quantity amount for the item.","example":10},"limit_quantity":{"type":"boolean","description":"Whether the item has a limit quantity.","example":true},"is_filterable":{"type":"boolean","description":"Whether the item is filterable.","example":true},"is_esoft_adjustment":{"type":"boolean","description":"Whether the item is an eSoft adjustment.","example":true},"variants":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariant"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategory"}},"quickbooks_item_id":{"type":["string","null"],"description":"The Quickbooks item ID for the item.","example":"12345","minLength":0,"maxLength":65536},"quickbooks_item":{"$ref":"#/components/schemas/QuickBooksItem"},"amount":{"type":"number","description":"The amount of the item.","example":100},"name":{"type":"string","description":"The name of the item.","example":"Flat Fee","minLength":0,"maxLength":65536}},"required":["id"],"additionalProperties":false}},"components/schemas/Discountable":{"id":"components/schemas/Discountable","kind":"json-schema","title":"Discountable","data":{"title":"Discountable","type":"object","description":"A discountable maps a coupon to a product or fee the coupon should exclusively apply to. ","properties":{"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representing the object’s type. Objects of the same type share the same schema."},"children":[]}]}]}],"example":"DISCOUNTABLE","minLength":1,"maxLength":100},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"discountable":{"$ref":"#/components/schemas/DiscountableItem"}},"required":["id"],"additionalProperties":false}},"components/schemas/Coupon":{"id":"components/schemas/Coupon","kind":"json-schema","title":"Coupon","data":{"title":"Coupon","type":"object","description":"A coupon contains information about a percent-off or amount-off discount you might want to apply to an order.","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"name":{"type":"string","description":"Name of the coupon displayed to customers on orders.","example":"VIP Customer Discount","minLength":0,"maxLength":255},"is_active":{"type":"boolean","description":"Indicates if the coupon is currently active.","example":true},"is_percent_off":{"type":"boolean","description":"Indicates if the coupon is a percent off coupon.","example":true},"percent_off":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A decimal value representing the percent that will be taken off the subtotal of an order this coupon is applied to. For example, 0.500 would represent an applied discount of 50%, meaning an order with a subtotal of $100 would result in a balance of $50."},"children":[]}]}]}],"format":"float","example":0.075,"minimum":0,"maximum":1},"amount_off":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount that will be taken off the subtotal of any orders this coupon is applied to. Amount represented in the smallest currency unit (that is, 100 cents for $1.00)."},"children":[]}]}]}],"example":2500},"amount_off_formatted":{"type":"string","minLength":0,"maxLength":255,"description":"The amount off formatted as a string.","example":"$25.00"},"promotion_codes":{"type":"array","items":{"$ref":"#/components/schemas/PromotionCode"}},"discountables":{"type":"array","items":{"$ref":"#/components/schemas/Discountable"}},"times_redeemed":{"type":"integer","description":"The number of times the coupon has been redeemed.","example":10},"created_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the order was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["id"],"additionalProperties":false}},"components/schemas/Discount":{"id":"components/schemas/Discount","kind":"json-schema","title":"Discount","data":{"title":"Discount","type":"object","description":"A discount represents the application of a coupon to an order or order item. It includes the calculated amount to be discounted based on the coupon configuration.","properties":{"object":{"type":"string","minLength":8,"maxLength":8,"enum":["DISCOUNT"],"example":"DISCOUNT","description":"A canonical value representing a resource."},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"total_discount_amount":{"type":"integer","description":"The total discount amount.","example":1000},"coupon":{"$ref":"#/components/schemas/Coupon"}},"required":["id"],"additionalProperties":false}},"components/schemas/DiscountAmount":{"id":"components/schemas/DiscountAmount","kind":"json-schema","title":"DiscountAmount","data":{"title":"DiscountAmount","type":"object","description":"A discount amount.","properties":{"object":{"type":"string","minLength":35,"maxLength":35,"enum":["APP\\DISCOUNTS\\MODELS\\DISCOUNTAMOUNT"],"example":"APP\\DISCOUNTS\\MODELS\\DISCOUNTAMOUNT","description":"A canonical value representing a resource."},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"discount":{"$ref":"#/components/schemas/Discount"},"amount":{"type":"integer","example":2999,"description":"The amount of discount that was applied"},"applied_percent_off":{"example":0.2,"type":["number","null"],"minimum":0,"maximum":1,"description":"Representation of percent off ranging from 0 to 1"},"applied_amount_off":{"description":"Amount discounted in cents","example":2500,"type":["integer","null"]},"created_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the order was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"additionalProperties":false}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"title":"Product","type":"object","description":"A product available for purchase via an order.","properties":{"object":{"type":"string","minLength":7,"maxLength":7,"enum":["PRODUCT"],"example":"PRODUCT","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":"string","description":"The title of the product.","example":"House photos","minLength":0,"maxLength":255},"description":{"type":"string","description":"The description of the product.","example":"Capture photos of a house for sale.","minLength":0,"maxLength":65536},"active":{"type":"boolean","description":"The active status of a product.","example":true},"type":{"type":"string","minLength":0,"maxLength":255,"description":"The type of product.","enum":["MAIN","ADDON"],"example":"MAIN"},"is_twilight":{"type":"boolean","description":"Whether the product is available during twilight hours.","example":true},"image_url":{"type":["string","null"],"description":"A URL for an example property image.","example":"https://picsum.photos/400/200","minLength":0,"maxLength":65536,"format":"uri"},"is_serviceable":{"type":"boolean","description":"Whether the product is serviceable.","example":true},"requires_separate_booking":{"type":"boolean","description":"Whether the product requires a separate booking.","example":true},"always_display_addons":{"type":"boolean","description":"Whether to always display addons for the product.","example":true},"variant_filter_type":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The type of variant filter.","example":"ALL"},"avalara_tax_code":{"type":["string","null"],"description":"The Avalara tax code for the product.","minLength":0,"maxLength":255,"example":"12345"},"limit_quantity_amount":{"type":["integer","null"],"description":"The limit quantity amount for the product.","example":10},"limit_quantity":{"type":"boolean","description":"Whether the product has a limit quantity.","example":true},"is_filterable":{"type":"boolean","description":"Whether the product is filterable.","example":true},"is_esoft_adjustment":{"type":"boolean","description":"Whether the product is an eSoft adjustment.","example":true},"variants":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariant"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategory"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategory"}}},"required":["id","title","type"],"additionalProperties":false}},"components/schemas/TaxRate":{"id":"components/schemas/TaxRate","kind":"json-schema","title":"TaxRate","data":{"title":"TaxRate","type":"object","description":"A tax rate represents the percentage of tax that should be applied to a taxed entity.","properties":{"object":{"type":"string","description":"String representing the object's type.","minLength":0,"maxLength":255,"example":"TAX_RATE"},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"name":{"type":"string","description":"The name of the tax.","example":"New York State Tax","minLength":0,"maxLength":255},"description":{"type":["string","null"],"description":"The description of the tax rate.","example":"Tax rate applied for any property that falls within the bounds New York State.","minLength":0,"maxLength":65536},"applied_rate":{"type":"number","format":"float","example":0.075,"minimum":0,"maximum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A decimal value representing the rate that should be applied to a taxed entity. For example, 0.075 would represent an applied tax percentage of 7.5%."},"children":[]}]}]}]},"rate":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A decimal value representing the rate that should be applied to a taxed entity. For example, 0.075 would represent an applied tax percentage of 7.5%."},"children":[]}]}]}],"minLength":0,"maxLength":255,"example":"0.075000"},"is_active":{"type":"boolean","description":"Whether the tax rate is active.","example":true},"is_inclusive":{"type":"boolean","description":"Whether the tax rate is inclusive.","example":true}},"required":["object","id"],"additionalProperties":false}},"components/schemas/Tax":{"id":"components/schemas/Tax","kind":"json-schema","title":"Tax","data":{"title":"Tax","type":"object","description":"A tax represents the application of a tax rate to a taxed entity, such as an order or order item.","properties":{"object":{"type":"string","description":"String representing the object's type.","minLength":0,"maxLength":255,"example":"TAX"},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"total_tax_amount":{"type":"integer","example":2099,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the total calculated tax for this tax rate for all applicable order items."},"children":[]}]}]}],"minimum":0},"applied_rate":{"type":"number","format":"float","example":0.075,"minimum":0,"maximum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A decimal value representing the rate of the parent tax rate at the time of this tax application. For example, 0.075 would represent an applied tax percentage of 7.5%."},"children":[]}]}]}]},"tax_rate":{"$ref":"#/components/schemas/TaxRate"}},"required":["object","id"],"additionalProperties":false}},"components/schemas/CompanyTeamMemberPermission":{"id":"components/schemas/CompanyTeamMemberPermission","kind":"json-schema","title":"CompanyTeamMemberPermission","data":{"title":"CompanyTeamMemberPermission","type":"object","description":"A permission for a team member of a company.","properties":{"object":{"type":"string","minLength":10,"maxLength":10,"enum":["PERMISSION"],"example":"PERMISSION","description":"A canonical value representing a resource."},"name":{"type":"string","description":"The name of the permission","example":"ACTIVITY_LOG_VIEW","minLength":0,"maxLength":255,"enum":["ACTIVITY_LOG_VIEW","APP_STORE_VIEW_ANY","APPOINTMENTS_MANAGE","AVAILABILITY_VIEW_ANY","CALENDAR_VIEW_ANY","CUSTOMER_CREATE","CUSTOMER_DELETE","CUSTOMER_EXPORT_CREATE","CUSTOMER_IMPORT_CREATE","CUSTOMER_VIEW_ANY","FEE_VIEW_ANY","LISTING_CREATE","LISTING_DELETE","LISTING_MERGE","LISTING_VIEW_ANY","MEDIA_REQUEST_MANAGE","ORDER_AMOUNT_VIEW_ANY","ORDER_FORM_VIEW_ANY","ORDER_NOTES_MANAGE","ORDER_VIEW_ANY","ORDERS_MANAGE","PAYMENT_METHODS_MANAGE","PAYROLL_MANAGE","PAYROLL_PERSONAL_MANAGE","PAYROLL_PERSONAL_VIEW","PRODUCT_VIEW_ANY","REPORT_VIEW_ANY","SETTINGS_MANAGE","TAX_VIEW_ANY","TERRITORY_VIEW_ANY","ZILLOW_MEDIA_EXCLUSIVES_MANAGE","SAVED_VIEWS_MANAGE"]}},"required":["name"],"additionalProperties":false}},"components/schemas/Fee":{"id":"components/schemas/Fee","kind":"json-schema","title":"Fee","data":{"title":"Fee","type":"object","description":"A fee that can be applied to an order.","properties":{"object":{"type":"string","minLength":3,"maxLength":3,"enum":["FEE"],"example":"FEE","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":["string","null"],"description":"The title of the fee.","minLength":0,"maxLength":65536,"example":"Flat Fee"},"type":{"type":"string","description":"The type of fee.","example":"FLAT","minLength":0,"maxLength":255,"enum":["FLAT","PERCENT","BASIC_METERED","GRADUATED_METERED","VOLUME_METERED","TERRITORY"]},"name":{"type":"string","description":"The name of the fee.","example":"Flat Fee","minLength":0,"maxLength":65536},"description":{"type":"string","description":"The description of the fee.","example":"Flat fee for the order","minLength":0,"maxLength":65536},"avalara_tax_code":{"type":["string","null"],"description":"The Avalara tax code for the fee.","example":"12345","minLength":0,"maxLength":65536},"quickbooks_item_id":{"type":["string","null"],"description":"The Quickbooks item ID for the fee.","example":"12345","minLength":0,"maxLength":65536},"amount":{"type":"number","description":"The amount of the fee.","example":100}},"required":["object","id"],"additionalProperties":false}},"components/schemas/CompanyTeamMember":{"id":"components/schemas/CompanyTeamMember","kind":"json-schema","title":"CompanyTeamMember","data":{"title":"CompanyTeamMember","type":["object","null"],"description":"A team member of a company.","properties":{"object":{"type":"string","minLength":19,"maxLength":19,"enum":["COMPANY_TEAM_MEMBER"],"example":"COMPANY_TEAM_MEMBER","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"calendar_color":{"type":["string","null"],"description":"Color code for calendar display, if assigned","example":"#FF0000","minLength":7,"maxLength":7},"permissions":{"type":"array","description":"List of permissions granted to the team member","items":{"$ref":"#/components/schemas/CompanyTeamMemberPermission"}},"restrictions":{"type":"array","description":"List of restrictions applied to the team member","items":{"type":"object","description":"A key-value pair of restriction data.","additionalProperties":false}},"is_service_provider":{"type":"boolean","description":"Indicates if the team member is a service provider","example":true},"external_id":{"type":["string","null"],"minLength":0,"maxLength":65536,"description":"External identifier for the team member, if any","example":"1234567890"},"company_user":{"$ref":"#/components/schemas/User"},"has_owner_role":{"type":["boolean","null"],"description":"Indicates if the team member has the owner role","example":true},"is_owner":{"type":["boolean","null"],"description":"Indicates if the team member is the owner","example":true},"invitation_accepted_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the company team member invitation was accepted","format":"date-time","minLength":27,"maxLength":27,"example":"2025-04-01T05:59:59.999999Z"},"role":{"type":["string","null"],"description":"The role of the team member","example":"ADMIN","enum":["ADMIN","MEMBER","OWNER"]},"status":{"type":["string","null"],"description":"The status of the team member","example":"active","enum":["active","invited","revoked"]},"is_active":{"type":["boolean","null"],"description":"Indicates if the team member is active","example":true},"is_invited":{"type":["boolean","null"],"description":"Indicates if the team member is invited","example":true},"is_revoked":{"type":["boolean","null"],"description":"Indicates if the team member is revoked","example":true},"scheduling_priority":{"type":["integer","null"],"description":"The scheduling priority of the team member","example":1},"created_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the company team member was created","format":"date-time","minLength":27,"maxLength":27,"example":"2025-04-01T05:59:59.999999Z"},"require_appointment_confirmation":{"type":["boolean","null"],"description":"Indicates if the team member requires appointment confirmation","example":true},"fees":{"type":"array","description":"The fees assigned to the team member","items":{"$ref":"#/components/schemas/Fee"}},"travel_fee_amount":{"type":["integer","null"],"description":"The travel fee amount in cents","example":1000},"travel_fee_is_estimated":{"type":["boolean","null"],"description":"Indicates if the travel fee is estimated","example":true},"restricted_customers":{"type":"array","description":"Customers that this team member is restricted from working with","items":{"$ref":"#/components/schemas/Group"}}},"required":["object","id","permissions","restrictions","is_service_provider"],"additionalProperties":false}},"components/schemas/TaskTemplate":{"id":"components/schemas/TaskTemplate","kind":"json-schema","title":"TaskTemplate","data":{"title":"TaskTemplate","type":"object","description":"A task template is a template for a task that can be assigned to a user.","properties":{"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"name":{"type":"string","example":"Complete 41 Drone Shots, Variant corporis","description":"The name of the task template.","minLength":0,"maxLength":255},"description":{"type":"string","example":"Complete 41 Drone Shots, Variant corporis","description":"The description of the task template.","minLength":0,"maxLength":65536},"product_variant":{"$ref":"#/components/schemas/ProductVariant"},"default_pay_run_item_amount":{"type":"integer","example":10000,"description":"The default pay run item amount of the task template."},"default_pay_run_item_amount_type":{"type":"string","example":"flat","description":"The default pay run item amount type of the task template.","enum":["flat","percentage"],"minLength":0,"maxLength":255},"pay_run_item_amount_overrides":{"type":"array","items":{"$ref":"#/components/schemas/PayRunItemAmountOverride"}}},"required":[],"additionalProperties":false}},"components/schemas/PayRunItemAmountOverride":{"id":"components/schemas/PayRunItemAmountOverride","kind":"json-schema","title":"PayRunItemAmountOverride","data":{"title":"PayRunItemAmountOverride","type":"object","description":"A pay run item amount override is an override for a pay run item amount.","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"task_template":{"$ref":"#/components/schemas/TaskTemplate"},"amount":{"type":"integer","example":10000,"description":"The amount of the pay run item amount override."},"amount_type":{"type":"string","example":"flat","description":"The type of the pay run item amount override.","enum":["flat","percentage"],"minLength":0,"maxLength":255}},"required":["id","task_template","amount","amount_type"],"additionalProperties":false}},"components/schemas/Task":{"id":"components/schemas/Task","kind":"json-schema","title":"Task","data":{"title":"Task","type":"object","description":"A task is a single unit of work that can be assigned to a user.","properties":{"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"name":{"type":"string","description":"The name of the task.","example":"Complete 41 Drone Shots, Variant corporis","minLength":0,"maxLength":255},"description":{"type":["string","null"],"description":"Detailed description of the task","example":"Complete 41 Drone Shots, Variant corporis","minLength":0,"maxLength":65536},"quantity":{"type":["integer","null"],"description":"Number of items or units for this task","example":1},"pay_run_item_amount":{"type":["number","null"],"description":"Payment amount associated with this task","example":10000},"due_at":{"type":["string","null"],"description":"Deadline for task completion","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"completed_at":{"type":["string","null"],"description":"When the task was completed","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"is_completed":{"type":"boolean","description":"Flag indicating whether the task is completed","example":true},"completed_by":{"$ref":"#/components/schemas/CompanyTeamMember"},"assignee":{"$ref":"#/components/schemas/CompanyTeamMember"},"task_template":{"$ref":"#/components/schemas/TaskTemplate"}},"required":["id","name","is_completed"],"additionalProperties":false}},"components/schemas/OrderItem":{"id":"components/schemas/OrderItem","kind":"json-schema","title":"OrderItem","data":{"title":"OrderItem","type":"object","description":"An individual service or charge of an order. Order items can capture products serviced by or fees applied to an order. ","properties":{"object":{"type":"string","minLength":10,"maxLength":10,"enum":["ORDER_ITEM"],"example":"ORDER_ITEM","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":"string","description":"The title of the item.","example":"Aerial Video","minLength":0,"maxLength":255},"subtitle":{"type":"string","description":"The sub title of the item.","example":"10 minute video","minLength":0,"maxLength":255},"sub_title":{"type":"string","description":"The sub title of the item.","example":"10 minute video","minLength":0,"maxLength":255},"description":{"type":"string","description":"The description of the item.","example":"A fly-by drone video of the property.","minLength":0,"maxLength":255},"purchasable_type":{"type":"string","description":"The type of order item.","enum":["PRODUCT_VARIANT","FEE","CUSTOM"],"minLength":0,"maxLength":255,"example":"FEE"},"amount":{"type":"integer","example":2099,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the cost of a single instance of this item. This is multiplied by the quantity to calculate what was or will be charged. Legacy version of unit_price_amount."},"children":[]}]}]}],"minimum":0},"unit_price_amount":{"type":"integer","example":2099,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the cost of a single instance of this item. This is multiplied by the quantity to calculate what was or will be charged."},"children":[]}]}]}],"minimum":0},"quantity":{"type":"integer","example":2,"description":"A positive integer representing the number of instances of this item that was or will be serviced.","minimum":0},"gross_total_amount":{"type":"integer","example":4198,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the total cost of this item (before discounts and taxes have been applied) to be charge."},"children":[]}]}]}],"minimum":0},"appointment":{"$ref":"#/components/schemas/Appointment"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/DiscountAmount"}},"order":{"$ref":"#/components/schemas/Order"},"product":{"$ref":"#/components/schemas/Product"},"product_variant":{"$ref":"#/components/schemas/ProductVariant"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"is_serviceable":{"type":"boolean","description":"Whether the order item is serviceable.","example":true},"tasks":{"type":"array","description":"The tasks associated with the order item.","items":{"$ref":"#/components/schemas/Task"}},"is_canceled":{"type":"boolean","description":"Whether the order item is canceled.","example":true}},"required":["id"],"additionalProperties":false}},"components/schemas/BookingLimits":{"id":"components/schemas/BookingLimits","kind":"json-schema","title":"BookingLimits","data":{"title":"BookingLimits","type":"object","description":"Booking limits and scheduling configuration","properties":{"object":{"type":"string","minLength":7,"maxLength":7,"enum":["COMPANY"],"example":"COMPANY","description":"A canonical value representing a resource."},"use_territory_awareness":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default uses territories to filter available users and products."},"availability_style":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"TIME","description":"The scheduling style the order form should use for timeslot selection by default.","enum":["TIME","TIME_OF_DAY","LEGACY","DATETIME_PICKER"]},"slot_interval_minutes":{"type":["integer","null"],"example":60,"description":"How frequently slotted available times are on the order form by default."},"use_automated_user_assignment":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form uses auto-assignment of users to appointments."},"automated_user_assignment_strategy":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"RECOMMENDED","description":"The default assignment strategy the order form should use to assign users to appointments, if applicable.","enum":["RECOMMENDED","HOURS_PRIORITY","DISTANCE","ROUND_ROBIN","PRIORITY_LIST"]},"show_user_names":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default should display user's names after they have been assigned to an appointment."},"use_instant_appointment_scheduling":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default instantly schedules appointments as soon as the order is placed."},"is_twilight_visible":{"type":["boolean","null"],"description":"Whether twilight hours are visible","example":true}},"required":["object","use_territory_awareness","availability_style","slot_interval_minutes","use_automated_user_assignment","automated_user_assignment_strategy","show_user_names","use_instant_appointment_scheduling","is_twilight_visible"],"additionalProperties":false}},"components/schemas/OrderPaymentCollectionSource":{"id":"components/schemas/OrderPaymentCollectionSource","kind":"json-schema","title":"OrderPaymentCollectionSource","data":{"title":"OrderPaymentCollectionSource","type":"string","description":"The source of the payment collection.","example":"CASH","minLength":1,"maxLength":255,"enum":["PAYPAL","VENMO","ZELLE","STRIPE","SQUARE","QUICKBOOKS","CONCIERGE","CASH","CHECK","OTHER"]}},"components/schemas/Payment":{"id":"components/schemas/Payment","kind":"json-schema","title":"Payment","data":{"title":"Payment","description":"A payment is a single unit of payment that can be applied to an order.","type":"object","properties":{"object":{"type":"string","minLength":13,"maxLength":13,"enum":["ORDER_PAYMENT"],"example":"ORDER_PAYMENT","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"type":{"type":"string","description":"Payment type","minLength":0,"maxLength":255,"example":"MANUAL","enum":["MANUAL","CREDIT","CHECKOUT"]},"collection_source":{"$ref":"#/components/schemas/OrderPaymentCollectionSource"},"completed_at":{"type":["string","null"],"description":"Timestamp when the payment was completed","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"applicable_amount":{"type":"integer","description":"The applicable amount for the payment","example":502},"tip_amount":{"type":"integer","description":"The tip amount included in the payment","example":100},"total_amount":{"type":"integer","description":"The total payment amount","example":502},"collected_amount":{"type":"integer","description":"The amount actually collected","example":502},"order":{"$ref":"#/components/schemas/Order"}},"required":["object","id","type","collection_source","completed_at","applicable_amount","tip_amount","total_amount","collected_amount"],"additionalProperties":false}},"components/schemas/AppointmentAttendance":{"id":"components/schemas/AppointmentAttendance","kind":"json-schema","title":"AppointmentAttendance","data":{"title":"AppointmentAttendance","type":"object","description":"An appointment attendance.","properties":{"object":{"type":"string","minLength":22,"maxLength":22,"enum":["APPOINTMENT_ATTENDANCE"],"example":"APPOINTMENT_ATTENDANCE","description":"A canonical value representing a resource."},"id":{"type":["number","null"],"description":"ID of the appointment attendance.","example":1234567890,"minimum":0,"maximum":9223372036854776000},"company_team_member":{"$ref":"#/components/schemas/CompanyTeamMember"},"zillow_3d_home_deep_link_url":{"type":["string","null"],"description":"URL to Zillow 3D home tour if available","minLength":0,"maxLength":65535,"example":"https://aryeo.com","format":"uri"},"requires_confirmation":{"type":["boolean","null"],"description":"Indicates if the attendance requires confirmation.","example":true},"is_requested":{"type":"boolean","description":"Indicates if attendance was requested","example":true},"accepted_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when attendance was accepted.","format":"date-time","minLength":27,"maxLength":27,"example":"2025-04-01T05:59:59.999999Z"},"declined_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when attendance was declined.","format":"date-time","minLength":27,"maxLength":27,"example":"2025-04-01T05:59:59.999999Z"}},"required":["object","id","company_team_member","is_requested"],"additionalProperties":false}},"components/schemas/AppointmentCollection":{"id":"components/schemas/AppointmentCollection","kind":"json-schema","title":"AppointmentCollection","data":{"title":"AppointmentCollection","type":"object","description":"A collection of appointments.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Appointment"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/AppointmentResource":{"id":"components/schemas/AppointmentResource","kind":"json-schema","title":"AppointmentResource","data":{"title":"AppointmentResource","type":"object","description":"An appointment.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Appointment"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/AppointmentUpdatePutPayload":{"id":"components/schemas/AppointmentUpdatePutPayload","kind":"json-schema","title":"AppointmentUpdatePutPayload","data":{"title":"AppointmentUpdatePutPayload","type":"object","description":"Payload for updating an appointment record.","properties":{"start_at":{"type":["string","null"],"description":"The new date and time (ISO 8601 format) when the appointment is set to start.","example":"2021-06-30T20:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"end_at":{"type":["string","null"],"description":"The new date and time (ISO 8601 format) when the appointment is set to end.","example":"2021-06-30T21:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"user_ids":{"type":"array","description":"Array of user IDs to attach to the appointment.","items":{"description":"ID of a user. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"item_ids":{"type":"array","description":"Array of order item IDs to attach to the appointment.","items":{"description":"ID of an order item. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"company_team_member_ids":{"type":"array","description":"Array of company team member IDs to attach to the appointment.","items":{"description":"ID of a company team member. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"duration_minutes":{"type":["integer","null"],"description":"The duration of the appointment in minutes.","example":60,"minimum":1},"notify":{"type":["boolean","null"],"description":"Sends a notification to the appointment's order's customer that the appointment was canceled.","example":true}},"additionalProperties":false}},"components/schemas/AppointmentCancelPutPayload":{"id":"components/schemas/AppointmentCancelPutPayload","kind":"json-schema","title":"AppointmentCancelPutPayload","data":{"title":"AppointmentCancelPutPayload","type":"object","description":"Payload for canceling an appointment record.","properties":{"notify":{"type":["boolean","null"],"description":"Sends a notification to the appointment's order's customer that the appointment was canceled.","example":true}},"additionalProperties":false}},"components/schemas/AppointmentPostponePutPayload":{"id":"components/schemas/AppointmentPostponePutPayload","kind":"json-schema","title":"AppointmentPostponePutPayload","data":{"title":"AppointmentPostponePutPayload","type":"object","description":"Payload for postponing an appointment record.","properties":{"notify":{"type":["boolean","null"],"description":"Sends a notification to the appointment's order's customer that the appointment was postponed.","example":true},"waive_fee":{"type":["boolean","null"],"description":"Waives the late postponement fee for the appointment.","example":true}},"additionalProperties":false}},"components/schemas/AppointmentReschedulePutPayload":{"id":"components/schemas/AppointmentReschedulePutPayload","kind":"json-schema","title":"AppointmentReschedulePayload","data":{"title":"AppointmentReschedulePayload","type":"object","description":"Payload for rescheduling an appointment record.","properties":{"start_at":{"type":["string","null"],"description":"The new date and time (ISO 8601 format) when the appointment is set to start.","example":"2021-06-30T20:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"end_at":{"type":["string","null"],"description":"The new date and time (ISO 8601 format) when the appointment is set to end.","example":"2021-06-30T21:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"notify":{"type":["boolean","null"],"description":"Send a notification to the appointment's order's customer that the appointment was rescheduled.","example":true}},"required":["start_at","end_at"],"additionalProperties":false}},"components/schemas/AppointmentAcceptPutPayload":{"id":"components/schemas/AppointmentAcceptPutPayload","kind":"json-schema","title":"AppointmentAcceptPutPayload","data":{"title":"AppointmentAcceptPutPayload","type":"object","description":"Payload for accepting an appointment record.","properties":[],"additionalProperties":false}},"components/schemas/AppointmentDeclinePutPayload":{"id":"components/schemas/AppointmentDeclinePutPayload","kind":"json-schema","title":"AppointmentDeclinePutPayload","data":{"title":"AppointmentDeclinePutPayload","type":"object","description":"Payload for declining an appointment record.","properties":{"reason":{"type":["string","null"],"description":"The reason for declining the appointment. This reason must match one of the options provided by the company.","example":"I am unable to attend this appointment.","minLength":0,"maxLength":255}},"additionalProperties":false}},"components/schemas/AppointmentSchedulePutPayload":{"id":"components/schemas/AppointmentSchedulePutPayload","kind":"json-schema","title":"AppointmentSchedulePutPayload","data":{"title":"AppointmentSchedulePutPayload","type":"object","description":"Payload for updating an appointment schedule.","properties":{"auto_confirm":{"type":["boolean","null"],"description":"Automatically confirms the appointment without requiring confirmation from the customer.","example":true},"waive_fee":{"type":["boolean","null"],"description":"Waives the late postponement fee for the appointment.","example":true},"start_at":{"type":["string","null"],"description":"The new date and time (ISO 8601 format) when the appointment is set to start.","example":"2021-06-30T20:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"end_at":{"type":["string","null"],"description":"The new date and time (ISO 8601 format) when the appointment is set to end.","example":"2021-06-30T21:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"notify":{"type":["boolean","null"],"description":"Send a notification to the appointment's order's customer that the appointment was rescheduled.","example":true},"company_team_member_ids":{"type":["array","null"],"items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","minLength":36,"maxLength":36,"description":"The IDs of the company team members assigned to the appointment."}},"user_ids":{"type":["array","null"],"items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","minLength":36,"maxLength":36,"description":"The IDs of the user assigned to the appointment."}},"booking_scenario":{"type":["string","null"],"enum":["unknown","suggested_date_time","suggested_time_for_day","full_calendar"],"description":"Tracks how the user selected this appointment time for analytics.","example":"full_calendar"},"suggested_appointments_shown":{"type":["boolean","null"],"description":"Whether suggested appointment options were displayed to the user.","example":true,"default":false}},"required":["start_at","end_at"],"additionalProperties":false}},"components/schemas/AvailabilityResponse":{"id":"components/schemas/AvailabilityResponse","kind":"json-schema","title":"AvailabilityResponse","data":{"title":"AvailabilityResponse","type":"object","description":"Availability response.","properties":{"has_conflicts":{"type":"boolean","description":"Indicates if there are any conflicts with the appointment.","example":true}},"required":["has_conflicts"],"additionalProperties":false}},"components/schemas/Appointment3dhTourLinkResponse":{"id":"components/schemas/Appointment3dhTourLinkResponse","kind":"json-schema","title":"Appointment3dhTourLinkResponse","data":{"title":"Appointment3dhTourLinkResponse","type":"object","description":"Appointment 3D Home Capture link response.","properties":{"url":{"type":"string","description":"The URL of the appointment 3D Home Capture link.","example":"https://www.zillow.com/3d-home-tour/1234567890","format":"uri","minLength":1,"maxLength":65535},"last_tour_started_at":{"type":["string","null"],"description":"The date and time the last tour started.","example":"2021-01-01 12:00:00"},"last_tour_started_by":{"type":["string","null"],"description":"The user who started the last tour.","example":"John Doe"}},"required":["url"],"additionalProperties":false}},"components/schemas/AppointmentItemsPutPayload":{"id":"components/schemas/AppointmentItemsPutPayload","kind":"json-schema","title":"AppointmentItemsPutPayload","data":{"title":"AppointmentItemsPutPayload","type":"object","description":"Payload for syncing the items attached to an appointment.","properties":{"item_ids":{"type":"array","description":"Array of order item IDs to attach to the appointment.","items":{"description":"ID of an order item. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}}},"required":["item_ids"],"additionalProperties":false}},"components/schemas/AppointmentStorePostPayload":{"id":"components/schemas/AppointmentStorePostPayload","kind":"json-schema","title":"AppointmentStorePostPayload","data":{"title":"AppointmentStorePostPayload","type":"object","properties":{"order_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"The ID of the order to attach to the appointment.","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"address_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"The ID of the address to attach to the appointment. If the order already has an address, this field is ignored.","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"start_at":{"type":"string","description":"The new date and time (ISO 8601 format) when the appointment is set to start.","example":"2021-06-30T20:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"end_at":{"type":"string","description":"The new date and time (ISO 8601 format) when the appointment is set to end.","example":"2021-06-30T21:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"company_team_member_ids":{"type":"array","description":"Array of company team member IDs to attach to the appointment.","items":{"description":"ID of a company team member. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"item_ids":{"type":"array","description":"Array of order item IDs to attach to the appointment.","items":{"description":"ID of an order item. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"notify":{"type":"boolean","description":"Sends a notification to the attached company team members and customer.","example":true},"notifyCompany":{"type":"boolean","description":"Sends a notification to the attached company team members.","example":true},"notifyCustomer":{"type":"boolean","description":"Sends a notification to the attached customer.","example":true},"user_ids":{"type":"array","description":"DEPRECATED: Array of user IDs to attach to the appointment.","items":{"description":"ID of a user. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}}},"additionalProperties":false,"required":["order_id","start_at","end_at"]}},"components/schemas/AuthEmailCheckPostPayload":{"id":"components/schemas/AuthEmailCheckPostPayload","kind":"json-schema","title":"AuthEmailCheckPostPayload","data":{"type":"object","title":"AuthEmailCheckPostPayload","description":"An email.","properties":{"email":{"type":"string","description":"An email.","format":"email","example":"john.doe@gmail.com","minLength":0,"maxLength":255}},"required":["email"],"additionalProperties":false}},"components/schemas/AuthActivationStageResource":{"id":"components/schemas/AuthActivationStageResource","kind":"json-schema","title":"AuthActivationStageResource","data":{"title":"AuthActivationStageResource","type":"object","description":"A status representing an email/user's activation stage.","properties":{"status":{"type":"string","example":"ACTIVE","description":"A status representing an email/user's activation stage.","maxLength":255,"minLength":1,"enum":["ACTIVE","INVITED","NEW"]},"has_admin_account":{"type":"boolean","example":true,"description":"Indicates if the email is associated with an admin account."}},"additionalProperties":false}},"components/schemas/SetupIntentResponse":{"id":"components/schemas/SetupIntentResponse","kind":"json-schema","title":"SetupIntentResponse","data":{"type":"object","title":"SetupIntentResponse","description":"A SetupIntentResponse contains the information pertaining to the SetupIntent.","properties":{"client_secret":{"type":["string","null"],"description":"The client secret for the SetupIntent.","example":"abc-123","minLength":1,"maxLength":255}},"required":["client_secret"],"additionalProperties":false}},"components/schemas/BlockPostPayload":{"id":"components/schemas/BlockPostPayload","kind":"json-schema","title":"BlockPostPayload","data":{"type":"object","title":"BlockPostPayload","description":"Payload for creating a block.","properties":{"company_team_member_ids":{"type":["array","null"],"description":"The IDs of the company team members assigned to the block.","items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","minLength":36,"maxLength":36,"description":"The IDs of the company team members assigned to the block."}},"user_ids":{"type":["array","null"],"description":"The IDs of the users assigned to the block.","items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","minLength":36,"maxLength":36,"description":"The IDs of the users assigned to the block."}},"start_at":{"type":"string","format":"date-time","example":"2020-10-04T12:15:00Z","minLength":20,"maxLength":20,"description":"The start time of the block (ISO 8601 format)."},"end_at":{"type":"string","format":"date-time","example":"2020-10-04T12:30:00Z","minLength":20,"maxLength":20,"description":"The end time of the block (ISO 8601 format)."},"title":{"type":"string","example":"Other appointment","minLength":0,"maxLength":255,"description":"The title of the block."},"description":{"type":["string","null"],"example":"This is a description of the block.","minLength":0,"maxLength":2000,"description":"The description of the block."}},"additionalProperties":false,"required":["start_at","end_at","title"]}},"components/schemas/CalendarEvent":{"id":"components/schemas/CalendarEvent","kind":"json-schema","title":"CalendarEvent","data":{"description":"A calendar event.","type":"object","title":"CalendarEvent","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","minLength":36,"maxLength":36,"description":"The ID of the calendar event."},"type":{"type":"string","example":"appointment","minLength":0,"maxLength":255,"description":"The type of the calendar event.","enum":["APPOINTMENT","CALENDAR_BLOCK","EXTERNAL","BUFFER","DECLINED_APPOINTMENT","UNSCHEDULED_APPOINTMENT"]},"title":{"type":"string","example":"Other appointment","minLength":0,"maxLength":255,"description":"The title of the calendar event."},"description":{"type":["string","null"],"example":"sdjsudsudsds","minLength":0,"maxLength":2000,"description":"The description of the calendar event."},"start_at":{"type":["string","null"],"format":"date-time","example":"2020-10-04T12:15:00Z","minLength":20,"maxLength":20,"description":"The start time of the calendar event (ISO 8601 format)."},"end_at":{"type":["string","null"],"format":"date-time","example":"2020-10-04T12:30:00Z","minLength":20,"maxLength":20,"description":"The end time of the calendar event (ISO 8601 format)."},"is_all_day":{"type":"boolean","description":"Is the calendar event all day?","example":true},"duration":{"type":"integer","example":60,"description":"The duration of the calendar event in minutes."},"is_busy":{"type":"boolean","example":true,"description":"Is the calendar event busy?"},"requires_confirmation":{"type":"boolean","example":true,"description":"Does the calendar event require confirmation?"}},"required":[],"additionalProperties":false}},"components/schemas/CalendarEventResource":{"id":"components/schemas/CalendarEventResource","kind":"json-schema","title":"CalendarEventResource","data":{"title":"CalendarEventResource","type":"object","description":"The calendar event resource.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/CalendarEvent"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CalendarBlock":{"id":"components/schemas/CalendarBlock","kind":"json-schema","title":"CalendarBlock","data":{"description":"A calendar block.","type":"object","title":"CalendarBlock","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","minLength":36,"maxLength":36,"description":"The ID of the calendar event."},"type":{"type":"string","example":"appointment","minLength":0,"maxLength":255,"description":"The type of the calendar event.","enum":["APPOINTMENT","CALENDAR_BLOCK","EXTERNAL","BUFFER","DECLINED_APPOINTMENT","UNSCHEDULED_APPOINTMENT"]},"title":{"type":"string","example":"Other appointment","minLength":0,"maxLength":255,"description":"The title of the calendar event."},"description":{"type":["string","null"],"example":"sdjsudsudsds","minLength":0,"maxLength":2000,"description":"The description of the calendar event."},"start_at":{"type":"string","format":"date-time","example":"2020-10-04T12:15:00Z","minLength":20,"maxLength":20,"description":"The start time of the calendar event (ISO 8601 format)."},"end_at":{"type":"string","format":"date-time","example":"2020-10-04T12:30:00Z","minLength":20,"maxLength":20,"description":"The end time of the calendar event (ISO 8601 format)."},"is_all_day":{"type":"boolean","description":"Is the calendar event all day?","example":true},"duration":{"type":"integer","example":60,"description":"The duration of the calendar event in minutes."},"is_busy":{"type":"boolean","example":true,"description":"Is the calendar event busy?"},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"company_team_members":{"type":"array","items":{"$ref":"#/components/schemas/CompanyTeamMember"}}},"required":["id","type","title","description","start_at","end_at","is_all_day","duration","is_busy"],"additionalProperties":false}},"components/schemas/CalendarBlockResource":{"id":"components/schemas/CalendarBlockResource","kind":"json-schema","title":"CalendarBlockResource","data":{"title":"CalendarBlockResource","type":"object","description":"The calendar block resource.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/CalendarBlock"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CompanyTeamMemberCollection":{"id":"components/schemas/CompanyTeamMemberCollection","kind":"json-schema","title":"CompanyTeamMemberCollection","data":{"title":"CompanyTeamMemberCollection","type":"object","description":"A collection of company team members","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/CompanyTeamMember"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CompanyTeamMemberResource":{"id":"components/schemas/CompanyTeamMemberResource","kind":"json-schema","title":"CompanyTeamMemberResource","data":{"title":"CompanyTeamMemberResource","type":"object","description":"The company team member resource.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/CompanyTeamMember"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"strategy_type":{"type":"string","enum":["DISTANCE","HOURS_PRIORITY","ROUND_ROBIN","RECOMMENDED","PRIORITY_LIST"],"example":"DISTANCE","minLength":0,"maxLength":255,"description":"The strategy type to use for assignment scheduling."}},"required":["status"],"additionalProperties":false}},"components/schemas/CalendarEventCollection":{"id":"components/schemas/CalendarEventCollection","kind":"json-schema","title":"CalendarEventCollection","data":{"title":"CalendarEventCollection","type":"object","description":"A collection of calendar events","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/CalendarEvent"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CouponCollection":{"id":"components/schemas/CouponCollection","kind":"json-schema","title":"CouponCollection","data":{"title":"CouponCollection","type":"object","description":"A collection of coupons.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Coupon"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CustomerTeamMembershipResource":{"id":"components/schemas/CustomerTeamMembershipResource","kind":"json-schema","title":"CustomerTeamMembershipResource","data":{"title":"CustomerTeamMembershipResource","type":"object","description":"A customer team membership.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/CustomerTeamMembership"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CustomerTeamMembershipCollection":{"id":"components/schemas/CustomerTeamMembershipCollection","kind":"json-schema","title":"CustomerTeamMembershipCollection","data":{"title":"CustomerTeamMembershipCollection","type":"object","description":"A collection of customer team memberships","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/CustomerTeamMembership"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CustomerTeamNotesPutPayload":{"id":"components/schemas/CustomerTeamNotesPutPayload","kind":"json-schema","title":"CustomerTeamNotesPutPayload","data":{"title":"CustomerTeamNotesPutPayload","type":"object","description":"Payload for updating customer team notes.","properties":{"internal_notes":{"type":["string","null"],"description":"Internal notes for the customer team.","minLength":0,"maxLength":65535,"example":"These are internal notes about the customer team."}},"additionalProperties":false}},"components/schemas/CustomerTeamResource":{"id":"components/schemas/CustomerTeamResource","kind":"json-schema","title":"CustomerTeamResource","data":{"title":"CustomerTeamResource","type":"object","description":"A customer team.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/CustomerGroup"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CustomerTeamAffiliateMembershipPostPayload":{"id":"components/schemas/CustomerTeamAffiliateMembershipPostPayload","kind":"json-schema","title":"CustomerTeamAffiliateMembershipPostPayload","data":{"title":"CustomerTeamAffiliateMembershipPostPayload","type":"object","description":"Payload for adding an affiliate membership to a customer team.","properties":{"affiliate_id":{"type":"string","description":"The ID of the affiliate to add to the customer team.","example":"1234567890","minLength":0,"maxLength":255},"customer_user_id":{"type":"string","description":"The ID of the customer user to add to the customer team.","example":"00000000-0000-4000-8000-000000000000","format":"uuid","minLength":36,"maxLength":36}},"required":["affiliate_id","customer_user_id"],"additionalProperties":false}},"components/schemas/TagsPutPayload":{"id":"components/schemas/TagsPutPayload","kind":"json-schema","title":"TagsPutPayload","data":{"title":"TagsPutPayload","type":"object","description":"Payload for updating a tag.","properties":{"tag_ids":{"type":"array","description":"The IDs of the tags to update for the given resource.","items":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"example":"00000000-0000-4000-8000-000000000000","description":"The ID of the tag to update for the given resource."}}},"required":["tag_ids"],"additionalProperties":false}},"components/schemas/TagsPostPayload":{"id":"components/schemas/TagsPostPayload","kind":"json-schema","title":"TagsPostPayload","data":{"title":"TagsPostPayload","type":"object","description":"Payload for adding a tag to a customer team.","properties":{"tag_id":{"type":["string","null"],"description":"The ID of the tag to add to the customer team.","example":"00000000-0000-4000-8000-000000000000","format":"uuid","minLength":36,"maxLength":36},"tag":{"type":["object","null"],"description":"The tag to add to the customer team.","properties":{"name":{"type":"string","description":"The name of the tag.","example":"Photography","minLength":0,"maxLength":65536},"color":{"type":"string","description":"The color of the tag.","example":"#FFFFFF","minLength":0,"maxLength":7},"type":{"type":"string","description":"The type of the tag.","example":"customer_team","minLength":0,"maxLength":65536,"enum":["order","customer_team","product","order_form","virtual_staging_ai"]}},"required":["name","color"],"additionalProperties":false}},"additionalProperties":false}},"components/schemas/CustomerUserCollection":{"id":"components/schemas/CustomerUserCollection","kind":"json-schema","title":"CustomerUserCollection","data":{"title":"CustomerUserCollection","type":"object","description":"A collection of customer users.","properties":{"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/CustomerUser"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["data"],"additionalProperties":false}},"components/schemas/CustomerUserPostPayload":{"id":"components/schemas/CustomerUserPostPayload","kind":"json-schema","title":"CustomerUserPostPayload","data":{"title":"CustomerUserPostPayload","type":"object","properties":{"first_name":{"type":"string","description":"First name.","example":"John","minLength":0,"maxLength":255},"last_name":{"type":"string","description":"Last name.","example":"Doe","minLength":0,"maxLength":255},"email":{"type":"string","description":"Email address of the user.","example":"john.doe@gmail.com","minLength":0,"maxLength":255},"phone":{"type":["string","null"],"example":"(123) 456-7890","minLength":0,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens)."},"children":[]}]}]}]},"license_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"12345678","description":"The license number of a real estate agent."},"avatar_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/300","description":"The avatar image URL of a user.","minLength":0,"maxLength":255},"add_to_customer_team":{"type":"boolean","description":"Whether to add the user to a customer team.","example":true},"customer_team_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the customer team to add the user to. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_to_customer_team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"123e4567-e89b-12d3-a456-426614174000","minLength":0,"maxLength":255},"role":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The role of the user in the customer team. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_to_customer_team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"admin","minLength":0,"maxLength":255,"enum":["admin","member"]},"defines_new_team":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to define a new team for the user. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_to_customer_team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the new team. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defines_new_team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"John Doe Reality","minLength":0,"maxLength":255},"description":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the new team. Used if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defines_new_team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Internal notes about the team.","minLength":0,"maxLength":2550},"brokerage_name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the brokerage. Used if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defines_new_team"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"John Doe Realty","minLength":0,"maxLength":255},"timezone":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The default timezone for the customer.","example":"America/New_York"}},"additionalProperties":false,"required":["first_name","last_name","email","add_to_customer_team"]}},"components/schemas/GroupCustomer":{"id":"components/schemas/GroupCustomer","kind":"json-schema","title":"GroupCustomer","data":{"type":"object","title":"GroupCustomer","description":"A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.","properties":{"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same schema.","example":"GROUP","minLength":1,"maxLength":100},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"type":{"type":"string","example":"AGENT","description":"The type of the group. Can be CREATOR, AGENT, or BROKERAGE, and may dictate the attributes of the group returned.","minLength":0,"maxLength":255,"enum":["CREATOR","AGENT","BROKERAGE"]},"name":{"type":"string","maxLength":255,"minLength":0,"description":"The name of the group.","example":"John Doe Reality"},"email":{"type":["string","null"],"format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"The email address of a group."},"phone":{"type":["string","null"],"example":"6175550173","minLength":0,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A phone number represented in whichever standards specified by the group, typically ###-###-#### (separated by hyphens)."},"children":[]}]}]}]},"website_url":{"type":["string","null"],"example":"https://www.aryeo.com","minLength":0,"maxLength":255,"description":"The website URL of a group.","format":"uri"},"logo_url":{"type":["string","null"],"description":"The logo URL of a group.","format":"uri","minLength":0,"maxLength":255,"example":"https://picsum.photos/300"},"office_name":{"type":["string","null"],"example":"John Doe Brokerage","minLength":0,"maxLength":255,"description":"The name of the brokerage or team of a real estate agent. Only returned if group's type is AGENT."},"license_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"12345678","description":"The license number of a real estate agent. Only returned if group's type is AGENT."},"timezone":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The default timezone for the group.","example":"America/New_York"},"currency":{"type":"string","minLength":0,"maxLength":255,"example":"USD","description":"The default currency for the group.","enum":["USD","CAD","GBP","CHF","EUR","AUD","NZD","ZAR","DKK"]},"slug":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The slug for the group.","example":"example-photography"},"order_page_url":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The order page URL for the group.","example":"https://example-photography.aryeo.com/order"},"feature_flags":{"$ref":"#/components/schemas/FeatureFlags"},"order_page_background_color":{"type":["string","null"],"maxLength":7,"minLength":7,"description":"The background color for the order page (has a hex value) for the group.","example":"#FF0000"},"default_order_form":{"$ref":"#/components/schemas/OrderForm"},"use_territory_awareness":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default uses territories to filter available users and products."},"availability_style":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"TIME","description":"The scheduling style the order form should use for timeslot selection by default.","enum":["TIME","TIME_OF_DAY","LEGACY"]},"slot_interval_minutes":{"type":["integer","null"],"example":60,"description":"How frequently slotted available times are on the order form by default."},"use_automated_user_assignment":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form uses auto-assignment of users to appointments."},"automated_user_assignment_strategy":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"RECOMMENDED","description":"The default assignment strategy the order form should use to assign users to appointments, if applicable.","enum":["RECOMMENDED","HOURS_PRIORITY","DISTANCE","ROUND_ROBIN","PRIORITY_LIST"]},"show_user_names":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default should display user's names after they have been assigned to an appointment."},"use_instant_appointment_scheduling":{"type":["boolean","null"],"example":true,"description":"Indicates if the order form by default instantly schedules appointments as soon as the order is placed."},"order_forms":{"type":["array","null"],"description":"An array of order forms a vendor group provides for placing orders. Only returned if group's type is CREATOR. ","items":{"$ref":"#/components/schemas/OrderForm"}},"users":{"type":["array","null"],"description":"The Aryeo users associated with this group.","items":{"$ref":"#/components/schemas/User"}},"is_brokerage_or_brokerage_agent":{"type":["boolean","null"],"example":true,"description":"Indicates if the group is a brokerage or brokerage agent."},"avatar_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/300","description":"The avatar image URL of a user.","minLength":0,"maxLength":255},"internal_notes":{"type":["string","null"],"description":"Internal notes about the group.","minLength":0,"maxLength":2550,"example":"Internal notes about the group."},"team_members":{"type":["array","null"],"description":"NOTE: Users do not have team members.","items":{"$ref":"#/components/schemas/User"}},"owner":{"$ref":"#/components/schemas/User"},"social_profiles":{"$ref":"#/components/schemas/SocialProfiles"},"customer_group":{"type":["string","null"],"description":"NOTE: Users do not have customer groups and they are deprecated.","minLength":0,"maxLength":2550,"example":"null"},"has_restricted_photographers":{"type":["boolean","null"],"description":"Whether the group is restricted from booking appointments with certain photographers.","example":true},"custom_field_entries":{"type":["array","null"],"description":"NOTE: Need to make a migration plan for this.","items":{"type":"object","description":"Custom field entries for the group.","additionalProperties":false}},"billing_address":{"type":["string","null"],"description":"The billing address of the group.","minLength":0,"maxLength":255,"example":"123 Main St, Anytown, USA 12345"},"created_at":{"type":["string","null"],"description":"The date and time the group was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"restricted_photographers":{"type":["array","null"],"description":"The photographers restricted from the group.","items":{"type":"object","description":"The photographers restricted from the group.","additionalProperties":false}},"customer_team_memberships":{"type":"array","description":"The list of customer team memberships associated with this group.","items":{"$ref":"#/components/schemas/CustomerTeamMembership"}},"is_visible":{"type":["boolean","null"],"description":"Indicates if the group is visible.","example":true},"order_index":{"type":["integer","null"],"description":"The order index of the group.","example":1},"verification_status":{"type":"string","description":"The verification status of the customer.","minLength":0,"maxLength":255,"example":"verified","enum":["verified","unverified","new","sso"]},"credit_balance_amount":{"type":["number","null"],"description":"The credit balance amount of the customer.","example":100},"total_balance_amount":{"type":["number","null"],"description":"The total balance amount of the customer.","example":100},"is_showingtimeplus_user":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the customer is a ShowingTime+ user."},"children":[]}]}]}],"example":true},"full_name":{"type":"string","description":"The full name of the customer.","minLength":0,"maxLength":255,"example":"John Doe"},"first_name":{"type":"string","description":"The first name of the customer.","minLength":0,"maxLength":255,"example":"John"},"last_name":{"type":"string","description":"The last name of the customer.","minLength":0,"maxLength":255,"example":"Doe"},"phone_number":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The phone number of the customer.","example":"1234567890"},"profile_link":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The profile link of the customer.","example":"https://picsum.photos/300"},"agent_company_name":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The agent company name of the customer.","example":"John Doe Real Estate"},"agent_license_number":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The agent license number of the customer.","example":"1234567890"},"is_blocked_from_ordering":{"type":"boolean","description":"Whether the customer is blocked from ordering.","example":true},"default_lock_downloads_before_payment":{"type":["boolean","null"],"description":"Whether the customer has locked media downloads before payment as the default download setting.","example":true},"default_allows_access_to_marketing_material":{"type":["boolean","null"],"description":"Whether the customer has access to the marketing material builder.","example":true},"avalara_customer_code":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The Avalara customer code of the customer.","example":"1234567890"},"quickbooks_customer_id":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"The Quickbooks customer ID of the customer.","example":"1234567890"}},"required":["id"],"additionalProperties":false}},"components/schemas/CreditTransaction":{"id":"components/schemas/CreditTransaction","kind":"json-schema","title":"CreditTransaction","data":{"title":"CreditTransaction","type":"object","description":"A customer user's credit transaction","properties":{"type":{"type":"string","minLength":5,"maxLength":6,"enum":["credit","debit"],"description":"The type of credit transaction","example":"credit"},"amount":{"type":"integer","minimum":1,"description":"The amount in cents","example":1},"description":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"Optional description of the transaction","example":"Transaction description"},"user_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the user associated with the transaction. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"posting_date":{"type":["string","null"],"format":"date","description":"The date the transaction was posted (YYYY-MM-DD)","example":"2025-01-01"},"created_at":{"type":"string","format":"date-time","description":"The date and time the transaction was created (ISO 8601)","minLength":25,"maxLength":25,"example":"2025-11-07T18:48:47+00:00"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the transaction was updated (ISO 8601)","minLength":25,"maxLength":25,"example":"2025-11-07T18:48:47+00:00"}},"required":["type","amount","user_id","created_at","updated_at"],"additionalProperties":false}},"components/schemas/CreditTransactionResource":{"id":"components/schemas/CreditTransactionResource","kind":"json-schema","title":"CreditTransactionResource","data":{"title":"CreditTransactionResource","type":"object","description":"A customer user's credit transaction resource","properties":{"data":{"$ref":"#/components/schemas/CreditTransaction"}},"required":["data"],"additionalProperties":false}},"components/schemas/GroupCustomerCollection":{"id":"components/schemas/GroupCustomerCollection","kind":"json-schema","title":"GroupCustomerCollection","data":{"title":"GroupCustomerCollection","type":"object","description":"A collection of group customers.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/GroupCustomer"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/CustomerPostPayload":{"id":"components/schemas/CustomerPostPayload","kind":"json-schema","title":"CustomerPostPayload","data":{"title":"CustomerPostPayload","type":"object","properties":{"owner_first_name":{"type":"string","description":"First name of the customer owner.","example":"John","minLength":0,"maxLength":255},"owner_last_name":{"type":"string","description":"Last name of the customer owner.","example":"Doe","minLength":0,"maxLength":255},"email":{"type":"string","description":"Email address of the customer owner.","example":"john.doe@gmail.com","minLength":0,"maxLength":255},"phone":{"type":["string","null"],"example":"(123) 456-7890","minLength":0,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens)."},"children":[]}]}]}]},"avatar_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/300","description":"The avatar image URL of the customer.","minLength":0,"maxLength":255},"logo_url":{"type":["string","null"],"format":"uri","example":"https://picsum.photos/300","description":"The logo image URL of the customer.","minLength":0,"maxLength":255},"website_url":{"type":["string","null"],"format":"uri","example":"https://www.john-doe-realty.com","description":"The website URL of the customer.","minLength":0,"maxLength":255},"team_name":{"type":["string","null"],"description":"The name of the customer team.","example":"John Doe Realty","minLength":0,"maxLength":255},"description":{"type":["string","null"],"description":"The description of the customer.","example":"John Doe Realty is a real estate company that specializes in selling homes in Space City.","minLength":0,"maxLength":2550},"office_name":{"type":["string","null"],"description":"The name of the office.","example":"John Doe Realty","minLength":0,"maxLength":255},"customer_team_id":{"type":["string","null"],"description":"The ID of the customer team.","example":"123e4567-e89b-12d3-a456-426614174000","minLength":0,"maxLength":255},"license_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"12345678","description":"The license number of a real estate agent."},"timezone":{"type":["string","null"],"maxLength":255,"minLength":0,"description":"The default timezone for the customer.","example":"America/New_York"}},"additionalProperties":false,"required":["owner_first_name","owner_last_name","email"]}},"components/schemas/GroupCustomerResource":{"id":"components/schemas/GroupCustomerResource","kind":"json-schema","title":"GroupCustomerResource","data":{"title":"GroupCustomerResource","type":"object","description":"A group.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/GroupCustomer"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/DeleteUserPostPayload":{"id":"components/schemas/DeleteUserPostPayload","kind":"json-schema","title":"DeleteUserPostPayload","data":{"type":"object","title":"DeleteUserPostPayload","description":"The user to create a delete request for.","properties":{"company_id":{"type":"string","description":"The ID of the company this user is associated with.","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"email":{"type":"string","description":"An email.","format":"email","example":"john.doe@gmail.com","minLength":1,"maxLength":255},"password":{"type":"string","description":"A password.","example":"P@$$w0Rd","minLength":1,"maxLength":255},"client":{"type":"string","description":"The type of client.","example":"IOS","minLength":1,"maxLength":255,"enum":["IOS","ANDROID","PHPUNIT"]}},"required":["email","password","company_id","client"],"additionalProperties":false}},"components/schemas/DiscountPostPayload":{"id":"components/schemas/DiscountPostPayload","kind":"json-schema","title":"DiscountPostPayload","data":{"title":"DiscountPostPayload","type":"object","description":"Payload for creating a discount.","properties":{"order_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the order apply this coupon to. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"coupon_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the coupon to apply. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"coupon_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data to construct an ad hoc coupon inline to apply to this order. If you create a coupon upfront, pass the coupon_id parameter. Otherwise, this coupon_data will be used to scaffold a new ad hoc Coupon."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"Name of the coupon displayed to customers on orders.","example":"VIP Customer Discount","minLength":0,"maxLength":255},"percent_off":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A decimal value representing the percent that will be taken off the subtotal of an order this coupon is applied to. For example, 0.500 would represent an applied discount of 50%, meaning an order with a subtotal of $100 would result in a balance of $50. Required if amount_off is null."},"children":[]}]}]}],"format":"float","example":0.075,"minimum":0,"maximum":1},"amount_off":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount that will be taken off the subtotal of any orders this coupon is applied to. Amount represented in the smallest currency unit (that is, 100 cents for $1.00). Required if percent_off is null."},"children":[]}]}]}],"example":2500}},"additionalProperties":false}},"required":["order_id"],"additionalProperties":false}},"components/schemas/DiscountResource":{"id":"components/schemas/DiscountResource","kind":"json-schema","title":"DiscountResource","data":{"title":"DiscountResource","type":"object","description":"A discount. ","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Discount"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/Dots":{"id":"components/schemas/Dots","kind":"json-schema","title":"Dots","data":{"title":"Dots","type":"object","description":"The number of appointments of a certain type on a specific date.","additionalProperties":{"type":"object","description":"The number of appointments by status.","properties":{"object":{"type":"string","minLength":9,"maxLength":9,"enum":["DOT_COUNT"],"example":"DOT_COUNT","description":"A canonical value representing a resource."},"scheduled":{"type":"integer","description":"The number of scheduled appointments on this date.","example":1},"unscheduled":{"type":"integer","description":"The number of unscheduled appointments on this date.","example":2},"cancelled":{"type":"integer","description":"The number of cancelled appointments on this date.","example":3}},"additionalProperties":false}}},"components/schemas/DotsResource":{"id":"components/schemas/DotsResource","kind":"json-schema","title":"DotsResource","data":{"title":"DotsResource","type":"object","description":"Dots representing appointments grouped by date.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Dots"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/DraftOrderCustomerUserPutPayload":{"id":"components/schemas/DraftOrderCustomerUserPutPayload","kind":"json-schema","title":"DraftOrderCustomerUserPutPayload","data":{"title":"DraftOrderCustomerUserPutPayload","type":"object","description":"Payload to update a customer user on a draft order.","properties":{"phone_number":{"type":"string","description":"E.164 formatted phone number including country code.","example":"+15551234567","minLength":4,"maxLength":16,"pattern":"^\\+[1-9]\\d{1,14}$"}},"additionalProperties":false}},"components/schemas/ForgotPasswordPostPayload":{"id":"components/schemas/ForgotPasswordPostPayload","kind":"json-schema","title":"ForgotPasswordPostPayload","data":{"title":"ForgotPasswordPostPayload","type":"object","description":"Payload for submitting a request to reset a forgotten password for a given user's email.","properties":{"company_id":{"type":"string","description":"If signing in as a customer user, the ID of company to request a password reset for.","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"email":{"type":"string","format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"Email."}},"required":["email"],"additionalProperties":false}},"components/schemas/ApiSuccess2xx":{"id":"components/schemas/ApiSuccess2xx","kind":"json-schema","title":"ApiSuccess2xx","data":{"type":"object","title":"ApiSuccess2xx","description":"A generic success response returned by the API.","properties":{"status":{"type":"string","example":"error","minLength":0,"maxLength":255,"description":"What was the state of the request?"}},"required":["status"],"additionalProperties":false}},"components/schemas/AryeoGoConfig":{"id":"components/schemas/AryeoGoConfig","kind":"json-schema","title":"AryeoGoConfig","data":{"title":"AryeoGoConfig","type":"object","description":"Configuration parameters for Aryeo Go app.","properties":{"object":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"ARYEO_GO_CONFIG"},"version_minimum":{"type":"string","description":"The minimum version of the app which should be installed on a user's device.","example":"2.0.0","minLength":1,"maxLength":65535},"version_latest_android":{"type":["string","null"],"description":"The latest released Android version for Aryeo Go.","example":"2.0.0","minLength":1,"maxLength":65535},"version_latest_ios":{"type":["string","null"],"description":"The latest released iOS version for Aryeo Go.","example":"2.0.0","minLength":1,"maxLength":65535}},"additionalProperties":false}},"components/schemas/AryeoGoConfigResource":{"id":"components/schemas/AryeoGoConfigResource","kind":"json-schema","title":"AryeoGoConfigResource","data":{"title":"AryeoGoConfigResource","type":"object","description":"The Aryeo Go app config.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/AryeoGoConfig"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/GroupCollection":{"id":"components/schemas/GroupCollection","kind":"json-schema","title":"GroupCollection","data":{"title":"GroupCollection","type":"object","description":"A collection of groups.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Group"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/GroupResource":{"id":"components/schemas/GroupResource","kind":"json-schema","title":"GroupResource","data":{"title":"GroupResource","type":"object","description":"A group.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Group"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/ListingCollection":{"id":"components/schemas/ListingCollection","kind":"json-schema","title":"ListingCollection","data":{"title":"ListingCollection","type":"object","description":"A collection of listings.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Listing"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/ListingPostPayload":{"id":"components/schemas/ListingPostPayload","kind":"json-schema","title":"ListingPostPayload","data":{"title":"ListingPostPayload","type":"object","description":"Payload for creating a listing.","properties":{"address_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the address to associate with the listing. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"list_agent_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the customer to associate as the listing agent on the listing. UUID Versio","format":"uuid","minLength":36,"maxLength":36},"co_list_agent_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the customer to associate as the co-listing agent on the listing. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"order_ids":{"type":"array","description":"IDs of the orders to associate with this listing. ","items":{"type":"string","description":"ID of the item to associate with this order.","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36}},"sections":{"type":"object","description":"Media sections to include for this listing.","properties":{"images":{"type":"boolean","example":true,"default":false,"description":"Include the images section when creating this listing. "},"videos":{"type":"boolean","example":true,"default":false,"description":"Include the videos section when creating this listing. "},"floor_plans":{"type":"boolean","example":true,"default":false,"description":"Include the floor plans section when creating this listing. "},"interactive_content":{"type":"boolean","example":true,"default":false,"description":"Include the interactive content section when creating this listing. "}},"additionalProperties":false}},"required":["address_id"],"additionalProperties":false}},"components/schemas/ListingResource":{"id":"components/schemas/ListingResource","kind":"json-schema","title":"ListingResource","data":{"title":"ListingResource","type":"object","description":"A listing.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Listing"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/ListingCountsPayload":{"id":"components/schemas/ListingCountsPayload","kind":"json-schema","title":"ListingCountsPayload","data":{"title":"ListingCountsPayload","type":"object","description":"Payload for requesting listing counts.","properties":{"saved_view_ids":{"type":["array","null"],"description":"An array of saved view IDs to get counts for.","items":{"type":"string","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"description":"A saved view ID. UUID Version 4.","example":"00000000-0000-4000-8000-000000000000"}},"include_all_listings":{"type":["boolean","null"],"description":"Whether to include the count of all listings. Defaults to true.","example":true}},"additionalProperties":false}},"components/schemas/ListingCountsResource":{"id":"components/schemas/ListingCountsResource","kind":"json-schema","title":"ListingCountsResource","data":{"title":"ListingCountsResource","type":"object","description":"A resource containing listing counts for all listings and saved views.","properties":{"data":{"type":"object","description":"The listing counts data.","properties":{"all_listings":{"type":["integer","null"],"description":"The total count of all listings, or null if not requested.","example":42},"views":{"type":"object","description":"An object mapping saved view IDs to their respective listing counts.","additionalProperties":{"type":"integer","description":"The count of listings matching the saved view filters.","example":10}}},"required":["all_listings","views"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}},"components/schemas/ListingPutPayload":{"id":"components/schemas/ListingPutPayload","kind":"json-schema","title":"ListingPutPayload","data":{"title":"ListingPutPayload","type":"object","description":"Payload for updating a listing.","properties":{"title":{"type":["string","null"],"description":"The title of the listing.","minLength":0,"maxLength":255,"example":"Must see apartment!"},"description":{"type":["string","null"],"description":"The description of the listing.","minLength":0,"maxLength":255,"example":"Beautiful 2 bedroom apartment in the heart of downtown"},"status":{"type":["string","null"],"description":"The status of the listing.","minLength":0,"maxLength":255,"example":"FOR_SALE"},"mls_live_date":{"type":["string","null"],"description":"The date the MLS listing will go live.","format":"date","minLength":10,"maxLength":10,"example":"2021-06-30"},"mls_number":{"type":["string","null"],"description":"The MLS number of the listing.","minLength":0,"maxLength":255,"example":"170598340"},"price":{"type":["integer","null"],"description":"The price of the listing property.","example":500000},"bedrooms":{"type":["number","null"],"description":"A decimal value representing the number of bedrooms for the listing.","format":"float","example":1.5,"minimum":0,"maximum":99},"bathrooms":{"type":["number","null"],"description":"A decimal value representing the number of bathrooms for the listing.","format":"float","example":1.5,"minimum":0,"maximum":99},"home_squarefootage":{"type":["number","null"],"description":"A decimal value representing the square footage the listing.","format":"float","example":4200,"minimum":0,"maximum":999999},"lot_acres":{"type":["number","null"],"description":"A decimal value representing the acreage the listing.","format":"float","example":4200,"minimum":0,"maximum":9999},"parking_spots":{"type":["number","null"],"description":"A decimal value representing the number of parking spots for the listing.","format":"float","example":2,"minimum":0,"maximum":999},"year_built":{"type":["integer","null"],"description":"The year the house for the listing was built.","example":1980,"minimum":1500},"property_type":{"type":["string","null"],"description":"The type of the listing.","enum":["Single Family","Single Family Attached","Single Family Detached","Colonial","Condo","Townhome","Twinhome","Duplex","Lot","Land","Manufactured Home","Semi-Detached","Multi Family","Rental","Row House","Horse Farm","Other"],"minLength":0,"maxLength":255,"example":"Single Family"},"is_showcase":{"type":["boolean","null"],"description":"Indicates if this is a Showcase listing","example":true},"address_id":{"type":["string","null"],"description":"The ID of the address associated with the listing. UUID Version 4.","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"example":"00000000-0000-4000-8000-000000000000"},"is_draft":{"type":["boolean","null"],"description":"Indicates if the listing is in the creation/draft process","example":false}},"additionalProperties":false}},"components/schemas/CubiCasaFloorplanResult":{"id":"components/schemas/CubiCasaFloorplanResult","kind":"json-schema","title":"CubiCasaFloorplanResult","data":{"title":"CubiCasaFloorplanResult","type":"object","description":"A Cubicasa floorplan result.","properties":{"full_address":{"type":"string","description":"The full address.","example":"10 Rockefeller Plaza, New York, NY 10020","minLength":0,"maxLength":255},"city":{"type":"string","description":"The city.","example":"New York","minLength":0,"maxLength":255},"county":{"type":"string","description":"The county.","example":"United States","minLength":0,"maxLength":255},"latitude":{"type":"number","description":"The latitude.","example":40.758044,"minimum":-180,"maximum":180},"longitude":{"type":"number","description":"The longitude.","example":-73.979479,"minimum":-180,"maximum":180},"number":{"type":"string","description":"The number.","example":"10","minLength":0,"maxLength":255},"postalCode":{"type":"string","description":"The postal code.","example":"10020","minLength":0,"maxLength":255},"state":{"type":"string","description":"The state.","example":"NY","minLength":0,"maxLength":255},"street":{"type":"string","description":"The street.","example":"Rockefeller Plaza","minLength":0,"maxLength":255},"suite":{"type":"string","description":"The suite.","example":"Apt 100","minLength":0,"maxLength":255},"public_id":{"type":"string","description":"The public ID.","example":"d7c378b1-2b02-4f97-8624-90f2fa154d42","minLength":36,"maxLength":36,"format":"uuid"},"status":{"type":"string","description":"The status.","example":"Ready","minLength":0,"maxLength":255},"jpg_urls":{"type":"array","description":"The JPG URLs.","items":{"type":"string","description":"The JPG URL.","example":"https://www.afakedomain.com/10-rockefeller-plaza-new-york-ny-united-states_0_0.jpg","minLength":1,"maxLength":255,"format":"uri"}}},"required":["full_address","city","county","latitude","longitude","number","postalCode","state","street","suite","public_id","status","jpg_urls"],"additionalProperties":false}},"components/schemas/CubiCasaFloorplan":{"id":"components/schemas/CubiCasaFloorplan","kind":"json-schema","title":"CubiCasaFloorplan","data":{"title":"CubiCasaFloorplan","type":"object","description":"A Cubicasa floorplan.","properties":{"current_sync":{"type":["string","null"],"description":"The Cubicasa current sync public ID.","example":"1234567890","minLength":1,"maxLength":255},"results":{"type":"array","items":{"$ref":"#/components/schemas/CubiCasaFloorplanResult"}},"show_all":{"type":"boolean","description":"Show all results.","example":true},"suggested":{"type":["object","null"],"description":"The suggested (floorplan) results."}},"required":["current_sync","results","show_all","suggested"],"additionalProperties":false}},"components/schemas/CubiCasaFloorplanResource":{"id":"components/schemas/CubiCasaFloorplanResource","kind":"json-schema","title":"CubiCasaFloorplanResource","data":{"title":"CubiCasaFloorplanResource","type":"object","description":"A Cubicasa floorplan.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/CubiCasaFloorplan"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"additionalProperties":false,"required":["status"]}},"components/schemas/ListingDetailSearch":{"id":"components/schemas/ListingDetailSearch","kind":"json-schema","title":"ListingDetailSearch","data":{"title":"ListingDetailSearch","type":"object","description":"Search results for a listing.","properties":{"bedrooms":{"type":["number","null"],"description":"Total number of bedrooms.","example":4},"bathrooms":{"type":["number","null"],"description":"Total number of bathrooms.","example":3.5},"square_feet":{"type":["number","null"],"description":"Total number of square feet.","example":2511},"year_built":{"type":["number","null"],"description":"Year the property was built.","example":1960},"lot_size_acres":{"type":["number","null"],"description":"Total area of the lot of a listing in acres. ","example":0.47}},"additionalProperties":false}},"components/schemas/ListingDetailSearchResource":{"id":"components/schemas/ListingDetailSearchResource","kind":"json-schema","title":"ListingDetailSearchResource","data":{"title":"ListingDetailSearchResource","type":"object","description":"A listing detail search resource.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/ListingDetailSearch"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/ListingPutShowcasePayload":{"id":"components/schemas/ListingPutShowcasePayload","kind":"json-schema","title":"ListingPutShowcasePayload","data":{"title":"ListingPutShowcasePayload","type":"object","description":"Payload for updating a Zillow showcase designation.","properties":{"is_showcase":{"type":"boolean","example":true,"description":"Is this listing a showcase listing?"}},"additionalProperties":false}},"components/schemas/ListingStats":{"id":"components/schemas/ListingStats","kind":"json-schema","title":"ListingStats","data":{"title":"ListingStats","type":"object","description":"Stats for a listing.","properties":{"totalViews":{"type":["string","number","null"],"description":"Total number of views.","example":0},"totalUsers":{"type":["string","number","null"],"description":"Total number of users.","example":0},"avgTimeOnPage":{"type":["string","number","null"],"description":"Average time on page.","example":0},"topReferrer":{"type":["string","null"],"description":"Top referrer.","example":"Jarrod Parkes","minLength":0,"maxLength":255},"allReferrers":{"type":["array","null"],"description":"All referrers.","items":{"type":"string","description":"Referrer.","example":"Jarrod Parkes","minLength":0,"maxLength":255}}},"additionalProperties":false}},"components/schemas/ListingStatsResource":{"id":"components/schemas/ListingStatsResource","kind":"json-schema","title":"ListingStatsResource","data":{"title":"ListingStatsResource","type":"object","description":"A listing stats resource.","properties":{"main_listing_stats":{"$ref":"#/components/schemas/ListingStats"}},"required":["main_listing_stats"],"additionalProperties":false}},"components/schemas/LoginPostPayload":{"id":"components/schemas/LoginPostPayload","kind":"json-schema","title":"LoginPostPayload","data":{"type":"object","title":"LoginPostPayload","description":"A user's email, password, and client type.","properties":{"company_id":{"type":"string","description":"If signing in as a customer user, the ID of company to sign in under.","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"email":{"type":"string","description":"An email.","format":"email","example":"john.doe@gmail.com","minLength":0,"maxLength":255},"password":{"type":"string","description":"A password.","example":"P@$$w0Rd","minLength":0,"maxLength":255},"client":{"type":"string","description":"The type of client.","example":"IOS","minLength":1,"maxLength":255,"enum":["IOS","ANDROID","PHPUNIT"]}},"required":["email","password","client"],"additionalProperties":false}},"components/schemas/LoginViaTokenPostPayload":{"id":"components/schemas/LoginViaTokenPostPayload","kind":"json-schema","title":"LoginViaTokenPostPayload","data":{"type":"object","title":"LoginViaTokenPostPayload","description":"A client, or device, type.","properties":{"client":{"type":"string","description":"The type of client.","example":"IOS","minLength":1,"maxLength":255,"enum":["IOS","ANDROID","PHPUNIT"]}},"required":["client"],"additionalProperties":false}},"components/schemas/MarketingMaterialStorePayload":{"id":"components/schemas/MarketingMaterialStorePayload","kind":"json-schema","title":"MarketingMaterialStorePayload","data":{"title":"MarketingMaterialStorePayload","type":"object","description":"Payload for storing a marketing material record.","properties":{"listing_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"The ID of the listing that the marketing material belongs to. UUID Version 4."},"name":{"type":["string","null"],"description":"Name of the marketing material","example":"John's Material","minLength":0,"maxLength":255},"polotno_json":{"type":["string","null"],"description":"String representation of a polotno JSON object.","minLength":0,"maxLength":99999999,"example":"{'width': 850, 'height': 1100}"},"app_version":{"type":["string","null"],"example":"1.0.0","minLength":0,"maxLength":255,"description":"The version of the MMB app used to save this record."},"template_id":{"type":["string","null"],"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","format":"uuid","minLength":36,"maxLength":36,"description":"The ID of the template the marketing material was created from. UUID Version 4."}},"required":["listing_id"],"additionalProperties":false}},"components/schemas/MarketingMaterialResource":{"id":"components/schemas/MarketingMaterialResource","kind":"json-schema","title":"MarketingMaterialResource","data":{"title":"MarketingMaterialResource","type":"object","description":"Marketing material.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/MarketingMaterial"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/MarketingMaterialUpdatePayload":{"id":"components/schemas/MarketingMaterialUpdatePayload","kind":"json-schema","title":"MarketingMaterialUpdatePayload","data":{"title":"MarketingMaterialUpdatePayload","type":"object","description":"Payload for updating a marketing material record.","properties":{"name":{"type":["string","null"],"description":"Name of the marketing material.","example":"John's Material","minLength":0,"maxLength":255},"polotno_json":{"type":["string","null"],"minLength":0,"maxLength":9999999,"example":"{'width': 850, 'height': 1100}","description":"String representation of a polotno JSON object."},"app_version":{"type":["string","null"],"example":"1.0.0","minLength":0,"maxLength":255,"description":"The version of the MMB app used to save this record."},"draft_polotno_json":{"type":["string","null"],"description":"String representation of a polotno JSON object, used as the draft version of the template","example":"{'width': 850, 'height': 1100}","minLength":0,"maxLength":999999}},"additionalProperties":false}},"components/schemas/MarketingMaterialPublishPayload":{"id":"components/schemas/MarketingMaterialPublishPayload","kind":"json-schema","title":"MarketingMaterialPublishPayload","data":{"title":"MarketingMaterialPublishPayload","type":"object","description":"Payload for publishing a marketing material record.","properties":{"polotno_json":{"type":["string","null"],"description":"String representation of a polotno JSON object.","minLength":0,"maxLength":99999999,"example":"{'width': 850, 'height': 1100}"}},"additionalProperties":false}},"components/schemas/ListingMarketingContent":{"id":"components/schemas/ListingMarketingContent","kind":"json-schema","title":"ListingMarketingContent","data":{"title":"ListingMarketingContent","x-tags":["marketing-materials","listing"],"type":"object","description":"Marketing content for a listing (photos, floorplans, property details, etc).","properties":{"object":{"type":"string","minLength":7,"maxLength":7,"enum":["LISTING"],"example":"LISTING","description":"A canonical value representing a resource."},"id":{"type":"string","description":"ID of the entity. UUID Version 4.","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36},"address":{"$ref":"#/components/schemas/Address"},"mls_number":{"type":["string","null"],"description":"The identifier for a listing on its local MLS. ","minLength":1,"maxLength":100,"example":"1850209"},"sub_type":{"type":["string","null"],"example":"SINGLE_FAMILY_DETACHED","description":"Further specifies the listing type. Examples include family residence and condominium.","minLength":1,"maxLength":100,"enum":["SINGLE_FAMILY","SINGLE_FAMILY_ATTACHED","SINGLE_FAMILY_DETACHED","COLONIAL","CONDO","TOWNHOME","TWINHOME","DUPLEX","LOT","LAND","MANUFACTURED_HOME","SEMI_DETACHED","MULTI_FAMILY","RENTAL","ROW_HOUSE","HORSE_FARM","OTHER"]},"status":{"type":["string","null"],"example":"COMING_SOON","description":"Local, regional, or otherwise custom status for the listing used by the parties involved in the listing transaction. While variable, these statuses are typically mapped to the listing's standard status.","minLength":1,"maxLength":100,"enum":["DRAFT","COMING_SOON","FOR_SALE","FOR_LEASE","PENDING_SALE","PENDING_LEASE","FOR_RENT","SOLD","LEASED","OFF_MARKET"]},"description":{"type":["string","null"],"description":"Description of the selling points of the building and/or land for sale. ","example":"There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.","minLength":1,"maxLength":65535},"lot":{"$ref":"#/components/schemas/ListingLot"},"building":{"$ref":"#/components/schemas/ListingBuilding"},"price":{"$ref":"#/components/schemas/ListingPrice"},"images":{"type":["array","null"],"description":"Photos","items":{"$ref":"#/components/schemas/Image"}},"floor_plans":{"type":["array","null"],"description":"Floorplans","items":{"$ref":"#/components/schemas/FloorPlan"}},"list_agent":{"$ref":"#/components/schemas/Group"},"co_list_agent":{"$ref":"#/components/schemas/Group"},"vendor":{"$ref":"#/components/schemas/Group"},"customers":{"type":"array","description":"customers","items":{"$ref":"#/components/schemas/Group"}},"customer":{"$ref":"#/components/schemas/Group"},"company":{"$ref":"#/components/schemas/Group"}},"required":["status"],"additionalProperties":false}},"components/schemas/ListingMarketingContentResource":{"id":"components/schemas/ListingMarketingContentResource","kind":"json-schema","title":"ListingMarketingContentResource","data":{"title":"ListingMarketingContentResource","type":"object","description":"A listing's marketing content.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/ListingMarketingContent"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/MarketingMaterialCategory":{"id":"components/schemas/MarketingMaterialCategory","kind":"json-schema","title":"MarketingMaterialCategory","data":{"title":"MarketingMaterialCategory","type":"object","description":"A marketing material category.","properties":{"id":{"type":"string","format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"slug":{"type":"string","example":"flyer","minLength":0,"maxLength":255,"description":"Slug of the category."},"name":{"type":"string","example":"Flyer","minLength":0,"maxLength":255,"description":"Name of the category."}},"required":["id","slug","name"],"additionalProperties":false}},"components/schemas/MarketingMaterialTemplate":{"id":"components/schemas/MarketingMaterialTemplate","kind":"json-schema","title":"MarketingMaterialTemplate","data":{"title":"MarketingMaterialTemplate","type":"object","description":"A template for the marketing material builder.","properties":{"object":{"type":"string","minLength":27,"maxLength":27,"enum":["MARKETING_MATERIAL_TEMPLATE"],"example":"MARKETING_MATERIAL_TEMPLATE","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"description":"The ID of the template. UUID Version 4."},"name":{"type":"string","description":"The name of the template.","minLength":0,"maxLength":255,"example":"An example template name"},"preview_image_url":{"type":["string","null"],"example":"https://aryeo.sfo2.cdn.digitaloceanspaces.com/marketing-material-templates/sirius-template-preview.jpg","minLength":0,"maxLength":2048,"format":"uri","description":"The URL of the image used to preview the template."},"polotno_json":{"$ref":"#/components/schemas/PolotnoJson"},"draft_polotno_json":{"$ref":"#/components/schemas/PolotnoJson"},"group":{"$ref":"#/components/schemas/Group"},"categories":{"type":["array","null"],"description":"categories","items":{"$ref":"#/components/schemas/MarketingMaterialCategory"}},"is_featured":{"type":["boolean","null"],"description":"Whether the template is featured.","example":true},"created_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the template was created.","format":"date-time","minLength":27,"maxLength":27,"example":"2025-03-07T13:59:03.000000Z"},"customer_groups":{"type":"array","description":"The customer groups that the template is associated with.","items":{"$ref":"#/components/schemas/Group"}}},"required":["id","name"],"additionalProperties":false}},"components/schemas/MarketingMaterialTemplateCollection":{"id":"components/schemas/MarketingMaterialTemplateCollection","kind":"json-schema","title":"MarketingMaterialTemplateCollection","data":{"title":"MarketingMaterialTemplateCollection","type":"object","description":"A collection of marketing material templates.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/MarketingMaterialTemplate"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/MarketingMaterialTemplateStorePayload":{"id":"components/schemas/MarketingMaterialTemplateStorePayload","kind":"json-schema","title":"MarketingMaterialTemplateStorePayload","data":{"title":"MarketingMaterialTemplateStorePayload","type":"object","description":"Payload for storing a new marketing material template record.","properties":{"name":{"type":["string","null"],"example":"Example template","minLength":0,"maxLength":255,"description":"The name of the template."},"polotno_json":{"type":["string","null"],"description":"String representation of a polotno JSON object, used as the published version of the template.","example":"{'width': 850, 'height': 1100}","minLength":0,"maxLength":99999999},"draft_polotno_json":{"type":["string","null"],"description":"String representation of a polotno JSON object, used as the draft version of the template.","example":"{'width': 850, 'height': 1100}","minLength":0,"maxLength":9999999},"group_id":{"type":["string","null"],"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"format":"uuid","description":"The ID of the group that the template belongs to. UUID Version 4."}},"additionalProperties":false}},"components/schemas/MarketingMaterialTemplateResource":{"id":"components/schemas/MarketingMaterialTemplateResource","kind":"json-schema","title":"MarketingMaterialTemplateResource","data":{"title":"MarketingMaterialTemplateResource","type":"object","description":"A marketing material template.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/MarketingMaterialTemplate"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/MarketingMaterialTemplateUpdatePayload":{"id":"components/schemas/MarketingMaterialTemplateUpdatePayload","kind":"json-schema","title":"MarketingMaterialTemplateUpdatePayload","data":{"title":"MarketingMaterialTemplateUpdatePayload","type":"object","description":"Payload for updating a marketing material template record.","properties":{"name":{"type":["string","null"],"description":"Name of the marketing material template.","example":"John's Template","minLength":0,"maxLength":255},"polotno_json":{"type":["string","null"],"description":"String representation of a polotno JSON object, used as the published version of the template.","example":"{'width': 850, 'height': 1100}","minLength":0,"maxLength":99999999},"draft_polotno_json":{"type":["string","null"],"description":"String representation of a polotno JSON object, used as the draft version of the template","example":"{'width': 850, 'height': 1100}","minLength":0,"maxLength":999999},"app_version":{"type":["string","null"],"example":"1.0.0","minLength":0,"maxLength":255,"description":"The version of the MMB app used to save this record."},"category_ids":{"type":["array","null"],"description":"Array of category IDs to attach to the template.","items":{"description":"ID of a marketing material category. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}}},"additionalProperties":false}},"components/schemas/MarketingMaterialTemplatePublishPayload":{"id":"components/schemas/MarketingMaterialTemplatePublishPayload","kind":"json-schema","title":"MarketingMaterialTemplatePublishPayload","data":{"title":"MarketingMaterialTemplatePublishPayload","type":"object","description":"Payload for publishing a marketing material template record.","properties":{"polotno_json":{"type":["string","null"],"description":"String representation of a polotno JSON object.","minLength":0,"maxLength":99999999,"example":"{'width': 850, 'height': 1100}"}},"additionalProperties":false}},"components/schemas/UserResource":{"id":"components/schemas/UserResource","kind":"json-schema","title":"UserResource","data":{"title":"UserResource","type":"object","description":"A user.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/User"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/MePasswordPutPayload":{"id":"components/schemas/MePasswordPutPayload","kind":"json-schema","title":"MePasswordPutPayload","data":{"title":"MePasswordPutPayload","type":"object","description":"A request to change the currently authenticated user's password.","properties":{"current_password":{"type":"string","description":"A user's current password.","example":"@Rye0Rul3z","minLength":0,"maxLength":255},"new_password":{"type":"string","description":"A new password.","example":"P@$$w0Rd","minLength":0,"maxLength":255},"new_password_confirmation":{"type":"string","example":"P@$$w0Rd","minLength":0,"maxLength":255,"description":"A copy of the new password for confirmation purposes."}},"required":["current_password","new_password","new_password_confirmation"],"additionalProperties":false}},"components/schemas/MediaRequestMediaSearchPayload":{"id":"components/schemas/MediaRequestMediaSearchPayload","kind":"json-schema","title":"MediaRequestMediaSearchPayload","data":{"title":"MediaRequestMediaSearchPayload","type":"object","description":"Payload for searching for listings that match the media request customer.","properties":{"suggested":{"type":["boolean","null"],"description":"If true, only suggested listings or orders will be returned that match the media request address and customer.","example":true},"search":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"Search for listings or orders that match the media request customer and are not already associated with a media request.","example":"resource"}},"additionalProperties":false}},"components/schemas/MediaSearchResource":{"id":"components/schemas/MediaSearchResource","kind":"json-schema","title":"MediaSearchResource","data":{"title":"MediaSearchResource","type":"object","description":"An object containing listings or orders.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":"object","description":"A collection of listings and orders.","properties":{"object":{"type":"string","minLength":26,"maxLength":26,"enum":["MEDIA_REQUEST_MEDIA_SEARCH"],"example":"MEDIA_REQUEST_MEDIA_SEARCH","description":"A canonical value representing a resource."},"listings":{"type":"array","description":"A collection of listings.","items":{"$ref":"#/components/schemas/Listing"}},"orders":{"type":"array","description":"A collection of orders.","items":{"$ref":"#/components/schemas/Order"}}},"required":["listings","orders"],"additionalProperties":false},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/NotificationPreference":{"id":"components/schemas/NotificationPreference","kind":"json-schema","title":"NotificationPreference","data":{"title":"NotificationPreference","type":"object","description":"A notification preference.","properties":{"object":{"type":"string","minLength":44,"maxLength":44,"enum":["APP\\NOTIFICATIONS\\MODELS\\NOTIFICATIONCHANNEL"],"example":"APP\\NOTIFICATIONS\\MODELS\\NOTIFICATIONCHANNEL","description":"A canonical value representing a resource."},"notification_type":{"type":"string","description":"The notification type.","enum":["CREATOR_ORDER_RECEIVED","CREATOR_ORDER_PAYMENT_PROCESSED","CREATOR_APPOINTMENT_SCHEDULED","CREATOR_APPOINTMENT_RESCHEDULED","CREATOR_APPOINTMENT_CANCELED","CREATOR_APPOINTMENT_POSTPONED","CREATOR_APPOINTMENT_ASSIGNED","CREATOR_APPOINTMENT_UNASSIGNED","CREATOR_APPOINTMENT_REMINDER","CREATOR_CUSTOMER_TEAM_INVITATION","CREATOR_UPCOMING_APPOINTMENTS_SUMMARY","CREATOR_EXPORT_READY","CREATOR_TEAM_MEMBER_INVITATION","LISTING_DELIVERY","CUSTOMER_ORDER_CONFIRMATION","CUSTOMER_ORDER_PAYMENT_REQUIRED","CUSTOMER_APPOINTMENT_SCHEDULED","CUSTOMER_APPOINTMENT_RESCHEDULED","CUSTOMER_APPOINTMENT_CANCELED","CUSTOMER_APPOINTMENT_POSTPONED","CUSTOMER_APPOINTMENT_REMINDER","CUSTOMER_NEW_LEAD","CUSTOMER_TEAM_INVITATION","CUSTOMER_USER_VERIFICATION","CUSTOMER_USER_RESET_PASSWORD","CUSTOMER_USER_ACTIVATION","PORTAL_CUSTOM"],"minLength":0,"maxLength":255,"example":"CUSTOMER_APPOINTMENT_CANCELED"},"push":{"type":"boolean","example":true,"description":"Is the push channel enabled?"},"sms":{"type":"boolean","example":true,"description":"Is the sms channel enabled?"},"in_app":{"type":"boolean","example":true,"description":"Is the in-app channel enabled?"},"email":{"type":"boolean","example":true,"description":"Is the email channel enabled?"},"channels":{"type":"array","description":"Channels that are available for this notification type.","items":{"type":"string","description":"Name of a notification channel.","enum":["email","sms","in_app","push"],"example":"email"}}},"required":["notification_type","email","sms","in_app","push","channels"],"additionalProperties":false}},"components/schemas/NotificationPreferencesCollection":{"id":"components/schemas/NotificationPreferencesCollection","kind":"json-schema","title":"NotificationPreferencesCollection","data":{"title":"NotificationPreferencesCollection","type":"object","description":"A collection of notification preferences.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/NotificationPreference"}},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/NotificationPreference-2":{"id":"components/schemas/NotificationPreference-2","kind":"json-schema","title":"NotificationPreference","data":{"title":"NotificationPreference","type":"object","description":"A notification preference to update.","properties":{"object":{"type":"string","minLength":44,"maxLength":44,"enum":["APP\\NOTIFICATIONS\\MODELS\\NOTIFICATIONCHANNEL"],"example":"APP\\NOTIFICATIONS\\MODELS\\NOTIFICATIONCHANNEL","description":"A canonical value representing a resource."},"notification_type":{"type":"string","description":"The notification type.","enum":["CREATOR_ORDER_RECEIVED","CREATOR_ORDER_PAYMENT_PROCESSED","CREATOR_APPOINTMENT_SCHEDULED","CREATOR_APPOINTMENT_RESCHEDULED","CREATOR_APPOINTMENT_CANCELED","CREATOR_APPOINTMENT_POSTPONED","CREATOR_APPOINTMENT_ASSIGNED","CREATOR_APPOINTMENT_UNASSIGNED","CREATOR_APPOINTMENT_REMINDER","CREATOR_CUSTOMER_TEAM_INVITATION","CREATOR_UPCOMING_APPOINTMENTS_SUMMARY","CREATOR_EXPORT_READY","CREATOR_TEAM_MEMBER_INVITATION","LISTING_DELIVERY","CUSTOMER_ORDER_CONFIRMATION","CUSTOMER_ORDER_PAYMENT_REQUIRED","CUSTOMER_APPOINTMENT_SCHEDULED","CUSTOMER_APPOINTMENT_RESCHEDULED","CUSTOMER_APPOINTMENT_CANCELED","CUSTOMER_APPOINTMENT_POSTPONED","CUSTOMER_APPOINTMENT_REMINDER","CUSTOMER_NEW_LEAD","CUSTOMER_TEAM_INVITATION","CUSTOMER_USER_VERIFICATION","CUSTOMER_USER_RESET_PASSWORD","CUSTOMER_USER_ACTIVATION","PORTAL_CUSTOM"],"minLength":0,"maxLength":255,"example":"CUSTOMER_APPOINTMENT_CANCELED"},"push":{"type":"boolean","example":true,"description":"Is the push channel enabled?"},"sms":{"type":"boolean","example":true,"description":"Is the sms channel enabled?"},"in_app":{"type":"boolean","example":true,"description":"Is the in-app channel enabled?"},"email":{"type":"boolean","example":true,"description":"Is the email channel enabled?"}},"required":["notification_type","email","sms","in_app","push"],"additionalProperties":false}},"components/schemas/NotificationPreferencesPutPayload":{"id":"components/schemas/NotificationPreferencesPutPayload","kind":"json-schema","title":"NotificationPreferencesPutPayload","data":{"title":"NotificationPreferencesPutPayload","type":"object","description":"A request to change the user's notification preferences.","properties":{"preferences":{"type":["array","null"],"description":"A notification preference.","items":{"$ref":"#/components/schemas/NotificationPreference-2"}}},"required":["preferences"],"additionalProperties":false}},"components/schemas/OrderCollection":{"id":"components/schemas/OrderCollection","kind":"json-schema","title":"OrderCollection","data":{"title":"OrderCollection","type":"object","description":"A collection of orders.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Order"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/OrderPostPayload":{"id":"components/schemas/OrderPostPayload","kind":"json-schema","title":"OrderPostPayload","data":{"title":"OrderPostPayload","type":"object","description":"Payload for creating an order.","properties":{"fulfillment_status":{"type":["string","null"],"description":"The fulfillment status of the order. Defaults to 'UNFULFILLED'.","enum":["FULFILLED","UNFULFILLED"],"minLength":0,"maxLength":255,"example":"FULFILLED"},"internal_notes":{"type":["string","null"],"description":"Internal notes that will be attached to the order. Viewable only by the team.","minLength":0,"maxLength":2550,"example":"Private note about the order!"},"address_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the address to associate with the order. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"customer_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the customer to associate with the order. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"company_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the company to associate with the order. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"customer_team_membership_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the customer team membership to associate with the order. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"listing_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the listing to associate with the order. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"notify":{"type":["boolean","null"],"example":true,"description":"Indicates if the customer and creator notifications should be sent when creating the order. Requires an address and customer to be set in order for the notifications to be sent."},"lock_download_for_payment":{"type":["boolean","null"],"example":true,"description":"Indicates if the downloads for the attached listing should be locked while there is an outstanding balance on the order."},"allow_payments_before_fulfillment":{"type":["boolean","null"],"example":true,"description":"Indicates if the order will allow payments from the customer before the order is marked as fulfilled."},"product_items":{"type":"array","description":"An array of product items.","items":{"type":"object","description":"Variants of this products.","properties":{"variant_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"format":"uuid","description":"ID of the product variant to associate with the order item. UUID Version 4."},"quantity":{"type":"integer","example":3,"description":"A positive integer representing the number of instances of this item that was or will be serviced."}},"additionalProperties":false}}},"additionalProperties":false}},"components/schemas/OrderResource":{"id":"components/schemas/OrderResource","kind":"json-schema","title":"OrderResource","data":{"title":"OrderResource","type":"object","description":"An order.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Order"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/OrderNotesPutPayload":{"id":"components/schemas/OrderNotesPutPayload","kind":"json-schema","title":"OrderNotesPutPayload","data":{"title":"OrderNotesPutPayload","type":"object","description":"Payload for updating order notes.","properties":{"internal_notes":{"type":["string","null"],"description":"Internal notes for the order.","example":"These are internal notes about the order.","minLength":0,"maxLength":2550}},"additionalProperties":false}},"components/schemas/PaymentResource":{"id":"components/schemas/PaymentResource","kind":"json-schema","title":"OrderPaymentResource","data":{"title":"OrderPaymentResource","type":"object","description":"An order payment.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Payment"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","example":"2021-06-30T20:30:00Z"}},"required":["status","data"],"additionalProperties":false}},"components/schemas/OrderTagsPostPayload":{"id":"components/schemas/OrderTagsPostPayload","kind":"json-schema","title":"OrderTagsPostPayload","data":{"title":"OrderTagsPostPayload","type":"object","description":"Payload for adding a tag to an order.","properties":{"tag_id":{"type":"string","description":"The ID of the tag to add to the order.","example":"00000000-0000-4000-8000-000000000000","format":"uuid","minLength":36,"maxLength":36},"tag":{"type":"object","description":"The tag to add to the order.","properties":{"name":{"type":"string","description":"The name of the tag.","example":"Photography","minLength":0,"maxLength":65536},"color":{"type":"string","description":"The color of the tag.","example":"#FFFFFF","minLength":0,"maxLength":7}},"required":["name","color"],"additionalProperties":false}},"additionalProperties":false}},"components/schemas/OrderBillingAddressPutPayload":{"id":"components/schemas/OrderBillingAddressPutPayload","kind":"json-schema","title":"OrderBillingAddressPutPayload","data":{"title":"OrderBillingAddressPutPayload","type":"object","description":"Payload for updating order billing address.","properties":{"city":{"type":["string","null"],"description":"The city of the order's billing address.","example":"Edison","minLength":0,"maxLength":255},"city_region":{"type":["string","null"],"description":"The region of the order's billing address.","example":"","minLength":0,"maxLength":255},"county_or_parish":{"type":["string","null"],"description":"The county or parish of the order's billing address.","example":"","minLength":0,"maxLength":255},"latitude":{"type":["number","null"],"description":"The latitude of the order's billing address.","example":40.52288659999999,"minimum":-180,"maximum":180},"longitude":{"type":["number","null"],"description":"The longitude of the order's billing address.","example":-74.35929720000001,"minimum":-180,"maximum":180},"postal_code":{"type":["string","null"],"description":"The postal code of the order's billing address.","example":"08817","minLength":0,"maxLength":255},"state_or_province":{"type":["string","null"],"description":"The state or province of the order's billing address.","example":"NJ","minLength":0,"maxLength":255},"state_or_province_region":{"type":["string","null"],"description":"The region of the state or province of the order's billing address.","example":"","minLength":0,"maxLength":255},"street_name":{"type":["string","null"],"description":"The street name of the order's billing address.","example":"Main St","minLength":0,"maxLength":255},"street_number":{"type":["string","null"],"description":"The street number of the order's billing address.","example":"123","minLength":0,"maxLength":255},"unit_number":{"type":["string","null"],"description":"The unit number of the order's billing address.","example":"","minLength":0,"maxLength":255}},"additionalProperties":false}},"components/schemas/PaymentMethod":{"id":"components/schemas/PaymentMethod","kind":"json-schema","title":"PaymentMethod","data":{"title":"PaymentMethod","description":"A payment method","type":"object","properties":{"id":{"type":"string","description":"The ID of the payment method.","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"format":"uuid"},"brand":{"type":"string","description":"The brand of the payment method.","example":"visa","minLength":1,"maxLength":255},"last_4":{"type":"string","description":"The last 4 digits of the payment method.","example":"1234","minLength":4,"maxLength":4},"exp_month":{"type":"integer","description":"The month of the payment method.","example":1,"minimum":1,"maximum":12},"exp_year":{"type":"integer","description":"The year of the payment method.","example":2025,"minimum":1000,"maximum":9999},"is_expired":{"type":"boolean","description":"Whether the payment method is expired.","example":true},"stripe_external_id":{"type":"string","description":"The external ID of the payment method.","example":"pm_1234567890","minLength":1,"maxLength":255},"square_external_id":{"type":"string","description":"The external ID of the payment method.","example":"sq_1234567890","minLength":1,"maxLength":255}},"required":["id","brand","last_4","exp_month","exp_year","is_expired","stripe_external_id","square_external_id"],"additionalProperties":false}},"components/schemas/PaymentGateway":{"id":"components/schemas/PaymentGateway","kind":"json-schema","title":"PaymentGateway","data":{"title":"PaymentGateway","description":"A payment gateway","type":"object","properties":{"object":{"type":"string","minLength":11,"maxLength":11,"enum":["INTEGRATION"],"example":"INTEGRATION","description":"A canonical value representing a resource."},"id":{"type":"string","description":"The ID of the payment gateway.","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"format":"uuid"},"name":{"type":"string","description":"The name of the payment gateway.","example":"Stripe","minLength":1,"maxLength":255},"type":{"type":"string","description":"The type of the payment gateway.","example":"PAYMENT_GATEWAY","minLength":1,"maxLength":255},"provider":{"type":"string","description":"The provider of the payment gateway.","example":"STRIPE_CONNECT","minLength":1,"maxLength":255},"metadata":{"type":["array","null"],"description":"The custom field data of the payment gateway.","items":{"type":"object","description":"A key-value pair of custom field data for the payment gateway.","additionalProperties":false}}},"required":["object","id","name","type","provider","metadata"],"additionalProperties":false}},"components/schemas/PaymentInfoConfig":{"id":"components/schemas/PaymentInfoConfig","kind":"json-schema","title":"PaymentInfoConfig","data":{"title":"PaymentInfoConfig","description":"A payment info config","type":"object","properties":{"vgs_vault_id":{"type":["string","null"],"description":"The ID of the VGS vault.","example":"something","minLength":1,"maxLength":255},"vgs_environment":{"type":["string","null"],"description":"The environment of the VGS vault.","example":"sandbox","minLength":1,"maxLength":255},"square_client_id":{"type":["string","null"],"description":"The ID of the Square client.","example":"sandbox-something","minLength":1,"maxLength":255}},"required":["vgs_vault_id","vgs_environment","square_client_id"],"additionalProperties":false}},"components/schemas/PaymentInfo":{"id":"components/schemas/PaymentInfo","kind":"json-schema","title":"PaymentInfo","data":{"title":"PaymentInfo","description":"Payment information for an order.","type":"object","properties":{"object":{"type":"string","minLength":12,"maxLength":12,"enum":["PAYMENT_INFO"],"example":"PAYMENT_INFO","description":"A canonical value representing a resource."},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the payment info. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"is_authenticated":{"type":"boolean","description":"Whether the payment is authenticated.","example":true},"amount":{"type":"integer","description":"The amount of the payment.","example":1000},"upfront_percentage":{"type":"number","description":"The upfront percentage of the payment.","example":0.5},"currency":{"type":"string","description":"The currency of the payment.","example":"usd","minLength":3,"maxLength":3},"is_tipping_enabled":{"type":"boolean","description":"Whether tipping is enabled for the payment.","example":true},"show_tipping_ui_expanded":{"type":"boolean","description":"Whether the tipping UI is expanded for the payment.","example":true},"payment_gateway_is_available":{"type":"boolean","description":"Whether the payment gateway is available for the payment.","example":true},"payment_methods":{"type":"array","description":"The payment methods for the payment.","items":{"$ref":"#/components/schemas/PaymentMethod"}},"default_payment_method_id":{"type":["string","null"],"description":"The ID of the default payment method for the payment.","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"format":"uuid"},"default_payment_gateway":{"$ref":"#/components/schemas/PaymentGateway"},"can_save_card":{"type":"boolean","description":"Whether the customer can save a card for the payment.","example":true},"config":{"$ref":"#/components/schemas/PaymentInfoConfig"},"requires_billing_address_during_order_form_submission":{"type":"boolean","description":"Whether the billing address is required during the order form submission.","example":true}},"required":["object","id","is_authenticated","amount","upfront_percentage","currency","is_tipping_enabled","show_tipping_ui_expanded","payment_gateway_is_available","payment_methods","default_payment_method_id","default_payment_gateway","can_save_card","config","requires_billing_address_during_order_form_submission"],"additionalProperties":false}},"components/schemas/PaymentInfoResource":{"id":"components/schemas/PaymentInfoResource","kind":"json-schema","title":"PaymentInfoResource","data":{"title":"PaymentInfoResource","type":"object","description":"Payment information for an order resource.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/PaymentInfo"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","example":"2021-06-30T20:30:00Z","minLength":20,"maxLength":20}},"required":["status","data"],"additionalProperties":false}},"components/schemas/OrderFormSessionPostPayload":{"id":"components/schemas/OrderFormSessionPostPayload","kind":"json-schema","title":"OrderFormSessionPostPayload","data":{"title":"OrderFormSessionPostPayload","type":"object","description":"Payload for creating an OrderFormSession to be used for an order form.","properties":{"order_form_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"format":"uuid","description":"ID of an order form to associate with the order form session. UUID Version 4."},"address_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of an address to associate with the order form session. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"address_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data used to generate a new Address object inline. If you create an address upfront, pass the address_id parameter. Otherwise, this address_data will be used to scaffold a new Address object, if present."},"children":[]}]}]}],"properties":{"latitude":{"type":["number","null"],"description":"The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":42.35157458574123,"minimum":-180,"maximum":180},"longitude":{"type":["number","null"],"description":"The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":-71.05763741484657,"maximum":180,"minimum":-180},"street_number":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"107","description":"The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'."},"street_name":{"type":["string","null"],"description":"The street name portion of a location's address.","minLength":0,"maxLength":255,"example":"South St"},"unit_number":{"type":["string","null"],"description":"The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.","minLength":0,"maxLength":255,"example":"Unit 2F"},"postal_code":{"type":["string","null"],"description":"The postal code portion of a location's address.","example":"02111","minLength":0,"maxLength":255},"city":{"type":["string","null"],"description":"The city of a location's address.","example":"Boston","minLength":0,"maxLength":255},"city_region":{"type":["string","null"],"description":"A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.","minLength":0,"maxLength":255,"example":"Leather District"},"county_or_parish":{"type":["string","null"],"description":"The County, Parish or other regional authority of the location.","minLength":0,"maxLength":255,"example":"Suffolk County"},"state_or_province":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States."},"children":[]}]}]}],"minLength":0,"maxLength":255,"example":"MA"},"state_or_province_region":{"type":["string","null"],"description":"A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.","minLength":0,"maxLength":255,"example":"Cape Cod"},"country":{"type":["string","null"],"description":"The ISO 3166-1 country code for this for the country of the location.","minLength":0,"maxLength":255,"example":"US"},"country_region":{"type":["string","null"],"description":"A sub-section or area of a defined country. Examples would be Napa Valley in the US, or the Amalfi Coast in Italy.","example":"Napa Valley","minLength":0,"maxLength":255}},"additionalProperties":false},"customer_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the customer to associate with the order form session. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"customer_group_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the customer group to associate with the order form session. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"customer_data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data used to generate or retrieve a Customer object inline. If you create an customer upfront, pass the customer_id parameter. Otherwise, this customer_data will be used to scaffold a new Customer (Group) object, if present."},"children":[]}]}]}],"properties":{"sso_id":{"type":"string","maxLength":255,"minLength":0,"example":"auth0_1234567890","description":"Single sign on identifier."},"sso_user_id":{"type":"string","maxLength":255,"minLength":0,"example":"auth0_1234567890","description":"Single sign on identifier of the customer user."},"email":{"type":"string","format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"Email address of the user."},"first_name":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"John","description":"First name of the user."},"last_name":{"type":["string","null"],"minLength":0,"maxLength":255,"example":"Doe","description":"Last name of the user."},"phone":{"type":["string","null"],"example":"(123) 456-7890","minLength":0,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens)."},"children":[]}]}]}]}},"additionalProperties":false},"coupon_ids":{"type":"array","description":"IDs of the coupons to associate with this order. ","items":{"type":"string","description":"ID of the item to associate with this coupon. ","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36}},"step_visibility":{"type":"object","description":"Settings for hidding or showing certain steps of the order form during the booking process. Note, steps can only be hidden if all required information is supplied in the OrderFormSession. By default, all steps are shown.","properties":{"show_address_step":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the address step is hidden or shown during the booking process. Only applicable if address_id or address_data parameters are set."},"children":[]}]}]}]},"show_customer_step":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer step is hidden or shown during the booking process. Only applicable if customer_id or customer_data parameters are set."},"children":[]}]}]}]}},"additionalProperties":false},"success_url":{"type":"string","minLength":0,"maxLength":255,"description":"The URL the customer will be directed to after the payment or order placement is successful. By default, customers are directed to the Aryeo order confirmation page.","format":"uri","example":"https://my-company.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000/order-confirmation"}},"required":["order_form_id"],"additionalProperties":false}},"components/schemas/OrderFormSession":{"id":"components/schemas/OrderFormSession","kind":"json-schema","title":"OrderFormSession","data":{"title":"OrderFormSession","type":"object","description":"An order form session is used to pre-fill information about an order being placed via an order form. Through the session, you can also configure other display settings for an order form during that session. ","properties":{"object":{"type":"string","minLength":18,"maxLength":18,"enum":["ORDER_FORM_SESSION"],"example":"ORDER_FORM_SESSION","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"order_form":{"$ref":"#/components/schemas/OrderForm"},"address":{"$ref":"#/components/schemas/Address"},"customer":{"$ref":"#/components/schemas/Group"},"coupons":{"description":"Coupons that should be automatically applied during this order form session.","type":"array","items":{"$ref":"#/components/schemas/Coupon"}},"show_header":{"type":"boolean","example":true,"description":"If the header of the order form is hidden or shown during the booking process."},"step_visibility":{"type":"object","description":"Settings for hidding or showing certain steps of the order form during the booking process. Note, steps can only be hidden if all required information is supplied in the OrderFormSession.","properties":{"show_address_step":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the address step is hidden or shown during the booking process. Only applicable if address_id or address_data parameters are set."},"children":[]}]}]}]},"show_customer_step":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer step is hidden or shown during the booking process. Only applicable if customer_id or customer_data parameters are set."},"children":[]}]}]}]}},"additionalProperties":false},"product_filters":{"type":"object","description":"Product filters that should be automatically applied during this order form session.","properties":{"filter_by_square_feet":{"type":["boolean","null"],"description":"Indicates if the order should be filtered by square feet.","example":true},"filter_by_list_price":{"type":["boolean","null"],"description":"Indicates if the order should be filtered by list price.","example":true}},"additionalProperties":false},"success_url":{"type":"string","minLength":0,"maxLength":255,"description":"The URL the customer will be directed to after the payment or order placement is successful. By default, customers are directed to the Aryeo order confirmation page.","format":"uri","example":"https://my-company.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000/order-confirmation"},"url":{"type":"string","minLength":0,"maxLength":255,"description":"The URL of the order form session. Redirect customers to this URL to take them to correct order form.","format":"uri","example":"https://my-company.aryeo.com/order-form-sessions/00000000-0000-4000-8000-000000000000"}},"required":["id"],"additionalProperties":false}},"components/schemas/OrderFormSessionResource":{"id":"components/schemas/OrderFormSessionResource","kind":"json-schema","title":"OrderResource","data":{"title":"OrderResource","type":"object","description":"An order.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/OrderFormSession"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/OrderFormCollection":{"id":"components/schemas/OrderFormCollection","kind":"json-schema","title":"OrderFormCollection","data":{"title":"OrderFormCollection","type":"object","description":"A collection of order forms.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/OrderForm"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/OrderItemPostPayload":{"id":"components/schemas/OrderItemPostPayload","kind":"json-schema","title":"OrderItemPostPayload","data":{"title":"OrderItemPostPayload","type":"object","description":"Payload for creating an order item.","properties":{"order_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the order to associate this order item to. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"product_variant_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the product variant to create this order item from. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"quantity":{"type":"integer","example":3,"description":"A positive integer representing the number of instances of this item that was or will be serviced."},"unit_price_amount":{"type":"integer","example":2099,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the cost of a single instance of this item. This is multiplied by the quantity to calculate what was or will be charged. Required when a product variant ID is not specified."},"children":[]}]}]}],"minimum":0},"title":{"type":"string","description":"The title of the item. Required when a product variant ID is not specified.","example":"Aerial Video","minLength":0,"maxLength":255},"subtitle":{"type":"string","description":"The subtitle of the item. Required when a product variant ID is not specified.","example":"3000-3999 square feet","minLength":0,"maxLength":255},"description":{"type":"string","description":"The description of the item. Required when a product variant ID is not specified.","example":"A fly-by drone video of the property.","minLength":0,"maxLength":255},"appointment_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the appointment that is scheduled to service this order item. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"assigned_company_team_member_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the company team member assigned to this order item. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36}},"required":["order_id"],"additionalProperties":false}},"components/schemas/OrderItemResource":{"id":"components/schemas/OrderItemResource","kind":"json-schema","title":"OrderItemResource","data":{"title":"OrderItemResource","type":"object","description":"An order item.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/OrderItem"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/OrderItemPayRunItemDefaults":{"id":"components/schemas/OrderItemPayRunItemDefaults","kind":"json-schema","title":"OrderItemPayRunItemDefaults","data":{"title":"OrderItemPayRunItemDefaults","type":"object","description":"The pay run item defaults for an order item.","properties":{"order_item_id":{"type":"string","format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"description":"The ID of the order item. UUID Version 4."},"title":{"type":"string","example":"Complete Photography","description":"The title of the pay run item.","minLength":0,"maxLength":255},"company_team_member":{"$ref":"#/components/schemas/CompanyTeamMember"},"amount":{"type":"number","example":100,"description":"The amount of the pay run item."}},"required":["order_item_id","title","company_team_member","amount"],"additionalProperties":false}},"components/schemas/PortalCustomerJoinPostPayload":{"id":"components/schemas/PortalCustomerJoinPostPayload","kind":"json-schema","title":"PortalCustomerJoinPostPayload","data":{"title":"PortalCustomerJoinPostPayload","type":"object","description":"Payload to add (agent) group to a creator customer list.","properties":{"creator_group_id":{"type":"string","description":"ID of creator group.","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"additionalProperties":false}},"components/schemas/PortalCustomerRegisterPostPayload":{"id":"components/schemas/PortalCustomerRegisterPostPayload","kind":"json-schema","title":"PortalCustomerRegisterPostPayload","data":{"title":"PortalCustomerRegisterPostPayload","type":"object","properties":{"creator_group_id":{"type":"string","description":"ID of creator group.","minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"first_name":{"type":"string","description":"First name.","example":"John","minLength":0,"maxLength":255},"last_name":{"type":"string","description":"Last name.","example":"Doe","minLength":0,"maxLength":255},"email":{"type":"string","description":"An email.","format":"email","example":"john.doe@gmail.com","minLength":0,"maxLength":255},"password":{"type":"string","description":"A password.","example":"P@$$w0Rd","minLength":0,"maxLength":255},"password_confirmation":{"type":"string","example":"P@$$w0Rd","minLength":0,"maxLength":255,"description":"A copy of the password for confirmation purposes."},"client":{"type":"string","description":"The type of client.","example":"IOS","minLength":1,"maxLength":255,"enum":["IOS","ANDROID","PHPUNIT"]},"phone":{"type":"string","description":"A phone number.","example":"5555551234","minLength":8,"maxLength":255}},"description":"Payload to create user and agent group, and to add the agent group to creator customer list.","required":["creator_group_id","first_name","last_name","email","password","password_confirmation","client"],"additionalProperties":false}},"components/schemas/PersonalAccessTokenCustomer":{"id":"components/schemas/PersonalAccessTokenCustomer","kind":"json-schema","title":"PersonalAccessTokenCustomer","data":{"type":"object","title":"PersonalAccessTokenCustomer","description":"A personal access token, its user, and the it's users group (if applicable).","properties":{"object":{"type":["string","null"],"minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"PERSONAL_ACCESS_TOKEN"},"token":{"type":"string","minLength":0,"description":"Authorization token for a user.","example":"token","maxLength":8000},"user":{"$ref":"#/components/schemas/User"},"group":{"$ref":"#/components/schemas/GroupCustomer"}},"required":["token","user"],"additionalProperties":false}},"components/schemas/PersonalAccessTokenCustomerResource":{"id":"components/schemas/PersonalAccessTokenCustomerResource","kind":"json-schema","title":"PersonalAccessTokenCustomerResource","data":{"title":"PersonalAccessTokenCustomerResource","type":"object","description":"A personal access token.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/PersonalAccessTokenCustomer"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/PortalCustomerVerifyPostPayload":{"id":"components/schemas/PortalCustomerVerifyPostPayload","kind":"json-schema","title":"PortalCustomerVerifyPostPayload","data":{"title":"PortalCustomerVerifyPostPayload","type":"object","properties":{"company_id":{"type":"string","description":"ID of creator group (a company).","minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"email":{"type":"string","description":"An email.","format":"email","example":"john.doe@gmail.com","minLength":0,"maxLength":255},"verification_code":{"type":"string","description":"A verification code.","example":"123456","minLength":6,"maxLength":6},"password":{"type":"string","description":"A password.","example":"P@$$w0Rd","minLength":0,"maxLength":255},"password_confirmation":{"type":"string","example":"P@$$w0Rd","minLength":0,"maxLength":255,"description":"A copy of the password for confirmation purposes."},"client":{"type":"string","description":"The type of client.","example":"IOS","minLength":1,"maxLength":255,"enum":["IOS","ANDROID","PHPUNIT"]}},"description":"Payload to verify a user and add them to the company customer list.","required":["company_id","email","verification_code","password","password_confirmation","client"],"additionalProperties":false}},"components/schemas/PortalAppDevAccounts":{"id":"components/schemas/PortalAppDevAccounts","kind":"json-schema","title":"PortalAppDevAccounts","data":{"title":"PortalAppDevAccounts","type":"object","description":"Dev accounts for a portal app.","properties":{"apple_dev_team_id":{"type":["string","null"],"description":"Apple Developer Account Team ID.","example":"SYX7P7AL4Y","minLength":0,"maxLength":255},"apple_dev_entity_name":{"type":["string","null"],"description":"Apple Developer Account Entity Name.","example":"Aryeo, Inc.","minLength":0,"maxLength":255},"apple_dev_itc_team_id":{"type":["string","null"],"description":"Apple Developer Account iTunes Connect Team ID.","example":"122403578","minLength":0,"maxLength":255},"google_dev_id":{"type":["string","null"],"description":"Google Developer Account ID.","example":"6305408161650676173","minLength":0,"maxLength":255},"google_dev_account_name":{"type":["string","null"],"description":"Google Developer Account Name.","example":"Aryeo","minLength":0,"maxLength":255},"apple_asc_api_key_url":{"type":["string","null"],"minLength":1,"maxLength":65536,"example":"https://example.com/ApiKey.p8","description":"The URL for the App Store Connect Api Key (.p8) file."},"apple_asc_api_key_id":{"type":["string","null"],"description":"The ID for the App Store Connect Api Key.","example":"K12345678","minLength":0,"maxLength":255},"apple_asc_api_key_issuer_id":{"type":["string","null"],"description":"The Issuer ID used to generate the App Store Connect Api Key.","example":"I12345678","minLength":0,"maxLength":255}},"additionalProperties":false}},"components/schemas/AppStoreDetails":{"id":"components/schemas/AppStoreDetails","kind":"json-schema","title":"AppStoreDetails","data":{"title":"AppStoreDetails","type":"object","description":"Values displayed on an app's public-facing app store page.","properties":{"name":{"type":"string","maxLength":255,"minLength":0,"example":"Archi-Pix","description":"App store name."},"subtitle":{"type":"string","maxLength":255,"minLength":0,"example":"Real estate media.","description":"App store subtitle."},"description":{"type":"string","description":"A description of an app, detailing features and functionality.","example":"This app is used for doing real-estate things.","minLength":0,"maxLength":65536},"keywords":{"type":"string","description":"Keywords for app store search results. Keywords should be separated with a comma.","example":"real estate,photography,matterport","minLength":0,"maxLength":65536},"marketing_url":{"type":"string","description":"A URL with markerting information for an app.","example":"https://www.aryeo.com","minLength":0,"maxLength":65536,"format":"uri"},"support_url":{"type":"string","description":"A URL with support information for an app.","example":"https://www.aryeo.com","minLength":0,"maxLength":65536,"format":"uri"},"package_name":{"type":"string","description":"The package name/path used for an Android app.","example":"com.aryeo.app","minLength":1,"maxLength":65535},"bundle_id":{"type":"string","description":"The unique identifier for your app on Apple's App Store. This should be configured in Apple's Developer Portal.","example":"com.aryeo.app","minLength":1,"maxLength":65535},"itunes_app_id":{"type":"string","description":"The app id assigned to your app in App Store Connect. Also known as the Apple ID.","example":"12345678","minLength":1,"maxLength":65535},"version_minimum":{"type":"string","description":"The minimum version of the app which should be installed on a user's device.","example":"1.2.0","minLength":1,"maxLength":65535},"version_latest_android":{"type":"string","description":"The latest available Android version on the Google Play Store.","example":"1.3.0","minLength":1,"maxLength":65535},"version_latest_ios":{"type":"string","description":"The latest available iOS version on the Apple App Store.","example":"1.3.0","minLength":1,"maxLength":65535}},"additionalProperties":false}},"components/schemas/AppAndroidDetails":{"id":"components/schemas/AppAndroidDetails","kind":"json-schema","title":"AppAndroidDetails","data":{"title":"AppAndroidDetails","type":"object","description":"Details about an Android app.","properties":{"package_name":{"type":"string","description":"The package name/path used for an Android app.","example":"com.aryeo.app","minLength":1,"maxLength":65535}},"additionalProperties":false}},"components/schemas/AppIOSDetails":{"id":"components/schemas/AppIOSDetails","kind":"json-schema","title":"AppIOSDetails","data":{"title":"AppIOSDetails","type":"object","description":"Details about an iOS app.","properties":{"bundle_id":{"type":"string","description":"The unique identifier for your app on Apple's App Store. This should be configured in Apple's Developer Portal.","example":"com.aryeo.app","minLength":1,"maxLength":65535},"itunes_app_id":{"type":"string","description":"The app id assigned to your app in App Store Connect. Also known as the Apple ID.","example":"12345678","minLength":1,"maxLength":65535}},"additionalProperties":false}},"components/schemas/PortalAppExampleOrder":{"id":"components/schemas/PortalAppExampleOrder","kind":"json-schema","title":"PortalAppExampleOrder","data":{"title":"PortalAppExampleOrder","type":"object","description":"Values used for the example property shown on public-facing app store pages and screenshots.","properties":{"unparsed_address_part_one":{"type":"string","minLength":0,"maxLength":255,"description":"Unparsed text representation of the first part of the address, typically including the street number, street name, and unit number if applicable.","example":"107 South St, Unit 2F"},"unparsed_address_part_two":{"type":"string","minLength":0,"maxLength":255,"description":"Unparsed text representation of the second part of the address, typically including the city, state or province, and postal code.","example":"Boston, MA 02111"},"latitude":{"type":"number","description":"The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":42.35157458574123,"minimum":-180,"maximum":180},"longitude":{"type":"number","description":"The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.","example":-71.05763741484657,"maximum":180,"minimum":-180},"image_url":{"type":"string","description":"A URL for an example property image.","example":"https://picsum.photos/400/200","minLength":0,"maxLength":65536,"format":"uri"}},"additionalProperties":false}},"components/schemas/PortalAppContactLegacy":{"id":"components/schemas/PortalAppContactLegacy","kind":"json-schema","title":"PortalAppContactLegacy","data":{"title":"PortalAppContactLegacy","type":"object","description":"Values displayed in the contact section of a portal app.","properties":{"name":{"type":"string","minLength":0,"maxLength":255,"example":"Archi-Pix","description":"A name to show on the in-app contact page."},"email":{"type":"string","format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"An email address."},"phone":{"type":"string","example":"6175550173","minLength":0,"maxLength":255,"description":"A phone number separated by hyphens."}},"additionalProperties":false}},"components/schemas/PortalAppContact":{"id":"components/schemas/PortalAppContact","kind":"json-schema","title":"PortalAppContact","data":{"title":"PortalAppContact","type":"object","description":"Values displayed in the contact section of a portal app.","properties":{"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"Resource id","minLength":36,"maxLength":36,"format":"uuid"},"title":{"type":"string","minLength":0,"maxLength":255,"example":"East Office","description":"Name of contact."},"call":{"type":"string","example":"6175550173","minLength":0,"maxLength":255,"description":"A phone number used for calling."},"text":{"type":"string","example":"6175550173","minLength":0,"maxLength":255,"description":"A phone number used for texting."},"email":{"type":"string","format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"An email address."},"link_url":{"type":["string","null"],"description":"A link for this contact.","example":"https://www.example.com/contact","maxLength":65535,"minLength":0},"link":{"type":["string","null"],"description":"A link for this contact.","example":"https://www.example.com/contact","maxLength":65535,"minLength":0},"link_title":{"type":"string","example":"Contact page","minLength":0,"maxLength":255,"description":"A title to use for the link."}},"additionalProperties":false}},"components/schemas/PortalAppSettings":{"id":"components/schemas/PortalAppSettings","kind":"json-schema","title":"PortalAppSettings","data":{"title":"PortalAppSettings","type":"object","description":"Settings used by a portal app.","properties":{"external_form_domain_whitelist":{"type":"string","maxLength":65535,"minLength":0,"example":"google.com,aryeo.com","description":"A comma-separated list of domains to whitelist when using external forms"}},"additionalProperties":false}},"components/schemas/PortalAppStrings":{"id":"components/schemas/PortalAppStrings","kind":"json-schema","title":"PortalAppStrings","data":{"title":"PortalAppStrings","type":"object","description":"Strings used by a portal app.","properties":{"headline":{"type":"string","maxLength":255,"minLength":0,"example":"Shop with Archi-Pix","description":"Headline."}},"additionalProperties":false}},"components/schemas/PortalAppColors":{"id":"components/schemas/PortalAppColors","kind":"json-schema","title":"PortalAppColors","data":{"title":"PortalAppColors","type":"object","description":"Colors used by a portal app","properties":{"lightest":{"type":"string","maxLength":7,"minLength":0,"example":"#67c9f2","description":"Lightest color."},"light":{"type":"string","maxLength":7,"minLength":0,"example":"#43bdf0","description":"Light color."},"default":{"type":"string","maxLength":7,"minLength":0,"example":"#24ace4","description":"Default color."},"dark":{"type":"string","maxLength":7,"minLength":0,"example":"#0e8cbf","description":"Dark color."},"loading_background":{"type":"string","maxLength":7,"minLength":0,"example":"#24ace4","description":"Loading background color."}},"additionalProperties":false}},"components/schemas/PortalAppImages":{"id":"components/schemas/PortalAppImages","kind":"json-schema","title":"PortalAppImages","data":{"title":"PortalAppImages","type":"object","description":"Images used by a portal app.","properties":{"app_icon_url":{"type":"string","description":"A URL for the app icon.","example":"https://picsum.photos/1024","minLength":1,"maxLength":65535,"format":"uri"},"logo_url":{"type":"string","description":"A URL for the logo.","example":"https://picsum.photos/256","minLength":1,"maxLength":65535,"format":"uri"},"hero_url":{"type":"string","description":"A URL for a hero image.","example":"https://picsum.photos/500/200","minLength":1,"maxLength":65535,"format":"uri"}},"additionalProperties":false}},"components/schemas/PortalAppRevision":{"id":"components/schemas/PortalAppRevision","kind":"json-schema","title":"PortalAppRevision","data":{"title":"PortalAppRevision","type":"object","description":"A revision of a portal app config.","properties":{"object":{"type":"string","minLength":39,"maxLength":39,"enum":["APP\\PORTALAPPS\\MODELS\\PORTALAPPREVISION"],"example":"APP\\PORTALAPPS\\MODELS\\PORTALAPPREVISION","description":"A canonical value representing a resource."},"id":{"type":"string","description":"The ID of the revision.","format":"uuid","minLength":36,"maxLength":36,"example":"00000000-0000-4000-8000-000000000000"},"version":{"type":"string","description":"The version of app when the revision was created.","minLength":1,"maxLength":255,"example":"1.0.0"},"changes":{"type":"array","description":"A list of changes made to the app config for this revision.","items":{"type":"object","description":"A generic payload containing metadata about the changes made to the app config for this revision.","additionalProperties":true}},"screenshots":{"type":"array","description":"A list of screenshots for this revision.","items":{"type":"object","description":"A generic payload containing metadata about the screenshots for this revision.","additionalProperties":true}},"screenshots_ready_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the screenshots were ready.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"screenshots_started_at":{"type":["string","null"],"description":"The date and time (ISO 8601 format) when the screenshots were started.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"created_at":{"type":"string","description":"The date and time (ISO 8601 format) when the revision was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"updated_at":{"type":"string","description":"The date and time (ISO 8601 format) when the revision was updated.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["id","object","version","changes","screenshots","screenshots_ready_at","screenshots_started_at","created_at","updated_at"],"additionalProperties":false}},"components/schemas/PortalAppConfig":{"id":"components/schemas/PortalAppConfig","kind":"json-schema","title":"PortalAppConfig","data":{"title":"PortalAppConfig","type":"object","description":"Configuration parameters for a customer portal app.","properties":{"object":{"type":"string","minLength":17,"maxLength":17,"enum":["PORTAL_APP_CONFIG"],"example":"PORTAL_APP_CONFIG","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4.","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"app_name":{"type":"string","maxLength":255,"minLength":0,"example":"Archi-Pix","description":"App name."},"dev_accounts":{"$ref":"#/components/schemas/PortalAppDevAccounts"},"primary_status":{"type":"string","description":"The primary status of the portal app.","enum":["INFO_SUBMITTED","READY_TO_BUILD","IN_REVIEW","LIVE","LIVE_NEEDS_TRANSFER","DISCONTINUED"],"minLength":0,"maxLength":255,"example":"LIVE"},"testing_user_email":{"type":"string","maxLength":255,"minLength":0,"example":"app+archi_pix-mobile-app-testing-agent@aryeo.com","description":"The email of the user created for testing the mobile app."},"aryeo_mobile_app_admin_account":{"type":"string","maxLength":255,"minLength":0,"example":"app@aryeo.com","description":"The Aryeo admin account used to access this company's Apple and Google developer accounts."},"one_signal_app_id":{"type":["string","null"],"format":"uuid","minLength":36,"maxLength":36,"description":"One Signal App Id. UUID Version 4.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"one_signal_custom_app_group_name":{"type":["string","null"],"description":"One Signal Custom App Group Name used for iOS.","minLength":0,"maxLength":255,"example":"group.com.aryeo.app.onesignal"},"firebase_project_number":{"type":"string","description":"Firebase project number.","minLength":0,"maxLength":255,"example":"123456789"},"app_store":{"$ref":"#/components/schemas/AppStoreDetails"},"android":{"$ref":"#/components/schemas/AppAndroidDetails"},"ios":{"$ref":"#/components/schemas/AppIOSDetails"},"example_order":{"$ref":"#/components/schemas/PortalAppExampleOrder"},"contact":{"$ref":"#/components/schemas/PortalAppContactLegacy"},"contacts":{"type":"array","description":"The list of contacts for the portal app.","items":{"$ref":"#/components/schemas/PortalAppContact"}},"settings":{"$ref":"#/components/schemas/PortalAppSettings"},"strings":{"$ref":"#/components/schemas/PortalAppStrings"},"colors":{"$ref":"#/components/schemas/PortalAppColors"},"images":{"$ref":"#/components/schemas/PortalAppImages"},"vendor":{"$ref":"#/components/schemas/Group"},"app_icon_url":{"type":"string","description":"URL to the app icon image.","format":"uri","minLength":0,"maxLength":2048,"example":"https://example.com/app-icon.png"},"app_store_title":{"type":"string","description":"Title displayed in app stores.","minLength":0,"maxLength":255,"example":"Property Tours App"},"app_store_subtitle":{"type":"string","description":"Subtitle displayed in app stores.","minLength":0,"maxLength":255,"example":"Virtual Tours & Property Marketing"},"app_store_description":{"type":"string","description":"Description displayed in app stores.","minLength":0,"maxLength":4000,"example":"View and share beautiful property tours and marketing materials."},"brand_name":{"type":"string","description":"Name of the brand.","minLength":0,"maxLength":255,"example":"Acme Real Estate"},"brand_color":{"type":"string","description":"Default brand color in hex format.","pattern":"^#[0-9A-Fa-f]{6}$","minLength":7,"maxLength":7,"example":"#FF5733"},"brand_logo_url":{"type":"string","description":"URL to the brand logo image.","format":"uri","minLength":0,"maxLength":2048,"example":"https://example.com/brand-logo.png"},"display_mobile_banner":{"type":"boolean","description":"Whether to display the mobile app banner.","example":true},"display_email_banner":{"type":"boolean","description":"Whether to display the email banner.","example":true},"example_unparsed_address_part_one":{"type":"string","description":"First part of an example unparsed address.","minLength":0,"maxLength":255,"example":"123 Main Street"},"example_unparsed_address_part_two":{"type":"string","description":"Second part of an example unparsed address.","minLength":0,"maxLength":255,"example":"Boston, MA 02110"},"example_hero_url":{"type":"string","description":"URL to an example hero image.","format":"uri","minLength":0,"maxLength":2048,"example":"https://example.com/hero-image.jpg"},"example_image_url":{"type":"string","description":"URL to an example regular image.","format":"uri","minLength":0,"maxLength":2048,"example":"https://example.com/image.jpg"},"example_video_url":{"type":"string","description":"URL to an example video.","format":"uri","minLength":0,"maxLength":2048,"example":"https://example.com/video.mp4"},"example_floorplan_url":{"type":"string","description":"URL to an example floorplan image.","format":"uri","minLength":0,"maxLength":2048,"example":"https://example.com/floorplan.jpg"},"updated_at":{"type":"string","description":"The date and time (ISO 8601 format) when the config was last updated.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"last_revision":{"$ref":"#/components/schemas/PortalAppRevision"},"last_revision_id":{"type":"string","description":"The ID of the last revision.","format":"uuid","minLength":36,"maxLength":36,"example":"00000000-0000-4000-8000-000000000000"}},"required":["id"],"additionalProperties":false}},"components/schemas/PortalAppConfigResource":{"id":"components/schemas/PortalAppConfigResource","kind":"json-schema","title":"PortalAppConfigResource","data":{"title":"PortalAppConfigResource","type":"object","description":"A portal app config.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/PortalAppConfig"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/PortalAppConfigPutPayload":{"id":"components/schemas/PortalAppConfigPutPayload","kind":"json-schema","title":"PortalAppConfigPutPayload","data":{"title":"PortalAppConfigPutPayload","type":"object","description":"Payload for updating a portal app config.","properties":{"app_name":{"type":"string","description":"The name that will be displayed under your app icon.","example":"Gold Sprint","minLength":0,"maxLength":15},"primary_status":{"type":"string","description":"The primary status of the app.","example":"LIVE","minLength":0,"maxLength":65536,"enum":["INFO_SUBMITTED","READY_TO_BUILD","IN_REVIEW","LIVE","LIVE_NEEDS_TRANSFER","DISCONTINUED"]},"app_store_name":{"type":"string","description":"The name that will be displayed on the App Store and Play Store.","example":"Gold Sprint Media","minLength":0,"maxLength":30},"app_store_subtitle":{"type":"string","description":"The subtitle that will be displayed on the App Store and Play Store.","example":"Real-Estate Media","minLength":0,"maxLength":30},"description":{"type":"string","description":"A description of the portal app, detailing features and functionality.","example":"An app for Gold Sprint Media customers!","minLength":0,"maxLength":4000},"short_description":{"type":"string","description":"A short description for your app. Users can expand to view your full description.","example":"An app for Gold Sprint Media customers!","minLength":0,"maxLength":80},"keywords":{"type":"string","description":"Keywords for search results. Separate keywords with a comma.","example":"real estate photography,photography services,real estate marketing","minLength":0,"maxLength":100},"marketing_url":{"type":"string","description":"URL: Marketing information about your app.","minLength":0,"maxLength":65535,"example":"https://aryeo.com","format":"uri"},"support_url":{"type":"string","description":"URL: Support information for your app.","minLength":0,"maxLength":65535,"example":"https://aryeo.com","format":"uri"},"package_name":{"type":"string","description":"The reverse DNS path to the main application package. This should match your iOS bundle id.","example":"com.aryeo.goldsprintmedia","minLength":0,"maxLength":65535},"bundle_id":{"type":"string","description":"The unique identifier for your app on Apple's App Store. This should be configured in Apple's Developer Portal.","example":"com.aryeo.goldsprintmedia","minLength":0,"maxLength":65535},"itunes_app_id":{"type":"string","description":"The app id assigned to your app in App Store Connect. Also known as the Apple ID.","example":"1620094264","minLength":0,"maxLength":65535},"one_signal_app_id":{"type":"string","description":"OneSignal app id. OneSignal is used for push notifications.","minLength":0,"maxLength":65535,"example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","format":"uuid"},"contact_name":{"type":"string","description":"The name displayed in the contact section of the app.","example":"Gold Sprint Media","minLength":0,"maxLength":65535},"one_signal_rest_api_key":{"type":"string","description":"One Signal Rest Api Key.","minLength":0,"maxLength":255,"example":"ABCD"},"one_signal_custom_app_group_name":{"type":"string","description":"One Signal Custom App Group Name used for iOS.","minLength":0,"maxLength":255,"example":"group.com.aryeo.app.onesignal"},"firebase_project_number":{"type":"string","description":"Firebase project number.","minLength":0,"maxLength":255,"example":"123456789"},"aryeo_mobile_app_admin_account":{"type":"string","description":"Aryeo mobile app admin account.","minLength":0,"maxLength":255,"example":"app@aryeo.com"}},"additionalProperties":false}},"components/schemas/ProductCollection":{"id":"components/schemas/ProductCollection","kind":"json-schema","title":"ProductCollection","data":{"title":"ProductCollection","type":"object","description":"A collection of products.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/ProductResource":{"id":"components/schemas/ProductResource","kind":"json-schema","title":"ProductResource","data":{"title":"ProductResource","type":"object","description":"A product.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Product"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/ProductCategoryCollection":{"id":"components/schemas/ProductCategoryCollection","kind":"json-schema","title":"ProductCatgoryCollection","data":{"title":"ProductCatgoryCollection","type":"object","description":"A collection of product categories.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductCategory"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/PromotionCodeRedeemPostPayload":{"id":"components/schemas/PromotionCodeRedeemPostPayload","kind":"json-schema","title":"PromotionCodeRedeemPostPayload","data":{"title":"PromotionCodeRedeemPostPayload","type":"object","properties":{"code":{"type":"string","description":"The code of the promotion code to redeem.","example":"BEAVER","minLength":1,"maxLength":255}},"additionalProperties":false,"required":["code"]}},"components/schemas/QuickBooksCustomer":{"id":"components/schemas/QuickBooksCustomer","kind":"json-schema","title":"QuickBooksCustomer","data":{"type":"object","title":"QuickBooksCustomer","description":"A record of a QuickBooks customer.","properties":{"object":{"type":"string","minLength":0,"maxLength":255,"description":"A canonical value representing a resource.","example":"QUICKBOOKS_CUSTOMER"},"id":{"type":"string","minLength":0,"maxLength":255,"description":"ID of the QuickBooks customer.","example":"1234567890"},"display_name":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"John's Auto Parts","description":"Display name of the QuickBooks customer."},"name":{"type":["string","null"],"maxLength":255,"minLength":0,"example":"John Doe","description":"Name of the QuickBooks customer."},"email":{"type":["string","null"],"format":"email","minLength":0,"maxLength":255,"example":"john.doe@gmail.com","description":"Email address of the user."},"active":{"type":"boolean","description":"Whether the QuickBooks customer is active.","example":true}},"required":["id"],"additionalProperties":false}},"components/schemas/QuickBooksCustomerCollection":{"id":"components/schemas/QuickBooksCustomerCollection","kind":"json-schema","title":"QuickBooksCustomerCollection","data":{"title":"QuickBooksCustomerCollection","type":"object","description":"A collection of QuickBooks customers.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/QuickBooksCustomer"}},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/QuickBooksItemCollection":{"id":"components/schemas/QuickBooksItemCollection","kind":"json-schema","title":"QuickBooksItemCollection","data":{"title":"QuickBooksItemCollection","type":"object","description":"A collection of QuickBooks items.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/QuickBooksItem"}},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/QuickBooksItemResource":{"id":"components/schemas/QuickBooksItemResource","kind":"json-schema","title":"QuickBooksItemResource","data":{"title":"QuickBooksItemResource","type":"object","description":"A QuickBooks item.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/QuickBooksItem"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/OrderRefundPostPayload":{"id":"components/schemas/OrderRefundPostPayload","kind":"json-schema","title":"OrderRefundPostPayload","data":{"title":"OrderRefundPostPayload","type":"object","description":"Payload for refunding an order payment.","properties":{"date":{"type":"string","minLength":19,"maxLength":19,"example":"2025-11-07T17:03:26","description":"The date and time to record the refund. ISO 8601."},"reason":{"type":"string","description":"The reason for the refund.","example":"duplicate","minLength":1,"maxLength":255,"enum":["duplicate","requested_by_customer","fraudulent","external"]},"description":{"type":"string","description":"The description of the refund.","example":"This is a refund.","minLength":0,"maxLength":255},"amount":{"type":"integer","description":"The amount of the refund.","example":1000},"tip_amount":{"type":"integer","description":"The tip amount of the refund.","example":1000}},"required":["date","reason","amount","tip_amount"],"additionalProperties":false}},"components/schemas/OrderPayment":{"id":"components/schemas/OrderPayment","kind":"json-schema","title":"OrderPayment","data":{"title":"OrderPayment","description":"An order payment","type":"object","properties":{"object":{"type":"string","minLength":13,"maxLength":13,"enum":["ORDER_PAYMENT"],"example":"ORDER_PAYMENT","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"type":{"type":"string","description":"The type of the payment","example":"MANUAL","minLength":1,"maxLength":255,"enum":["MANUAL","CREDIT","CHECKOUT"]},"collection_source":{"type":["string","null"],"description":"The source of the payment","example":"CASH","minLength":0,"maxLength":255},"completed_at":{"type":"string","format":"date-time","example":"2021-06-30T20:30:00Z","description":"The date and time the payment was completed. ISO 8601.","minLength":20,"maxLength":20},"applicable_amount":{"type":"integer","description":"The applicable amount of the payment","example":1000},"tip_amount":{"type":"integer","description":"The tip amount of the payment","example":1000},"total_amount":{"type":"integer","description":"The total amount of the payment","example":1000},"collected_amount":{"type":"integer","description":"The collected amount of the payment","example":1000},"order":{"$ref":"#/components/schemas/Order"}},"required":["id","type","collection_source","completed_at","applicable_amount","tip_amount","total_amount","collected_amount"],"additionalProperties":false}},"components/schemas/OrderRefund":{"id":"components/schemas/OrderRefund","kind":"json-schema","title":"OrderRefund","data":{"title":"OrderRefund","description":"An order refund","type":"object","properties":{"object":{"type":"string","minLength":12,"maxLength":12,"enum":["ORDER_REFUND"],"example":"ORDER_REFUND","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","minLength":36,"maxLength":36,"description":"ID of the entity. UUID Version 4."},"amount":{"type":"integer","description":"The amount of the refund.","example":1000},"tip_amount":{"type":"integer","description":"The tip amount of the refund.","example":1000},"total_amount":{"type":"integer","description":"The total amount of the refund.","example":1000},"currency":{"type":"string","description":"The currency of the refund.","example":"USD","minLength":3,"maxLength":3},"description":{"type":["string","null"],"description":"The description of the refund.","example":"This is a refund.","minLength":0,"maxLength":255},"reason":{"type":"string","description":"The reason for the refund.","example":"DUPLICATE","minLength":1,"maxLength":255,"enum":["DUPLICATE","REQUESTED_BY_CUSTOMER","FRAUDULENT","EXTERNAL"]},"completed_at":{"type":"string","format":"date-time","example":"2021-06-30T20:30:00Z","description":"The date and time the refund was completed. ISO 8601.","minLength":20,"maxLength":20},"company_team_member":{"$ref":"#/components/schemas/CompanyTeamMember"},"order_payment":{"$ref":"#/components/schemas/OrderPayment"},"payment_integration":{"$ref":"#/components/schemas/PaymentGateway"}},"required":["id","amount","tip_amount","total_amount","currency","description","reason","completed_at","order_payment"],"additionalProperties":false}},"components/schemas/OrderRefundResource":{"id":"components/schemas/OrderRefundResource","kind":"json-schema","title":"OrderRefundResource","data":{"title":"OrderRefundResource","type":"object","description":"An order refund.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/OrderRefund"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/Region":{"id":"components/schemas/Region","kind":"json-schema","title":"Region","data":{"type":"object","title":"Region","description":"A region is a geographical area that can be used to group or filter data.","properties":{"id":{"type":"string","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"type":{"type":"string","description":"The type of the region.","enum":["COUNTRY","STATE","COUNTY"],"example":"COUNTRY","minLength":1,"maxLength":255},"name":{"type":"string","description":"The name of the region.","example":"United States","minLength":1,"maxLength":255},"description":{"type":["string","null"],"description":"The description of the region.","example":"The United States of America","minLength":1,"maxLength":255},"slug":{"type":["string","null"],"description":"The slug of the region.","example":"united-states","minLength":1,"maxLength":255},"code":{"type":"string","description":"The code of the region.","example":"US","minLength":1,"maxLength":255},"country_code":{"type":["string","null"],"description":"The country code of the region.","example":"US","minLength":1,"maxLength":255},"state_code":{"type":["string","null"],"description":"The state code of the region.","example":"CA","minLength":1,"maxLength":255}},"required":["id","type","name","description","slug","code","country_code","state_code"],"additionalProperties":false}},"components/schemas/RegionCollection":{"id":"components/schemas/RegionCollection","kind":"json-schema","title":"RegionCollection","data":{"title":"RegionCollection","type":"object","description":"A collection of regions.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Region"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["data"],"additionalProperties":false}},"components/schemas/Review":{"id":"components/schemas/Review","kind":"json-schema","title":"Review","data":{"title":"Review","type":"object","description":"A user review.","properties":{"object":{"type":"string","description":"String representing type. Objects of the same type share the same schema.","example":"REVIEW","minLength":1,"maxLength":100},"id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the review. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"user_id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the user. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"review_campaign_id":{"type":["string","null"],"example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the review campaign. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid"},"source_type":{"type":"string","enum":["ios","android","web"],"example":"ios","description":"The source type of the review.","minLength":1,"maxLength":255},"rating":{"type":["number","null"],"description":"The rating given in the review (0.0-1.0).","example":0.85,"minimum":0,"maximum":1},"notes":{"type":["string","null"],"description":"Additional notes provided in the review.","example":"Great experience with the app!","minLength":0,"maxLength":65536},"created_at":{"type":"string","description":"The date and time (ISO 8601 format) when the review was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"updated_at":{"type":"string","description":"The date and time (ISO 8601 format) when the review was last updated.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"additionalProperties":false,"required":["id","user_id","source_type","created_at","updated_at"]}},"components/schemas/ReviewCollection":{"id":"components/schemas/ReviewCollection","kind":"json-schema","title":"ReviewCollection","data":{"title":"ReviewCollection","type":"object","description":"A collection of reviews.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Review"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/ReviewPostPayload":{"id":"components/schemas/ReviewPostPayload","kind":"json-schema","title":"ReviewPostPayload","data":{"title":"ReviewPostPayload","type":"object","properties":{"campaign_slug":{"type":"string","description":"The slug of the review campaign. Campaign will be auto-created if it doesn't exist.","example":"aryeo-go-3.2.0","minLength":1,"maxLength":255},"source_type":{"type":"string","enum":["ios","android","web"],"example":"ios","description":"The source type of the review.","minLength":1,"maxLength":255},"rating":{"type":"number","description":"The rating given in the review (0.0-1.0).","example":0.85,"minimum":0,"maximum":1},"notes":{"type":"string","description":"Additional notes provided in the review.","example":"Great experience with the app!","minLength":0,"maxLength":65536}},"additionalProperties":false,"required":["campaign_slug","source_type"]}},"components/schemas/ReviewResource":{"id":"components/schemas/ReviewResource","kind":"json-schema","title":"ReviewResource","data":{"title":"ReviewResource","type":"object","description":"A review.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Review"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"additionalProperties":false,"required":["status"]}},"components/schemas/SavedViewFilter":{"id":"components/schemas/SavedViewFilter","kind":"json-schema","title":"SavedViewFilter","data":{"type":"object","title":"SavedViewFilter","description":"A filter for a saved view.","properties":{"object":{"type":"string","minLength":17,"maxLength":17,"enum":["SAVED_VIEW_FILTER"],"example":"SAVED_VIEW_FILTER","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the filter. UUID Version 4."},"type":{"type":"string","enum":["delivery_status","payment_status"],"example":"delivery_status","description":"The type of filter.","minLength":1,"maxLength":255},"value":{"type":["string","array","object"],"description":"The value of the filter. Can be a string, array, or object depending on the filter type.","items":{"type":"string","description":"When value is an array, it contains string elements."},"example":["delivered","pending"]},"saved_view_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"The ID of the saved view this filter belongs to."},"created_at":{"type":["string","null"],"description":"The date and time the filter was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"updated_at":{"type":["string","null"],"description":"The date and time the filter was last updated.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["object","id","type","value","saved_view_id"],"additionalProperties":false}},"components/schemas/SavedView":{"id":"components/schemas/SavedView","kind":"json-schema","title":"SavedView","data":{"type":"object","title":"SavedView","description":"A saved view.","properties":{"object":{"type":"string","minLength":10,"maxLength":10,"enum":["SAVED_VIEW"],"example":"SAVED_VIEW","description":"A canonical value representing a resource."},"id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"ID of the saved view. UUID Version 4."},"title":{"type":"string","minLength":1,"maxLength":255,"example":"My Saved View","description":"The title of the saved view."},"scope":{"type":"string","enum":["listing","order"],"example":"listing","description":"The scope of the saved view.","minLength":1,"maxLength":255},"sort_by":{"type":["string","null"],"minLength":1,"maxLength":255,"example":"created_at","description":"The field to sort by."},"owner_id":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"The ID of the owner of this saved view. UUID Version 4."},"owner_type":{"type":"string","enum":["company","company_team_member"],"minLength":1,"maxLength":255,"example":"company","description":"The type of the owner of this saved view."},"created_by":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"The ID of the user who created this saved view. UUID Version 4."},"order_index":{"type":["integer","null"],"minimum":0,"example":0,"description":"The order index for this saved view for the authenticated user."},"filters":{"type":["array","null"],"description":"An array of filters for this saved view.","items":{"$ref":"#/components/schemas/SavedViewFilter"}},"created_at":{"type":["string","null"],"description":"The date and time the saved view was created.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"updated_at":{"type":["string","null"],"description":"The date and time the saved view was last updated.","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"},"can_edit":{"type":"boolean","example":true,"description":"Whether the authenticated user can edit this saved view."},"view_access":{"type":["string","null"],"description":"The access level of the saved view.","enum":["Whole team","Only me"],"example":"Whole team"}},"required":["object","id","title","scope","owner_id","owner_type","created_by","can_edit"],"additionalProperties":false}},"components/schemas/SavedViewCollection":{"id":"components/schemas/SavedViewCollection","kind":"json-schema","title":"SavedViewCollection","data":{"title":"SavedViewCollection","type":"object","description":"A collection of saved views.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/SavedView"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status","data","meta","links"],"additionalProperties":false}},"components/schemas/SavedViewPostPayload":{"id":"components/schemas/SavedViewPostPayload","kind":"json-schema","title":"SavedViewPostPayload","data":{"type":"object","title":"SavedViewPostPayload","description":"Payload for creating a saved view.","properties":{"title":{"type":"string","minLength":1,"maxLength":255,"example":"My Saved View","description":"The title of the saved view."},"scope":{"type":"string","enum":["listing","order"],"example":"listing","description":"The scope of the saved view.","minLength":1,"maxLength":255},"owner_type":{"type":"string","enum":["company","company_team_member"],"minLength":1,"maxLength":255,"example":"company","description":"The type of the owner of this saved view."},"sort_by":{"type":["string","null"],"minLength":1,"maxLength":255,"example":"created_at","description":"The field to sort by."},"filters":{"type":["array","null"],"description":"An array of filters for this saved view.","items":{"type":"object","description":"A saved view filter object.","properties":{"type":{"type":"string","enum":["delivery_status","payment_status"],"example":"delivery_status","description":"The type of filter.","minLength":1,"maxLength":255},"value":{"type":["string","array","object"],"description":"The value of the filter. Can be a string, array, or object depending on the filter type.","items":{"type":"string","description":"When value is an array, it contains string elements."},"example":["delivered","pending"]}},"required":["type","value"],"additionalProperties":false}}},"required":["title","scope","owner_type"],"additionalProperties":false}},"components/schemas/SavedViewResource":{"id":"components/schemas/SavedViewResource","kind":"json-schema","title":"SavedViewResource","data":{"title":"SavedViewResource","type":"object","description":"A saved view.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/SavedView"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status","data"],"additionalProperties":false}},"components/schemas/SavedViewRearrangePayload":{"id":"components/schemas/SavedViewRearrangePayload","kind":"json-schema","title":"SavedViewRearrangePayload","data":{"type":"object","title":"SavedViewRearrangePayload","description":"Payload for rearranging saved views for the current company team member.","properties":{"order":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ordered array of saved view IDs. The first ID will be set to order_index 0, the next to 1, and so on. Send an empty array to clear custom ordering."},"children":[]}]}]}],"items":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","description":"The ID of a saved view. UUID Version 4."}}},"required":["order"],"additionalProperties":false}},"components/schemas/SavedViewPatchPayload":{"id":"components/schemas/SavedViewPatchPayload","kind":"json-schema","title":"SavedViewPatchPayload","data":{"type":"object","title":"SavedViewPatchPayload","description":"Payload for updating a saved view.","properties":{"title":{"type":"string","minLength":1,"maxLength":255,"example":"My Updated Saved View","description":"The title of the saved view."},"scope":{"type":"string","enum":["listing","order"],"example":"listing","description":"The scope of the saved view.","minLength":1,"maxLength":255},"owner_type":{"type":"string","enum":["company","company_team_member"],"minLength":1,"maxLength":255,"example":"company","description":"The type of the owner of this saved view."},"sort_by":{"type":["string","null"],"minLength":1,"maxLength":255,"example":"created_at","description":"The field to sort by."},"filters":{"type":["array","null"],"description":"An array of filters for this saved view.","items":{"type":"object","description":"A saved view filter object.","properties":{"type":{"type":"string","enum":["delivery_status","payment_status"],"example":"delivery_status","description":"The type of filter.","minLength":1,"maxLength":255},"value":{"type":["string","array","object"],"description":"The value of the filter. Can be a string, array, or object depending on the filter type.","items":{"type":"string","description":"When value is an array, it contains string elements."},"example":["delivered","pending"]}},"required":["type","value"],"additionalProperties":false}}},"required":[],"additionalProperties":false}},"components/schemas/CalendarDay":{"id":"components/schemas/CalendarDay","kind":"json-schema","title":"CalendarDay","data":{"description":"A bookable time range with available users.","type":"object","title":"CalendarDay","properties":{"date":{"type":"string","minLength":10,"maxLength":10,"example":"2021-01-01","description":"Calendar day that has available timeslots."},"is_available":{"type":"boolean","example":true,"description":"Does the day have availability?"}},"required":["date","is_available"],"additionalProperties":false}},"components/schemas/CalendarDayCollectionMeta":{"id":"components/schemas/CalendarDayCollectionMeta","kind":"json-schema","title":"CalendarDayCollectionMeta","data":{"title":"CalendarDayCollectionMeta","type":"object","description":"Metadata about a calendar day paginated response.","properties":{"group_id":{"type":["string","null"],"example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","minLength":36,"maxLength":36,"format":"uuid","description":"The ID of the group."},"company_id":{"type":"string","description":"The ID of the group (company).","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"company_team_member_ids":{"type":"array","description":"Array of company team member IDs.","items":{"description":"ID of a user. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"user_ids":{"type":"array","description":"Array of user IDs.","items":{"description":"ID of a user. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"appointment_id":{"type":["string","null"],"example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the entity. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"start_at":{"type":["string","null"],"description":"Range start time.","example":"2021-06-30T20:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"end_at":{"type":["string","null"],"description":"Range end time.","example":"2021-06-30T21:30:00Z","minLength":20,"maxLength":20,"format":"date-time"},"timezone":{"type":["string","null"],"description":"The timezone.","minLength":3,"maxLength":255,"example":"CST"},"is_twilight":{"type":["boolean","null"],"example":true,"description":"Is twlight?"},"interval":{"type":["integer","null"],"example":30,"description":"Interval length."},"duration":{"type":["integer","null"],"example":30,"description":"Duration length."},"current_page":{"type":"integer","description":"The current page.","example":1},"timeframe":{"type":["string","null"],"description":"Timeframe.","minLength":0,"maxLength":255,"example":"DAY"},"timeframe_period":{"type":"object","description":"Timeframe period.","properties":{"startDate":{"type":["string","null"],"description":"Start date.","format":"date-time","minLength":27,"maxLength":27,"example":"2025-04-01T05:59:59.999999Z"},"endDate":{"type":["string","null"],"description":"End date.","format":"date-time","minLength":27,"maxLength":27,"example":"2025-04-01T05:59:59.999999Z"},"startDateIncluded":{"type":"boolean","description":"Start date included.","example":true},"endDateIncluded":{"type":"boolean","description":"End date included.","example":true}},"required":["startDate","endDate","startDateIncluded","endDateIncluded"],"additionalProperties":false},"from":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the first record on this page. This is specified as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand."},"children":[]}]}]}],"example":1},"last_page":{"type":"integer","description":"The last page of records.","example":4},"links":{"type":["array","null"],"description":"Links.","items":{"$ref":"#/components/schemas/PaginationLink"}},"path":{"type":"string","description":"The current paged path.","example":"https://api.aryeo.com/v1/{path}","minLength":1,"maxLength":65535},"per_page":{"type":"integer","description":"Number of records per page.","example":15},"to":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the last record on this page. This is specified as either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"integer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand."},"children":[]}]}]}],"example":15},"total":{"type":"integer","description":"Total number of records.","example":50}},"required":["current_page"],"additionalProperties":false}},"components/schemas/CalendarDayCollection":{"id":"components/schemas/CalendarDayCollection","kind":"json-schema","title":"CalendarDayCollection","data":{"title":"CalendarDayCollection","type":"object","description":"A collection of calendar days that have available timeslots","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/CalendarDay"}},"meta":{"$ref":"#/components/schemas/CalendarDayCollectionMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/Timeslot":{"id":"components/schemas/Timeslot","kind":"json-schema","title":"Timeslot","data":{"description":"A bookable time range, including users that are available.","type":"object","title":"Timeslot","properties":{"start_at":{"type":"string","minLength":20,"maxLength":20,"example":"2021-01-01T00:00:00Z","description":"Start time of the available slot"},"end_at":{"type":"string","minLength":20,"maxLength":20,"example":"2021-01-01T00:30:00Z","description":"End time of the available slot"},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"required":["start_at","end_at"],"additionalProperties":false}},"components/schemas/TimeslotCollection":{"id":"components/schemas/TimeslotCollection","kind":"json-schema","title":"TimeslotCollection","data":{"title":"TimeslotCollection","type":"object","description":"A collection of bookable timeslots.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Timeslot"}},"meta":{"$ref":"#/components/schemas/CalendarDayCollectionMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/OrderItemGrouping":{"id":"components/schemas/OrderItemGrouping","kind":"json-schema","title":"OrderItemGrouping","data":{"title":"OrderItemGrouping","type":"object","description":"A grouping of order items.","properties":{"object":{"type":["string","null"],"example":"ORDER_ITEM_GROUPING","description":"A canonical value representing a resource.","minLength":0,"maxLength":10},"users":{"type":"array","description":"Users attached to the grouping.","items":{"$ref":"#/components/schemas/User"}},"company_team_members":{"type":"array","description":"Company team members attached to the grouping.","items":{"$ref":"#/components/schemas/CompanyTeamMember"}},"products":{"type":"array","description":"Products attached to the grouping.","items":{"$ref":"#/components/schemas/Product"}},"items":{"type":"array","description":"Order items attached to the grouping.","items":{"$ref":"#/components/schemas/OrderItem"}},"duration":{"type":"integer","example":60,"minimum":1,"maximum":1440,"description":"The duration of the grouping in minutes."}},"required":["users","company_team_members","products","items","duration"],"additionalProperties":false}},"components/schemas/OrderItemGroupingCollection":{"id":"components/schemas/OrderItemGroupingCollection","kind":"json-schema","title":"OrderItemGroupingCollection","data":{"title":"OrderItemGroupingCollection","type":"object","description":"A collection of order item groupings.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/OrderItemGrouping"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["data"],"additionalProperties":false}},"components/schemas/TagCollection":{"id":"components/schemas/TagCollection","kind":"json-schema","title":"TagCollection","data":{"title":"TagCollection","type":"object","description":"A collection of tags.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Tag"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/TagOnlyPostPayload":{"id":"components/schemas/TagOnlyPostPayload","kind":"json-schema","title":"TagOnlyPostPayload","data":{"title":"TagOnlyPostPayload","type":"object","description":"Payload for creating a tag.","properties":{"type":{"type":"string","description":"The type of the tag.","example":"customer_team","minLength":0,"maxLength":65536,"enum":["order","customer_team","product","order_form","virtual_staging_ai"]},"name":{"type":"string","description":"The name of the tag.","example":"Photography","minLength":0,"maxLength":65536},"color":{"type":"string","description":"The color of the tag.","example":"#FFFFFF","minLength":0,"maxLength":7}},"additionalProperties":false,"required":["type","name","color"]}},"components/schemas/TagResource":{"id":"components/schemas/TagResource","kind":"json-schema","title":"TagResource","data":{"title":"TagResource","type":"object","description":"A tag response resource.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Tag"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/TagPutPayload":{"id":"components/schemas/TagPutPayload","kind":"json-schema","title":"TagPutPayload","data":{"title":"TagPutPayload","description":"Payload for updating a tag.","type":"object","properties":{"name":{"type":"string","description":"The name of the tag.","example":"Photography","minLength":0,"maxLength":65536},"color":{"type":"string","description":"The color of the tag.","example":"#FFFFFF","minLength":0,"maxLength":7}},"additionalProperties":false}},"components/schemas/TaskCollection":{"id":"components/schemas/TaskCollection","kind":"json-schema","title":"TaskCollection","data":{"title":"TaskCollection","type":"object","description":"A collection of tasks.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/Task"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/TaskPostPayload":{"id":"components/schemas/TaskPostPayload","kind":"json-schema","title":"TaskPostPayload","data":{"title":"TaskPostPayload","type":"object","description":"Payload for creating a task.","properties":{"name":{"type":"string","description":"The name of the task.","example":"Complete 41 Drone Shots, Variant corporis","minLength":0,"maxLength":255},"description":{"type":["string","null"],"description":"The description of the task.","example":"Complete 41 Drone Shots, Variant corporis","minLength":0,"maxLength":65536},"due_at":{"type":["string","null"],"description":"The due date of the task.","example":"2021-06-30T20:30:00Z","format":"date-time","minLength":20,"maxLength":20},"completed_at":{"type":["string","null"],"description":"The completed date of the task.","example":"2021-06-30T20:30:00Z","format":"date-time","minLength":20,"maxLength":20},"company_team_member_id":{"type":["string","null"],"description":"The ID of the company team member assigned to the task.","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid","minLength":36,"maxLength":36}},"additionalProperties":false,"required":["name"]}},"components/schemas/TaskResource":{"id":"components/schemas/TaskResource","kind":"json-schema","title":"TaskResource","data":{"title":"TaskResource","type":"object","description":"A task response resource.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Task"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/TaskPutPayload":{"id":"components/schemas/TaskPutPayload","kind":"json-schema","title":"TaskPutPayload","data":{"title":"TaskPutPayload","type":"object","description":"Payload for updating a task.","properties":{"name":{"type":"string","description":"The name of the task.","example":"Complete 41 Drone Shots, Variant corporis","minLength":0,"maxLength":255},"description":{"type":["string","null"],"description":"The description of the task.","example":"Complete 41 Drone Shots, Variant corporis","minLength":0,"maxLength":65536},"due_at":{"type":["string","null"],"description":"The due date of the task.","example":"2021-06-30T20:30:00Z","format":"date-time","minLength":20,"maxLength":20},"completed_at":{"type":["string","null"],"description":"The completed date of the task.","example":"2021-06-30T20:30:00Z","format":"date-time","minLength":20,"maxLength":20},"company_team_member_id":{"type":["string","null"],"description":"The ID of the company team member assigned to the task.","example":"123e4567-e89b-12d3-a456-426614174000","format":"uuid","minLength":36,"maxLength":36}},"additionalProperties":false,"required":["name"]}},"components/schemas/TaskCompletePutPayload":{"id":"components/schemas/TaskCompletePutPayload","kind":"json-schema","title":"TaskCompletePutPayload","data":{"title":"TaskCompletePutPayload","type":"object","description":"Payload for completing a task.","properties":{"completed_at":{"type":["string","null"],"description":"The completed date of the task.","example":"2021-06-30T20:30:00Z","format":"date-time","minLength":20,"maxLength":20}},"additionalProperties":false,"required":["completed_at"]}},"components/schemas/TaskReinstatePutPayload":{"id":"components/schemas/TaskReinstatePutPayload","kind":"json-schema","title":"TaskReinstatePutPayload","data":{"title":"TaskReinstatePutPayload","type":"object","description":"Payload for reinstating a task.","additionalProperties":false,"required":[]}},"components/schemas/TaxPostPayload":{"id":"components/schemas/TaxPostPayload","kind":"json-schema","title":"TaxPostPayload","data":{"title":"TaxPostPayload","type":"object","description":"Payload for creating a tax.","properties":{"order_id":{"type":"string","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","description":"ID of the order apply this tax to. UUID Version 4.","format":"uuid","minLength":36,"maxLength":36},"tax_rate_data":{"type":"object","description":"Data to construct an ad hoc tax rate inline to apply to this order.","properties":{"name":{"type":"string","description":"The name of the tax.","example":"New York State Tax","minLength":0,"maxLength":255},"description":{"type":"string","description":"The description of the tax rate.","example":"Tax rate applied for any property that falls within the bounds New York State.","minLength":0,"maxLength":65536},"applied_rate":{"type":"number","format":"float","example":0.075,"minimum":0,"maximum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A decimal value representing the rate that should be applied to a taxed entity. For example, 0.075 would represent an applied tax percentage of 7.5%."},"children":[]}]}]}]}},"additionalProperties":false}},"required":["order_id"],"additionalProperties":false}},"components/schemas/TaxResource":{"id":"components/schemas/TaxResource","kind":"json-schema","title":"TaxResouce","data":{"title":"TaxResouce","type":"object","description":"A tax response resource.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Tax"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/Territory":{"id":"components/schemas/Territory","kind":"json-schema","title":"Territory","data":{"title":"Territory","type":"object","description":"A region where a company offers services.","properties":{"object":{"type":"string","minLength":9,"maxLength":9,"enum":["TERRITORY"],"example":"TERRITORY","description":"A canonical value representing a resource."},"id":{"type":"string","description":"ID of the entity. UUID Version 4.","minLength":36,"maxLength":36,"format":"uuid","example":"00000000-0000-4000-8000-000000000000","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"name":{"type":"string","description":"The name of the territory.","example":"New York City","minLength":1,"maxLength":255}},"required":["id","name"],"additionalProperties":false}},"components/schemas/TerritoryCollection":{"id":"components/schemas/TerritoryCollection","kind":"json-schema","title":"TerritoryCollection","data":{"title":"TerritoryCollection","type":"object","description":"A collection of territories.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Territory"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/UserCollection":{"id":"components/schemas/UserCollection","kind":"json-schema","title":"UserCollection","data":{"title":"UserCollection","type":"object","description":"A collection of users.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"type":["array","null"],"description":"A collection of objects.","items":{"$ref":"#/components/schemas/User"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/VideoResource":{"id":"components/schemas/VideoResource","kind":"json-schema","title":"VideoResource","data":{"title":"VideoResource","type":"object","description":"A video.","properties":{"status":{"type":"string","example":"success","minLength":0,"maxLength":255,"description":"What was the state of the request?"},"data":{"$ref":"#/components/schemas/Video"},"timestamp":{"type":["string","null"],"description":"The request timestamp (ISO 8601).","format":"date-time","minLength":20,"maxLength":20,"example":"2021-06-30T20:30:00Z"}},"required":["status"],"additionalProperties":false}},"components/schemas/VideoPutPayload":{"id":"components/schemas/VideoPutPayload","kind":"json-schema","title":"VideoPutPayload","data":{"title":"VideoPutPayload","type":"object","description":"Payload to update a video.","properties":{"title":{"type":"string","description":"The name of the video.","example":"Home Walkthrough Video","minLength":1,"maxLength":100}},"required":["title"],"additionalProperties":false}},"schema_80":{"kind":"json-schema","data":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"owner,items,users,order,order.address,order.customer,order.customerGroup,order.listing,order.items,order.items.appointment"},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"string","example":"UPCOMING","minLength":1,"maxLength":100,"enum":["PAST","UPCOMING"]},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"array","items":{"description":"Status of the appointments to return","type":"string","example":"SCHEDULED","minLength":1,"maxLength":100,"enum":["SCHEDULED","UNSCHEDULED","CANCELED"]}},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"string","minLength":20,"maxLength":20,"format":"date-time","example":"2021-01-01T13:00:00Z"},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"string","minLength":20,"maxLength":20,"format":"date-time","example":"2021-01-02T13:00:00Z"},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"array","items":{"description":"ID of a user. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"string","example":"-created_at","minLength":1,"maxLength":100},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"string","example":"25","minLength":1,"maxLength":5},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":5,"example":"2"},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"owner,items,users,order,order.address,order.customer,order.customerGroup, order.listing,order.items,.order.items.appointment"},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"integer","example":60,"minimum":1,"maximum":360},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"string","description":"Search term for company team members.","minLength":1,"maxLength":255,"example":"Brendan"},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"string","description":"Comma separated list of company team member IDs.","minLength":1,"maxLength":255,"example":"00000000-0000-4000-8000-000000000000,00000000-0000-4000-8000-000000000001"},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"company"},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2020-12-29T00:00:00-00:00","minLength":20,"maxLength":20},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2020-12-31T00:00:00-00:00","minLength":20,"maxLength":20},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"string","example":"APPOINTMENT","minLength":0,"maxLength":255,"enum":["APPOINTMENT","CALENDAR_BLOCK","EXTERNAL","BUFFER","DECLINED_APPOINTMENT","UNSCHEDULED_APPOINTMENT"]},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"customer"},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"search"},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"google.com"},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"name"},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"example":10},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"integer","minimum":1,"example":1},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"users"},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"00000000-0000-4000-8000-000000000000"},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"john"},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["credit","debit"],"minLength":5,"maxLength":6,"description":"The type of transaction","example":"credit"},"amount":{"type":"integer","minimum":1,"description":"The amount in cents","example":100},"description":{"type":"string","minLength":0,"maxLength":255,"description":"Optional description of the transaction","example":"Description of transaction"},"date":{"type":"string","format":"date","minLength":10,"maxLength":10,"description":"The date for the transaction in UTC (YYYY-MM-DD)","example":"2025-01-01"}},"required":["type","amount"]},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"gmail.com"},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"john.doe@gmail.com"},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"1234567890"},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"John Doe"},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"string","description":"ID of an address. UUID Version 4.","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000","format":"uuid"},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"promotion_codes"},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":255,"enum":["product","fee","order"],"example":"product"},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","minLength":0,"maxLength":65536,"description":"The message of the response.","example":"Promotion code successfully redeemed."}},"additionalProperties":false,"required":["message"]},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"list_agent,list_agent.social_profiles,list_agent.owner,co_list_agent,co_list_agent.social_profiles,co_list_agent.owner,images,files,videos,floor_plans,interactive_content,property_website"},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"string","example":"123 Main St","minLength":1,"maxLength":255},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":255,"example":"John Doe"},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"string","enum":["DRAFT","COMING_SOON","FOR_LEASE","FOR_SALE","PENDING_SALE","PENDING_LEASE","FOR_RENT","SOLD","LEASED","OFF_MARKET","null"],"example":"FOR_SALE","minLength":1,"maxLength":100},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"number","example":100000},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"number","example":4000000},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"number","example":1000},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"number","example":5000},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"integer","example":2},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"integer","example":4},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"number","example":2.5},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"number","example":5},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"string","enum":["DELIVERED","UNDELIVERED","SCHEDULED"],"example":"DELIVERED","minLength":0,"maxLength":11},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"list_agent,list_agent.social_profiles,list_agent.owner,co_list_agent,co_list_agent.social_profiles,co_list_agent.owner,images,files,videos,floor_plans,interactive_content,property_website,orders.appointments"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"resource"},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"items,listing,customer,appointments,appointments.users,unconfirmed_appointments,order_form,discounts,discounts.coupon"},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"123 Imperial"},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"PAID"},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"array","items":{"description":"ID of a tag. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"string","example":"appointment_start","minLength":1,"maxLength":100},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"description":"The amount in cents","example":500},"tip_amount":{"type":"integer","description":"The tip amount in cents","example":100,"minimum":0},"collection_source":{"$ref":"#/components/schemas/OrderPaymentCollectionSource"},"date":{"type":"string","format":"date","minLength":10,"maxLength":10,"description":"The date for the payment in UTC (YYYY-MM-DD)","example":"2025-01-01"},"notes":{"type":"string","minLength":0,"maxLength":10000,"description":"Optional description of the payment","example":"Description of payment"}},"required":["amount","currency","collection_source","date"]},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"string","minLength":0,"maxLength":255,"example":"Photography"},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"array","items":{"description":"ID of a category. UUID Version 4.","type":"string","minLength":36,"maxLength":36,"format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"}},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"string","example":"MAIN","minLength":0,"maxLength":255},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"string","enum":["COUNTRY","STATE","COUNTY"],"example":"COUNTRY","minLength":1,"maxLength":255},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"string","size":2,"example":"US","minLength":2,"maxLength":2},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"string","size":2,"example":"CA","minLength":2,"maxLength":2},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","minLength":36,"maxLength":36},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","minLength":36,"maxLength":36}},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"type":"string","enum":["DISTANCE","HOURS_PRIORITY","ROUND_ROBIN","RECOMMENDED","PRIORITY_LIST"],"example":"DISTANCE","minLength":0,"maxLength":255},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2020-01-05T12:00:00Z","minLength":20,"maxLength":20},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"integer","example":60,"minimum":1,"maximum":1440},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"string","minLength":36,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"00000000-0000-4000-8000-000000000000"},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"minLength":1,"maxLength":5,"example":"MONTH"},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"integer","example":15,"minimum":1,"maximum":360},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"string","example":"CST","minLength":3,"maxLength":50},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"integer","example":5},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"integer","example":25,"minimum":1,"maximum":360},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"integer","example":5,"minimum":1},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2021-01-01","minLength":10,"maxLength":10},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"object"},"id":"schema_159"}},"exampleStore":{},"securitySchemeStore":{"Token":{"id":"Token","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal access token (token) identifying a user, and sometimes, the user's current group. Tokens may be generated in a group's developer settings. The token should be supplied in the authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/api/aryeo","isMockServer":true,"description":"Mock server"},{"url":"https://api.aryeo.com/v1","description":"Production"}],"logo":{"imageUrl":"https://raw.githubusercontent.com/jarrodparkes/images/master/aryeo-square.svg","href":"https://www.aryeo.com","backgroundColor":"#fafafa"}},"options":{"hideDownloadButtons":true,"hideInfoMetadata":true,"showExtensions":true,"jsonSamplesExpandLevel":5,"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"JavaScript","label":"JS"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"curl","label":"cURL"}]},"hideSidebar":true,"mockServer":{"url":"/_mock/api/aryeo","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api/aryeo.json?download"},{"url":"/_bundle/api/aryeo.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Aryeo","description":"# Introduction\nThe Aryeo API provides access to the Aryeo platform."}},"baseSlug":"/api/aryeo","routesMapping":{}}