{"openapi":"3.1.0","info":{"title":"Pigeon API","description":"Pigeon streamlines your document collection processes and eliminates the need for burdensome follow-ups.","version":"1.0.0"},"paths":{"/attachments":{"get":{"tags":["Attachments"],"summary":"List Attachments","description":"List attachments for the authenticated user.","operationId":"handler_attachments_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CustomerDocumentPublic"},"type":"array","title":"Response Handler Attachments Get"}}}}}},"post":{"tags":["Attachments"],"summary":"Create Attachment","description":"Upload a file and create a new attachment that can be referenced when creating requests.","operationId":"handler_attachments_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_handler_attachments_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDocumentPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/attachments/{attachment_id}":{"get":{"tags":["Attachments"],"summary":"Get Attachment","description":"Get an attachment by ID.","operationId":"handler_attachments__attachment_id__get","parameters":[{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDocumentPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/templates":{"get":{"tags":["Templates"],"summary":"List Templates","description":"Retrieve a list of templates.","operationId":"handler_templates_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TemplatePublic"},"type":"array","title":"Response Handler Templates Get"}}}}}},"post":{"tags":["Templates"],"summary":"Create Template","description":"Create a new request template.","operationId":"handler_templates_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTemplatePostParams"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/templates/{id}":{"get":{"tags":["Templates"],"summary":"Get Template","description":"Fetch Template identified by ID.","operationId":"handler_templates__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Templates"],"summary":"Update Template","description":"Update a template identified by ID.","operationId":"handler_templates__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTemplate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Templates"],"summary":"Delete Template","description":"Delete a template identified by ID.","operationId":"handler_templates__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{org_id}/templates":{"get":{"tags":["Templates"],"summary":"List Organization Templates","description":"Retrieve a list of templates associated with the specified organization.","operationId":"handler_organizations__org_id__templates_get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplatePublic"},"title":"Response Handler Organizations  Org Id  Templates Get"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/webhooks":{"post":{"tags":["Webhooks"],"summary":"Create Webhook Subscription","description":"Create a new webhook subscription.","operationId":"handler_webhooks_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookWithoutOrg"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPublicWithSecret"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Webhooks"],"summary":"List Webhook Subscriptions","description":"Retrieve a list of webhook subscriptions.","operationId":"handler_webhooks_get","parameters":[{"name":"topic","in":"query","required":false,"schema":{"$ref":"#/components/schemas/WebhookTopic"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookPublic"},"title":"Response Handler Webhooks Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/webhooks/{id}":{"get":{"tags":["Webhooks"],"summary":"Get Webhook Subscription","description":"Fetch a webhook subscription identified by ID.","operationId":"handler_webhooks__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Webhooks"],"summary":"Update Webhook Subscription","description":"Update a webhook subscription identified by ID.","operationId":"handler_webhooks__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhook"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Delete Webhook Subscription","description":"Delete a webhook subscription identified by ID.","operationId":"handler_webhooks__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/webhooks/{id}/secret":{"get":{"tags":["Webhooks"],"summary":"Get Webhook Signing Secret","description":"Fetch a webhook subscription identified by ID and include the webhook's signing secret value.","operationId":"handler_webhooks__id__secret_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPublicWithSecret"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests":{"post":{"tags":["Requests"],"summary":"Create Request","description":"Create a new document collection request and send out the request to the specified recipients.","operationId":"handler_requests_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestPostParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Requests"],"summary":"List Requests","description":"Retrieve a list of requests.","operationId":"handler_requests_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/RequestStatus","description":"Filter requests by status"},"description":"Filter requests by status"},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Order to sort resources by, based on creation date","default":"desc"},"description":"Order to sort resources by, based on creation date"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Number of items to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RequestPublic"},"title":"Response Handler Requests Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{id}":{"get":{"tags":["Requests"],"summary":"Get Request","description":"Fetch Request identified by ID.","operationId":"handler_requests__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{org_id}/requests":{"get":{"tags":["Requests"],"summary":"List Organization Requests","description":"Retrieve a list of requests associated with the specified organization.","operationId":"handler_organizations__org_id__requests_get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Order to sort resources by, based on creation date","default":"desc"},"description":"Order to sort resources by, based on creation date"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Number of items to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RequestPublic"},"title":"Response Handler Organizations  Org Id  Requests Get"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}":{"patch":{"tags":["Requests"],"summary":"Update Request","description":"Update a request identified by ID.","operationId":"handler_requests__request_id__patch","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRequestPostParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Requests"],"summary":"Delete Request","description":"Delete a request identified by ID.","operationId":"handler_requests__request_id__delete","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/close":{"post":{"tags":["Requests"],"summary":"Close Request","description":"Close a request identified by ID","operationId":"handler_requests__request_id__close_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPublic"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}}}}}},"/requests/{request_id}/items":{"post":{"tags":["RequestItems"],"summary":"Create Request Item","description":"Create new request item associated with specified request.","operationId":"handler_requests__request_id__items_post","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["RequestItems"],"summary":"List Request Items","description":"Retrieve list of items associated with request.","operationId":"handler_requests__request_id__items_get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RequestItemPublic"},"title":"Response Handler Requests  Request Id  Items Get"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/items/{item_id}":{"get":{"tags":["RequestItems"],"summary":"Get Request Item","description":"Fetch request item associated with request.","operationId":"handler_requests__request_id__items__item_id__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemNotFound"}}},"description":"Not Found"}}},"patch":{"tags":["RequestItems"],"summary":"Update Request Item","description":"Update request item.","operationId":"handler_requests__request_id__items__item_id__patch","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRequestItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["RequestItems"],"summary":"Delete Request Item","description":"Delete a request item.","operationId":"handler_requests__request_id__items__item_id__delete","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/items/{item_id}/verify":{"post":{"tags":["RequestItems"],"summary":"Verify Request Item","description":"Mark a request item as verified, which indicates that the request item is valid and approved.","operationId":"handler_requests__request_id__items__item_id__verify_post","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/reminders":{"post":{"tags":["ScheduledReminders"],"summary":"Create Scheduled Reminder","description":"Create a new scheduled reminder associated with the specified request.","operationId":"handler_requests__request_id__reminders_post","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateScheduledReminder"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["ScheduledReminders"],"summary":"List Scheduled Reminders","description":"Retrieve list of scheduled reminders associated with request.","operationId":"handler_requests__request_id__reminders_get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledNotificationPublic"},"title":"Response Handler Requests  Request Id  Reminders Get"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/reminders/{reminder_id}":{"get":{"tags":["ScheduledReminders"],"summary":"Get Scheduled Reminder","description":"Fetch scheduled reminder associated with request.","operationId":"handler_requests__request_id__reminders__reminder_id__get","parameters":[{"name":"reminder_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["ScheduledReminders"],"summary":"Update Scheduled Reminder","description":"Update a scheduled reminder.","operationId":"handler_requests__request_id__reminders__reminder_id__patch","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"reminder_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScheduledReminder"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["ScheduledReminders"],"summary":"Delete Scheduled Reminder","description":"Disable a scheduled reminder (soft delete).","operationId":"handler_requests__request_id__reminders__reminder_id__delete","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"reminder_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/escalations":{"post":{"tags":["Escalations"],"summary":"Create Escalations","description":"Create a new escalation notification associated with the specified request.","operationId":"handler_requests__request_id__escalations_post","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEscalation"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Escalations"],"summary":"List Escalations","description":"Retrieve list of escalations associated with request.","operationId":"handler_requests__request_id__escalations_get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledNotificationPublic"},"title":"Response Handler Requests  Request Id  Escalations Get"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/escalations/{escalation_id}":{"get":{"tags":["Escalations"],"summary":"Get Escalation","description":"Fetch escalation notification associated with a request.","operationId":"handler_requests__request_id__escalations__escalation_id__get","parameters":[{"name":"escalation_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Escalations"],"summary":"Update Escalation","description":"Update a scheduled escalation notification.","operationId":"handler_requests__request_id__escalations__escalation_id__patch","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"escalation_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEscalation"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduledNotificationNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Escalations"],"summary":"Delete Escalation","description":"Disable a scheduled escalation notification (soft delete).","operationId":"handler_requests__request_id__escalations__escalation_id__delete","parameters":[{"name":"escalation_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/documents/{id}":{"get":{"tags":["Documents"],"summary":"Get Document","description":"Fetch Document identified by ID","operationId":"handler_documents__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Documents"],"summary":"Delete Document","description":"Delete a Document identified by ID.","operationId":"handler_documents__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/documents":{"get":{"tags":["Documents"],"summary":"List Request Documents","description":"Retrieve a list of documents submitted for a request.","operationId":"handler_requests__request_id__documents_get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentWithItemPublic"},"title":"Response Handler Requests  Request Id  Documents Get"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Documents"],"summary":"Delete Request Documents","description":"Delete all documents submitted for a request.","operationId":"handler_requests__request_id__documents_delete","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/items/{item_id}/documents":{"get":{"tags":["Documents"],"summary":"List Request Item Documents","description":"Retrieve a list of documents submitted for a request item.","operationId":"handler_requests__request_id__items__item_id__documents_get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"item_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentPublic"},"title":"Response Handler Requests  Request Id  Items  Item Id  Documents Get"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/documents/{id}/download":{"get":{"tags":["Documents"],"summary":"Download Document","description":"Download a document identified by ID.","operationId":"handler_documents__id__download_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"filename_format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FilenameFormat","description":"Format for the downloaded filename","default":"STANDARD"},"description":"Format for the downloaded filename"}],"responses":{"200":{"description":"Successful Response","content":{"application/octet-stream":{"example":"Contract.pdf","schema":{"type":"file","format":"binary"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/download":{"get":{"tags":["Documents"],"summary":"Download Request Documents","description":"Download all documents submitted for a request.","operationId":"handler_requests__request_id__download_get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/zip":{"example":"893278c8-d728-42e8-a58e-59e781961085.zip","schema":{"type":"file","format":"binary"}}}},"204":{"description":"No Content"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/requests/{request_id}/items/{item_id}/download":{"get":{"tags":["Documents"],"summary":"Download Request Item Documents","description":"Download all documents submitted for a request item.","operationId":"handler_requests__request_id__items__item_id__download_get","parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"item_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}},"application/zip":{"example":"98f8827d-b090-4f37-b24b-33509a6be9ba.zip","schema":{"type":"file","format":"binary"}}}},"204":{"description":"No Content"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestItemNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/whoami":{"get":{"tags":["Users"],"summary":"Get Current User","description":"Fetch details about the currently authenticated user.","operationId":"handler_whoami_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionPayloadPublic"}}}}}}},"/users":{"get":{"tags":["Users"],"summary":"List Users","description":"Retrieve a list of users associated with the authenticated user's team(s).","operationId":"handler_users_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserPublic"},"type":"array","title":"Response Handler Users Get"}}}}}}},"/organizations/{org_id}/users":{"get":{"tags":["Users"],"summary":"List Organization users","description":"Retrieve a list of users associated with the specified organization.","operationId":"handler_organizations__org_id__users_get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserPublic"},"title":"Response Handler Organizations  Org Id  Users Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/{id}":{"get":{"tags":["Users"],"summary":"Get User","description":"Fetch User identified by ID.","operationId":"handler_users__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/contacts":{"get":{"tags":["Contacts"],"summary":"List Contacts","description":"Retrieve a list of contacts.","operationId":"handler_contacts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecipientPublic"},"type":"array","title":"Response Handler Contacts Get"}}}}}},"post":{"tags":["Contacts"],"summary":"Create or Update Contact","description":"Creates a new contact (recipient) or updates an existing one based on the provided email and phone number combination for the authenticated user.","operationId":"create_or_update_contact_contacts_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRecipientPostParams"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipientPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{org_id}/contacts":{"get":{"tags":["Contacts"],"summary":"List Organization Contacts","description":"Retrieve a list of contacts.","operationId":"handler_organizations__org_id__contacts_get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecipientPublic"},"title":"Response Handler Organizations  Org Id  Contacts Get"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/teams":{"get":{"tags":["Teams"],"summary":"List Teams","description":"Retrieve a list of teams that the user is a member of.","operationId":"handler_teams_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TeamPublic"},"type":"array","title":"Response Handler Teams Get"}}}}}}},"/teams/{id}":{"get":{"tags":["Teams"],"summary":"Get Team","description":"Fetch Team identified by ID.","operationId":"handler_teams__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamPublic"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/forms/{form_id}":{"get":{"tags":["Forms"],"summary":"Get Form","description":"Get a form by ID.","operationId":"handler_forms__form_id__get","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Forms"],"summary":"Delete Form","description":"Delete a form identified by ID.","operationId":"handler_forms__form_id__delete","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormNotFound"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/forms":{"get":{"tags":["Forms"],"summary":"List Forms","description":"Retrieve a list of forms.","operationId":"handler_forms_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FormPublic"},"type":"array","title":"Response Handler Forms Get"}}}}}},"post":{"tags":["Forms"],"summary":"Create Form","description":"Upload a file and create a new form that can be referenced when creating e-signature request items.","operationId":"handler_forms_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_handler_forms_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AuthMethod":{"type":"string","enum":["NONE","EMAIL","SMS","SECURITY_QUESTION"],"title":"AuthMethod"},"Body_handler_attachments_post":{"properties":{"file":{"type":"string","format":"binary","description":"The file to upload"}},"type":"object","required":["file"],"title":"Body_handler_attachments_post"},"Body_handler_forms_post":{"properties":{"metadata":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the new form file (if not set, defaults to uploaded file name)."},"clear_fields":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Clear Fields","description":"Indicates whether or not any existing fields should be cleared from the form. Defaults to True.","default":true},"fields":{"anyOf":[{"items":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"type":{"type":"string","enum":["TEXT","SIGNATURE","INITIALS","DATE","CHECKBOX","RADIO","INITIALS_GROUP","DROPDOWN"],"title":"FormFieldType"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required","description":"Whether the sender must complete this field. Defaults to true.","default":true},"coordinates":{"anyOf":[{"properties":{"x":{"type":"number","title":"X"},"y":{"type":"number","title":"Y"},"page_number":{"type":"integer","title":"Page Number","default":1}},"type":"object","required":["x","y"],"title":"XYCoordinates"},{"properties":{"anchor":{"type":"string","title":"Anchor"},"offset_x":{"type":"number","title":"Offset X","default":0.0},"offset_y":{"type":"number","title":"Offset Y","default":0.0}},"type":"object","required":["anchor"],"title":"MarkerCoordinates"}],"title":"Coordinates"},"width":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Width","description":"Field width in PDF points, alongside coordinates, not inside it. Required for x/y placement; defaults to the anchor width for marker placement."},"height":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Height","description":"Field height in PDF points, alongside coordinates, not inside it. Required for x/y placement; defaults to the anchor height for marker placement."}},"type":"object","required":["name","type","coordinates"],"title":"CreateFormFieldMetadata"},"type":"array"},{"type":"null"}],"title":"Fields","default":[]}},"type":"object"},"file":{"type":"string","format":"binary","description":"The file to upload"}},"type":"object","required":["metadata","file"],"title":"Body_handler_forms_post"},"ButtonStyle":{"properties":{"bg_color":{"type":"string"},"text_color":{"type":"string"},"text":{"type":"string"}},"type":"object","title":"ButtonStyle"},"CollaboratorPublic":{"properties":{"id":{"type":"string"},"role":{"$ref":"#/components/schemas/UserRole"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["id","role"],"title":"CollaboratorPublic"},"ConnectionProvider":{"type":"string","enum":["PIGEON","GOOGLE_DRIVE","BOX","DROPBOX","AZURE","ONENOTE","DOCKETWISE","CLIO"],"title":"ConnectionProvider"},"CreateDocGen":{"properties":{"item_id":{"type":"string"},"values":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","required":["item_id","values"],"title":"CreateDocGen"},"CreateDocumentField":{"properties":{"default_value":{"type":"string"},"read_only":{"default":false,"type":"boolean"}},"type":"object","title":"CreateDocumentField"},"CreateESignatureItem":{"properties":{"id":{"type":"string","description":"ID of the Form to use for this e-signature item."},"allow_file_upload":{"type":"boolean","description":"If true, recipients may upload a file as an alternative to completing the e-signature.","default":false},"fields":{"additionalProperties":{"$ref":"#/components/schemas/CreateDocumentField"},"type":"object"}},"additionalProperties":false,"type":"object","required":["id"],"title":"CreateESignatureItem"},"CreateEscalation":{"properties":{"send_at":{"type":"string","format":"date-time"},"recipients":{"items":{"$ref":"#/components/schemas/CreateScheduledNotificationRecipient"},"type":"array"},"message":{"type":"string"},"subject":{"type":"string"},"hero":{"$ref":"#/components/schemas/HeroStyle"},"button":{"$ref":"#/components/schemas/ButtonStyle"}},"additionalProperties":false,"type":"object","required":["send_at","recipients"],"title":"CreateEscalation"},"CreateQuestionItem":{"properties":{"type":{"$ref":"#/components/schemas/QuestionType","default":"TEXT"},"answer":{"description":"Prefilled question answer. Note that for TEXT type questions, the prefilled answer will not be visible to recipients.","type":"string"}},"additionalProperties":false,"type":"object","title":"CreateQuestionItem"},"CreateRecipientPostParams":{"properties":{"first_name":{"type":"string","description":"Recipient's first name"},"last_name":{"type":"string","description":"Recipient's last name"},"email":{"description":"Recipient's email address","type":"string","format":"email"},"phone":{"description":"Recipient's phone number. The phone number is expected to be in <a href='https://www.twilio.com/docs/glossary/what-e164' target='_blank'>E.164 format</a> and must include a country code (ie '+1').","type":"string"},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"},"owner_id":{"description":"ID of user who is making the request. Defaults to currently authenticated user.","type":"string"}},"additionalProperties":false,"type":"object","required":["first_name","last_name"],"title":"CreateRecipientPostParams"},"CreateRequestItem":{"properties":{"name":{"type":"string","minLength":1,"description":"Item name. For items with type: Question, the name is used as the question text."},"type":{"$ref":"#/components/schemas/ItemType","description":"Type of the request item"},"description":{"description":"Item description","type":"string"},"required":{"description":"Indicates whether the recipient is required to complete the request item. Defaults to true.","default":true,"type":"boolean"},"received":{"description":"If true, request item will appear as completed in request checklist.","default":false,"type":"boolean"},"question":{"description":"Question configuration. Only valid when `type` is QUESTION.","$ref":"#/components/schemas/CreateQuestionItem"},"form":{"description":"Form configuration. Only valid when `type` is E_SIGNATURE.","$ref":"#/components/schemas/CreateESignatureItem"}},"additionalProperties":false,"type":"object","required":["name","type"],"title":"CreateRequestItem"},"CreateRequestPostParams":{"properties":{"recipients":{"items":{"$ref":"#/components/schemas/CreateRequestRecipient"},"type":"array","description":"Provide a list of recipients—supplying only an existing recipient’s id to reuse their saved details, or include required recipient fields to create a new one and associate with this request."},"name":{"description":"Request name. Required unless templateId is set. In the case templateId is set, will use the default template title","type":"string"},"due_date":{"description":"Date when request must be completed by.","type":"string","format":"date-time"},"expiration_date":{"description":"Date when request and all submitted documents will be deleted. Must be greater than (later than) due date. Defaults to organizational settings.","type":"string","format":"date-time"},"auto_close_at":{"description":"Date when request will automatically close if not completed.","type":"string","format":"date-time"},"personal_message":{"description":"Custom message displayed to recipient when viewing the request. Overwrites template customMessage when set. Renders as HTML.","type":"string"},"notes":{"description":"Internal notes about request intended for owner and collaborator use. Notes are rendered as HTML on dashboard's View Request page.","type":"string"},"user_metadata":{"description":"JSON field used for storing additional, structured information with a request.","additionalProperties":true,"type":"object"},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"},"reminders":{"description":"Interval for reminder notifications, in days. Default is 3. Valid values: null (no reminders) or ≥ 1.","default":3,"type":"integer","exclusiveMinimum":0.0},"first_reminder_date":{"description":"Optional date when the first reminder should be sent. If not set, reminders start based on request creation date + reminder interval. Must be a future date.","type":"string","format":"date-time"},"items":{"description":"Items included in the request. Required unless templateId is set. Overwrites template items when set.","default":[],"items":{"$ref":"#/components/schemas/CreateRequestItem"},"type":"array"},"collaborators":{"description":"Collaborators receive email updates related to request lifecycle and have limited edit access to the request.","default":[],"items":{"type":"string"},"type":"array"},"cloud_storage_folder":{"description":"Path to folder in cloud storage provider where request documents will be stored.","type":"string"},"cloud_storage_provider":{"description":"Cloud storage provider used to store request documents.","default":"PIGEON","$ref":"#/components/schemas/ConnectionProvider"},"require_complete_submission":{"description":"When true, the request cannot be submitted until every required item is complete; partial submissions are blocked.","default":false,"type":"boolean"},"disable_submission_comments":{"description":"When true, the Add Message option is hidden when the request is submitted.","default":false,"type":"boolean"},"owner_id":{"description":"ID of the contact owner. Defaults to the currently authenticated user.","type":"string"},"team_id":{"description":"ID of the Team associated with the request. Defaults to the currently authenticated user's default team.","type":"string"},"mfa_enabled":{"type":"boolean"},"template_id":{"description":"Template identifier. Specify this value if creating request from predefined template.","type":"string"},"attachments":{"description":"List of Attachment IDs to include with the request. Create attachments via POST /attachments.","items":{"type":"string"},"type":"array"},"skip_initial_notification":{"description":"If true, does not send initial notificiation out to recipients when request is created. Defaults to false.","default":false,"type":"boolean"},"overwrite_template_items":{"description":"When true, the items specified in this request will overwrite any existing template items. When false, the items will be appended to the template's items. Defaults to false.","default":false,"type":"boolean"},"doc_gen":{"description":"Specify the values used to replace templated values for document generation. You must specify all document generation values for each item. This field is only supported when creating a request from a template with item(s) configured for document generation.","items":{"$ref":"#/components/schemas/CreateDocGen"},"type":"array"},"reminder_schedule":{"description":"Scheduled reminder notifications to be sent if a request is not completed.","items":{"$ref":"#/components/schemas/CreateScheduledReminder"},"type":"array"},"escalations":{"description":"Scheduled escalation notifications to be sent if a request is not completed.","items":{"$ref":"#/components/schemas/CreateEscalation"},"type":"array"}},"additionalProperties":false,"type":"object","required":["recipients"],"title":"CreateRequestPostParams"},"CreateRequestRecipient":{"properties":{"first_name":{"type":"string","description":"Recipient's first name"},"last_name":{"type":"string","description":"Recipient's last name"},"email":{"description":"Recipient's email address","type":"string","format":"email"},"phone":{"description":"Recipient's phone number. The phone number is expected to be in <a href='https://www.twilio.com/docs/glossary/what-e164' target='_blank'>E.164 format</a> and must include a country code (ie '+1').","type":"string"},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"},"id":{"type":"string"},"auth_method":{"description":"Method used for authenticating recipient before they are able to open and complete request.","default":"NONE","$ref":"#/components/schemas/AuthMethod"},"send_method":{"description":"Method used for notifying recipient about request.","default":"EMAIL","$ref":"#/components/schemas/SendMethod"},"question_text":{"description":"Text of security question. Only valid when auth_method = SECURITY_QUESTION.","type":"string"},"question_answer":{"description":"Answer to security question. Only valid when auth_method = SECURITY_QUESTION.","type":"string"}},"additionalProperties":false,"type":"object","required":["first_name","last_name"],"title":"CreateRequestRecipient","description":"Model to create a RequestRecipient record and optionally a Recipient record.\n\nIf the `id` field is provided:\n    - Then the CreateRequestRecipientByID model is used for validation and a new\n    RequestRecipient record is associated with the Recipient identified by `id`.\nElse:\n    - The CreateNewRequestRecipient model is used for validation and a new\n    Recipient is created with the specified request data."},"CreateScheduledNotificationRecipient":{"properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"}},"type":"object","required":["email"],"title":"CreateScheduledNotificationRecipient"},"CreateScheduledReminder":{"properties":{"send_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"subject":{"type":"string"},"hero":{"$ref":"#/components/schemas/HeroStyle"},"button":{"$ref":"#/components/schemas/ButtonStyle"}},"additionalProperties":false,"type":"object","required":["send_at"],"title":"CreateScheduledReminder"},"CreateTemplatePostParams":{"properties":{"name":{"type":"string","description":"Template name"},"items":{"items":{"$ref":"#/components/schemas/CreateRequestItem"},"type":"array","description":"Items included in the request"},"default_title":{"description":"Default title for request created from template.","type":"string"},"personal_message":{"description":"Custom message displayed to recipients when viewing the request","type":"string"},"reminders":{"description":"Interval at which recipients will receive reminder notifications to complete request, measured in days. The default value is three (3) days.","default":3,"type":"integer","exclusiveMinimum":0.0},"due_date_interval":{"description":"Number of days from request creation when the request should be due. When set, automatically calculates due_date when creating requests from this template.","type":"integer","exclusiveMinimum":0.0},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"}},"additionalProperties":false,"type":"object","required":["name","items"],"title":"CreateTemplatePostParams"},"CreateWebhookWithoutOrg":{"properties":{"endpoint":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","description":"Destination URI to which the webhook subscription should send the POST request when an event occurs"},"topics":{"items":{"$ref":"#/components/schemas/WebhookTopic"},"type":"array","minItems":1,"description":"Event that triggers the webhook"}},"additionalProperties":false,"type":"object","required":["endpoint","topics"],"title":"CreateWebhookWithoutOrg"},"CustomerDocumentPublic":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"size":{"type":"integer"},"mime_type":{"type":"string"},"creation_date":{"type":"string","format":"date-time"}},"type":"object","required":["id","name","size","mime_type"],"title":"CustomerDocumentPublic"},"DocumentNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"DocumentNotFound","examples":[{"code":"DOCUMENT_NOT_FOUND","message":"Document with specified ID not found.","type":"NOT_FOUND"}]},"DocumentPublic":{"properties":{"name":{"type":"string","description":"Document name"},"type":{"$ref":"#/components/schemas/DocumentType","description":"Item type document was submitted for"},"id":{"type":"string"},"creation_date":{"type":"string","format":"date-time","description":"Document creation timestamp"},"item_id":{"type":"string","description":"ID of Request Item document was submitted for"},"size":{"description":"Document size in bytes","type":"integer"},"recipient_id":{"description":"ID of recipient who submitted document","type":"string"},"data_link":{"description":"For documents stored outside of Pigeon, the URL where the document is available for access.","type":"string"},"completed":{"description":"Indicates whether a document has been completed. Only applies to documents where type: E_SIGNATURE.","type":"boolean"},"extracted_metadata":{"description":"Extracted metadata from the document","additionalProperties":true,"type":"object"}},"type":"object","required":["name","type","id","creation_date","item_id"],"title":"DocumentPublic"},"DocumentType":{"type":"string","enum":["FILE","E_SIGNATURE","QUESTION"],"title":"DocumentType"},"DocumentWithItemPublic":{"properties":{"name":{"type":"string","description":"Document name"},"type":{"$ref":"#/components/schemas/DocumentType","description":"Item type document was submitted for"},"id":{"type":"string"},"creation_date":{"type":"string","format":"date-time","description":"Document creation timestamp"},"item_id":{"type":"string","description":"ID of Request Item document was submitted for"},"item_name":{"type":"string","description":"Name of Request Item document was submitted for"},"size":{"description":"Document size in bytes","type":"integer"},"recipient_id":{"description":"ID of recipient who submitted document","type":"string"},"data_link":{"description":"For documents stored outside of Pigeon, the URL where the document is available for access.","type":"string"},"completed":{"description":"Indicates whether a document has been completed. Only applies to documents where type: E_SIGNATURE.","type":"boolean"},"extracted_metadata":{"description":"Extracted metadata from the document","additionalProperties":true,"type":"object"}},"type":"object","required":["name","type","id","creation_date","item_id","item_name"],"title":"DocumentWithItemPublic"},"FilenameFormat":{"type":"string","enum":["STANDARD","PREPEND_ITEM_NAME"],"title":"FilenameFormat"},"FormFieldPublic":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/FormFieldType"},"required":{"default":false,"type":"boolean"},"dropdown_options":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["id","name","type"],"title":"FormFieldPublic"},"FormFieldType":{"type":"string","enum":["TEXT","SIGNATURE","INITIALS","DATE","CHECKBOX","RADIO","INITIALS_GROUP","DROPDOWN"],"title":"FormFieldType"},"FormNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"FormNotFound","examples":[{"code":"FORM_NOT_FOUND","message":"Form with specified ID not found.","type":"NOT_FOUND"}]},"FormPublic":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"size":{"description":"File size (in bytes)","type":"integer"},"fields":{"items":{"$ref":"#/components/schemas/FormFieldPublic"},"type":"array","description":"Fields associated with the form","default":[]}},"type":"object","required":["id","name","size"],"title":"FormPublic"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array"}},"type":"object","title":"HTTPValidationError"},"HeroStyle":{"properties":{"bg_color":{"type":"string"},"text_color":{"type":"string"},"text":{"type":"string"}},"type":"object","title":"HeroStyle"},"ItemType":{"type":"string","enum":["UPLOAD","E_SIGNATURE","QUESTION"],"title":"ItemType"},"Language":{"type":"string","enum":["en-US","es","ar","zh","fr","de","ht","he","id","it","ko","pt","pa","ru"],"title":"Language"},"OrganizationNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"OrganizationNotFound","examples":[{"code":"ORGANIZATION_NOT_FOUND","message":"Organization with specified ID not found.","type":"NOT_FOUND"}]},"QuestionType":{"type":"string","enum":["TEXT","DATE"],"title":"QuestionType"},"RecipientPublic":{"properties":{"id":{"description":"Unique identifier for the recipient.","type":"string"},"first_name":{"description":"Recipient's first name","type":"string"},"last_name":{"description":"Recipient's last name","type":"string"},"email":{"description":"Recipient's email address","type":"string"},"phone":{"description":"Recipient's phone number. The phone number is expected to be in <a href='https://www.twilio.com/docs/glossary/what-e164' target='_blank'>E.164 format</a> and must include a country code (ie '+1').","type":"string"},"owner_id":{"description":"ID of the user who owns the recipient.","type":"string"},"team_id":{"description":"ID of the team the recipient is associated with.","type":"string"},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"}},"type":"object","required":["id","first_name","last_name","email","phone","owner_id","team_id"],"title":"RecipientPublic"},"RequestAttachmentPublic":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"size":{"type":"integer"},"creation_date":{"type":"string","format":"date-time"}},"type":"object","required":["id","name","size"],"title":"RequestAttachmentPublic"},"RequestItemNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"RequestItemNotFound","examples":[{"code":"REQUEST_ITEM_NOT_FOUND","message":"Request Item with specified ID not found.","type":"NOT_FOUND"}]},"RequestItemPublic":{"properties":{"name":{"type":"string","description":"Item name. For items with type: Question, the name is used as the question text."},"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ItemType","description":"Type of the request item"},"description":{"description":"Item description","type":"string"},"required":{"description":"Indicates whether the recipient is required to complete the request item. Defaults to true.","default":true,"type":"boolean"},"answer":{"description":"Question answer. Only applies to items with type: QUESTION","type":"string"},"verified":{"description":"Indicates whether the request item has been verified by the recipient","default":false,"type":"boolean"},"is_na":{"description":"Indicates whether the request item is not applicable","default":false,"type":"boolean"}},"type":"object","required":["name","id","type"],"title":"RequestItemPublic"},"RequestNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"RequestNotFound","examples":[{"code":"REQUEST_NOT_FOUND","message":"Request with specified ID not found.","type":"NOT_FOUND"}]},"RequestPublic":{"properties":{"name":{"type":"string","description":"Request name. Required unless templateId is set. In the case templateId is set, will use the default template title"},"items":{"items":{"$ref":"#/components/schemas/RequestItemPublic"},"type":"array","description":"Items included in the request. Required unless templateId is set. Overwrites template items when set."},"recipients":{"items":{"$ref":"#/components/schemas/RequestRecipientPublic"},"type":"array","description":"Provide a list of recipients—supplying only an existing recipient’s id to reuse their saved details, or include required recipient fields to create a new one and associate with this request."},"id":{"type":"string"},"owner_id":{"type":"string","description":"Identifier for request owner/manager"},"team_id":{"type":"string","description":"Identifier for team that template is associated with"},"owner_opened":{"type":"boolean","description":"Whether request has been opened by owner"},"status":{"$ref":"#/components/schemas/RequestStatus","description":"Current request status","readOnly":true},"verified":{"type":"boolean","description":"Whether request has been verified by owner","readOnly":true},"deleted":{"type":"boolean","description":"Whether request has been deleted","readOnly":true},"rejected":{"type":"boolean","description":"Whether recipient's submission has been rejected by owner","readOnly":true},"reminder_schedule":{"items":{"$ref":"#/components/schemas/ScheduledNotificationPublic"},"type":"array","description":"Scheduled reminder notifications to be sent if the request is not completed.","readOnly":true},"escalations":{"items":{"$ref":"#/components/schemas/ScheduledNotificationPublic"},"type":"array","description":"Scheduled escalation notifications to be sent if the request is not completed.","readOnly":true},"due_date":{"description":"Date when request must be completed by.","type":"string","format":"date-time"},"expiration_date":{"description":"Date when request and all submitted documents will be deleted. Must be greater than (later than) due date. Defaults to organizational settings.","type":"string","format":"date-time"},"auto_close_at":{"description":"Date when request will automatically close if not completed.","type":"string","format":"date-time"},"personal_message":{"description":"Custom message displayed to recipient when viewing the request. Overwrites template customMessage when set. Renders as HTML.","type":"string"},"notes":{"description":"Internal notes about request intended for owner and collaborator use. Notes are rendered as HTML on dashboard's View Request page.","type":"string"},"user_metadata":{"description":"JSON field used for storing additional, structured information with a request.","additionalProperties":true,"type":"object"},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"},"reminders":{"description":"Interval for reminder notifications, in days. Default is 3. Valid values: null (no reminders) or ≥ 1.","default":"-1","type":"string"},"first_reminder_date":{"description":"Optional date when the first reminder should be sent. If not set, reminders start based on request creation date + reminder interval. Must be a future date.","type":"string","format":"date-time"},"collaborators":{"description":"Collaborators receive email updates related to request lifecycle and have limited edit access to the request.","default":[],"items":{"$ref":"#/components/schemas/CollaboratorPublic"},"type":"array"},"cloud_storage_folder":{"description":"Path to folder in cloud storage provider where request documents will be stored.","type":"string"},"cloud_storage_provider":{"description":"Cloud storage provider used to store request documents.","$ref":"#/components/schemas/ConnectionProvider"},"require_complete_submission":{"description":"When true, the request cannot be submitted until every required item is complete; partial submissions are blocked.","default":false,"type":"boolean"},"disable_submission_comments":{"description":"When true, the Add Message option is hidden when the request is submitted.","default":false,"type":"boolean"},"user_opened":{"type":"boolean","description":"Whether a recipient has opened the request","default":false},"template_id":{"description":"ID of Template used to create request","type":"string"},"percent_complete":{"description":"Completion percentage based on completion status of request's items","default":0.0,"type":"number"},"attachments":{"items":{"$ref":"#/components/schemas/RequestAttachmentPublic"},"type":"array","description":"Attachments associated with the request","default":[]}},"additionalProperties":true,"type":"object","required":["name","items","recipients","id","owner_id","team_id","owner_opened","status","verified","deleted","rejected","reminder_schedule","escalations"],"title":"RequestPublic"},"RequestRecipientPublic":{"properties":{"request_link":{"description":"Link used by recipient to complete request. Each link is unique and specific to associated recipient.","type":"string"},"mfa_link":{"description":"","type":"string"},"auth":{"description":"Method used for authenticating recipient before they are able to open and complete request.","$ref":"#/components/schemas/AuthMethod"},"password":{"description":"Unique code used for authentication. Only valid when auth_method = EMAIL or SMS.","type":"string"},"recipient":{"$ref":"#/components/schemas/RecipientPublic"}},"type":"object","required":["request_link","mfa_link","auth","password","recipient"],"title":"RequestRecipientPublic"},"RequestStatus":{"type":"string","enum":["CLOSED","INCOMPLETE","COMPLETE","EXPIRED","VERIFIED"],"title":"RequestStatus"},"ScheduledNotificationNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"ScheduledNotificationNotFound","examples":[{"code":"SCHEDULED_NOTIFICATION_NOT_FOUND","message":"Scheduled Notification with specified ID not found.","type":"NOT_FOUND"}]},"ScheduledNotificationPublic":{"additionalProperties":true,"type":"object"},"SendMethod":{"type":"string","enum":["EMAIL","SMS","BOTH","LINK"],"title":"SendMethod"},"SessionPayloadPublic":{"additionalProperties":true,"type":"object"},"SortOrder":{"type":"string","enum":["asc","desc"],"title":"SortOrder"},"TeamNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"TeamNotFound","examples":[{"code":"TEAM_NOT_FOUND","message":"Team with specified ID not found.","type":"NOT_FOUND"}]},"TeamPublic":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"org_id":{"type":"string"},"active":{"type":"boolean"}},"type":"object","required":["id","name","org_id","active"],"title":"TeamPublic"},"TemplateNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"TemplateNotFound","examples":[{"code":"TEMPLATE_NOT_FOUND","message":"Template with specified ID not found.","type":"NOT_FOUND"}]},"TemplatePublic":{"properties":{"name":{"type":"string","description":"Template name"},"id":{"type":"string"},"owner_id":{"type":"string","description":"Identifier for template owner/manager"},"team_id":{"type":"string","description":"Identifier for team that template is associated with"},"items":{"items":{"$ref":"#/components/schemas/RequestItemPublic"},"type":"array","description":"Items included in the request"},"default_title":{"description":"Default title for request created from template.","type":"string"},"personal_message":{"description":"Custom message displayed to recipients when viewing the request","type":"string"},"reminders":{"description":"Interval at which recipients will receive reminder notifications to complete request, measured in days.","type":"string"},"due_date_interval":{"description":"Number of days from request creation when the request should be due. When set, automatically calculates due_date when creating requests from this template.","type":"integer","exclusiveMinimum":0.0},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"}},"type":"object","required":["name","id","owner_id","team_id","items"],"title":"TemplatePublic"},"UpdateEscalation":{"properties":{"send_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"subject":{"type":"string"},"hero":{"$ref":"#/components/schemas/HeroStyle"},"button":{"$ref":"#/components/schemas/ButtonStyle"},"recipients":{"default":[],"items":{"$ref":"#/components/schemas/UpdateScheduledNotificationRecipient"},"type":"array"}},"additionalProperties":false,"type":"object","title":"UpdateEscalation"},"UpdateRequestItem":{"properties":{"name":{"description":"Item name. For items with type: Question, the name is used as the question text.","type":"string","minLength":1},"description":{"description":"Item description","type":"string"},"required":{"description":"Indicates whether the recipient is required to complete the request item. Defaults to true.","default":true,"type":"boolean"}},"additionalProperties":false,"type":"object","title":"UpdateRequestItem","description":"RequestItem attributes that can be set by end user"},"UpdateRequestPostParams":{"properties":{"name":{"description":"Request name. Required unless templateId is set. In the case templateId is set, will use the default template title","type":"string"},"due_date":{"description":"Date when request must be completed by.","type":"string","format":"date-time"},"expiration_date":{"description":"Date when request and all submitted documents will be deleted. Must be greater than (later than) due date. Defaults to organizational settings.","type":"string","format":"date-time"},"auto_close_at":{"description":"Date when request will automatically close if not completed.","type":"string","format":"date-time"},"personal_message":{"description":"Custom message displayed to recipient when viewing the request. Overwrites template customMessage when set. Renders as HTML.","type":"string"},"notes":{"description":"Internal notes about request intended for owner and collaborator use. Notes are rendered as HTML on dashboard's View Request page.","type":"string"},"user_metadata":{"description":"JSON field used for storing additional, structured information with a request.","additionalProperties":true,"type":"object"},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"},"reminders":{"description":"Interval for reminder notifications, in days. Default is 3. Valid values: null (no reminders) or ≥ 1.","type":"integer","exclusiveMinimum":0.0},"first_reminder_date":{"description":"Optional date when the first reminder should be sent. If not set, reminders start based on request creation date + reminder interval. Must be a future date.","type":"string","format":"date-time"},"collaborators":{"description":"Collaborators receive email updates related to request lifecycle and have limited edit access to the request.","default":[],"items":{"type":"string"},"type":"array"},"cloud_storage_folder":{"description":"Path to folder in cloud storage provider where request documents will be stored.","type":"string"},"cloud_storage_provider":{"description":"Cloud storage provider used to store request documents.","default":"PIGEON","$ref":"#/components/schemas/ConnectionProvider"},"require_complete_submission":{"description":"When true, the request cannot be submitted until every required item is complete; partial submissions are blocked.","default":false,"type":"boolean"},"disable_submission_comments":{"description":"When true, the Add Message option is hidden when the request is submitted.","default":false,"type":"boolean"},"owner_id":{"description":"Identifier for request owner/manager","type":"string"},"skip_notification":{"description":"If true, does not send notification out to recipients when request is updated. Defaults to false.","default":false,"type":"boolean"}},"additionalProperties":false,"type":"object","title":"UpdateRequestPostParams"},"UpdateScheduledNotificationRecipient":{"properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"}},"type":"object","title":"UpdateScheduledNotificationRecipient"},"UpdateScheduledReminder":{"properties":{"send_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"subject":{"type":"string"},"hero":{"$ref":"#/components/schemas/HeroStyle"},"button":{"$ref":"#/components/schemas/ButtonStyle"}},"additionalProperties":false,"type":"object","title":"UpdateScheduledReminder"},"UpdateTemplate":{"properties":{"name":{"description":"Template name","type":"string"},"default_title":{"description":"Default title for request created from template.","type":"string"},"personal_message":{"description":"Custom message displayed to recipients when viewing the request","type":"string"},"reminders":{"description":"Interval at which recipients will receive reminder notifications to complete request, measured in days.","type":"string"},"due_date_interval":{"description":"Number of days from request creation when the request should be due. When set, automatically calculates due_date when creating requests from this template.","type":"integer","exclusiveMinimum":0.0},"language":{"description":"Defaults to English (en).","default":"en-US","$ref":"#/components/schemas/Language"},"items":{"description":"Items included in the request","items":{"$ref":"#/components/schemas/CreateRequestItem"},"type":"array"}},"additionalProperties":false,"type":"object","title":"UpdateTemplate"},"UpdateWebhook":{"properties":{"endpoint":{"description":"Destination URI to which the webhook subscription should send the POST request when an event occurs","type":"string","maxLength":2083,"minLength":1,"format":"uri"},"topics":{"description":"Event that triggers the webhook","items":{"$ref":"#/components/schemas/WebhookTopic"},"type":"array"}},"additionalProperties":false,"type":"object","title":"UpdateWebhook"},"UserNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"UserNotFound","examples":[{"code":"USER_NOT_FOUND","message":"User with specified ID not found.","type":"NOT_FOUND"}]},"UserPublic":{"properties":{"id":{"type":"string"},"org_id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"active":{"type":"boolean"},"role":{"$ref":"#/components/schemas/UserRole"},"team_ids":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["id","org_id","first_name","last_name","email","active","role","team_ids"],"title":"UserPublic"},"UserRole":{"type":"string","enum":["ADMIN","USER"],"title":"UserRole"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array"},"msg":{"type":"string"},"type":{"type":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WebhookNotFound":{"properties":{"type":{"type":"string","description":"Type of error"},"code":{"type":"string","description":"Unique error code"},"message":{"type":"string","description":"Descriptive error message"}},"type":"object","required":["type","code","message"],"title":"WebhookNotFound","examples":[{"code":"WEBHOOK_NOT_FOUND","message":"Webhook with specified ID not found.","type":"NOT_FOUND"}]},"WebhookPublic":{"properties":{"endpoint":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","description":"Destination URI to which the webhook subscription should send the POST request when an event occurs"},"topics":{"items":{"$ref":"#/components/schemas/WebhookTopic"},"type":"array","minItems":1,"description":"Event that triggers the webhook"},"id":{"type":"string"}},"type":"object","required":["endpoint","topics","id"],"title":"WebhookPublic"},"WebhookPublicWithSecret":{"properties":{"endpoint":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","description":"Destination URI to which the webhook subscription should send the POST request when an event occurs"},"topics":{"items":{"$ref":"#/components/schemas/WebhookTopic"},"type":"array","minItems":1,"description":"Event that triggers the webhook"},"id":{"type":"string"},"signing_secret":{"type":"string"}},"type":"object","required":["endpoint","topics","id","signing_secret"],"title":"WebhookPublicWithSecret"},"WebhookTopic":{"type":"string","enum":["request.created","request.updated","request.deleted","request.submitted","request.verified","request.rejected","request.closed","request.opened","request.reminder","item.verified"],"title":"WebhookTopic"}}}}