{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/payments:text-request/messages-post-mms-attachment":{"post":{"operationId":"payments_text_request_messages_post_mms_attachment","summary":"Post an MMS attachment to Text Request.","description":"POST /mms","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/messages-send-message-with-location-request-callback":{"post":{"operationId":"payments_text_request_messages_send_message_with_location_request_callback","summary":"Sends a message","description":"POST /messages","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/dashboard-list-all-dashboards":{"get":{"operationId":"payments_text_request_dashboard_list_all_dashboards","summary":"Get all dashboards in an account.","description":"GET /dashboards","tags":["payments"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/dashboard-create-new-dashboard":{"post":{"operationId":"payments_text_request_dashboard_create_new_dashboard","summary":"Create a new dashboard with the given name and phone number","description":"POST /dashboards","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/dashboard-get-info":{"get":{"operationId":"payments_text_request_dashboard_get_info","summary":"Get info on this specific dashboard","description":"GET /dashboards/{dashboard_id}","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/dashboard-update-name":{"post":{"operationId":"payments_text_request_dashboard_update_name","summary":"Update a specific dashboard's name","description":"PUT /dashboards/{dashboard_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/dashboard-delete-dashboard-by-id":{"post":{"operationId":"payments_text_request_dashboard_delete_dashboard_by_id","summary":"Deletes the specified dashboard.","description":"DELETE /dashboards/{dashboard_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/dashboard-get-provisioned-numbers":{"get":{"operationId":"payments_text_request_dashboard_get_provisioned_numbers","summary":"Get available provisioned numbers for hosting with a dashboard","description":"GET /dashboards/provisioning","tags":["payments"],"parameters":[{"name":"area_code","in":"query","required":true,"description":"Area code to search for provisioned numbers of","schema":{"type":"integer","description":"Area code to search for provisioned numbers of"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/conversations-get-all-dashboard-messages":{"get":{"operationId":"payments_text_request_conversations_get_all_dashboard_messages","summary":"Retrieves all conversations for this dashboard.","description":"GET /dashboards/{dashboard_id}/conversations","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"tags","in":"query","required":false,"description":"List or singular guid referencing the contact tags you want to filter by","schema":{"type":"string","description":"List or singular guid referencing the contact tags you want to filter by"}},{"name":"show_unresolved_only","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"search","in":"query","required":false,"description":"Search term for filtering conversations by phone number or display name. If the search term is less than a full name or phone number, the…","schema":{"type":"string","description":"Search term for filtering conversations by phone number or display name. If the search term is less than a full name or phone number, the…"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/conversations-get-conversation-messages-by-contact-phone":{"get":{"operationId":"payments_text_request_conversations_get_conversation_messages_by_contact_phone","summary":"Get a conversation's messages by contact phone.","description":"GET /dashboards/{dashboard_id}/contacts/{phone_number}/messages","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"phone_number","in":"query","required":true,"description":"Phone number","schema":{"type":"string","description":"Phone number"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/conversations-send-message-to-contact":{"post":{"operationId":"payments_text_request_conversations_send_message_to_contact","summary":"Send a message to the contact with the given phone number","description":"POST /dashboards/{dashboard_id}/contacts/{phone_number}/messages","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","phone_number"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"phone_number":{"type":"string","description":"Phone number"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/conversations-get-dashboard-messages":{"get":{"operationId":"payments_text_request_conversations_get_dashboard_messages","summary":"Get all messages for a dashboard.","description":"GET /dashboards/{dashboard_id}/messages","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"start_date","in":"query","required":false,"description":"Start date to filter messages in this dashboard by","schema":{"type":"string","description":"Start date to filter messages in this dashboard by"}},{"name":"end_date","in":"query","required":false,"description":"End date to filter messages in this dashboard by","schema":{"type":"string","description":"End date to filter messages in this dashboard by"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/conversations-archive-conversation":{"post":{"operationId":"payments_text_request_conversations_archive_conversation","summary":"Archive a Conversation","description":"PUT /dashboards/{dashboard_id}/contacts/{phone_number}/conversations/archive","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","phone_number"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"phone_number":{"type":"string","description":"Phone number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/conversations-unarchive-conversation":{"post":{"operationId":"payments_text_request_conversations_unarchive_conversation","summary":"Unarchive a Conversation","description":"PUT /dashboards/{dashboard_id}/contacts/{phone_number}/conversations/unarchive","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","phone_number"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"phone_number":{"type":"string","description":"Phone number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/messages-redact-message":{"post":{"operationId":"payments_text_request_messages_redact_message","summary":"Redact a message","description":"PUT /messages/{message_id}/redact","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["message_id"],"properties":{"message_id":{"type":"string","description":"Id of message to redact"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/messages-unredact-message":{"post":{"operationId":"payments_text_request_messages_unredact_message","summary":"Unredact a message","description":"PUT /messages/{message_id}/unredact","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["message_id"],"properties":{"message_id":{"type":"string","description":"Id of message to unredact"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/contacts-get-matches":{"get":{"operationId":"payments_text_request_contacts_get_matches","summary":"Retrieves all contacts that match the specified filtering criterion.","description":"GET /dashboards/{dashboard_id}/contacts","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"contact_phone_number","in":"query","required":false,"description":"The phone number that you're searching for. This uses \"starts with\" searching.","schema":{"type":"string","description":"The phone number that you're searching for. This uses \"starts with\" searching."}},{"name":"last_message_timestamp_before_utc","in":"query","required":false,"schema":{"type":"string"}},{"name":"last_message_timestamp_after_utc","in":"query","required":false,"schema":{"type":"string"}},{"name":"contact_created_before","in":"query","required":false,"schema":{"type":"string"}},{"name":"contact_created_after","in":"query","required":false,"schema":{"type":"string"}},{"name":"is_resolved","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"has_message_history","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"is_blocked","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"is_archived","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"is_suppressed","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"has_opted_out","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"last_message_sent_before","in":"query","required":false,"schema":{"type":"string"}},{"name":"last_message_sent_after","in":"query","required":false,"schema":{"type":"string"}},{"name":"last_message_received_before","in":"query","required":false,"schema":{"type":"string"}},{"name":"last_message_received_after","in":"query","required":false,"schema":{"type":"string"}},{"name":"tags","in":"query","required":false,"description":"List or singular guid referencing the contact tags you want to filter by","schema":{"type":"string","description":"List or singular guid referencing the contact tags you want to filter by"}},{"name":"groups","in":"query","required":false,"description":"List or singular ids referencing the groups you want to filter by","schema":{"type":"string","description":"List or singular ids referencing the groups you want to filter by"}},{"name":"custom_field_id_1","in":"query","required":false,"description":"Id of custom field to filter by. Requires value for custom_field_value_1 to specify the desired custom field value","schema":{"type":"string","description":"Id of custom field to filter by. Requires value for custom_field_value_1 to specify the desired custom field value"}},{"name":"custom_field_value_1","in":"query","required":false,"description":"Filter value of the custom field specied in custom_field_id_1. Requires value for custom_field_id_1 to specify which custom field to…","schema":{"type":"string","description":"Filter value of the custom field specied in custom_field_id_1. Requires value for custom_field_id_1 to specify which custom field to…"}},{"name":"custom_field_id_2","in":"query","required":false,"description":"Id of custom field to filter by. Requires value for custom_field_value_2 to specify the desired custom field value","schema":{"type":"string","description":"Id of custom field to filter by. Requires value for custom_field_value_2 to specify the desired custom field value"}},{"name":"custom_field_value_2","in":"query","required":false,"description":"Filter value of the custom field specied in custom_field_id_2. Requires value for custom_field_id_2 to specify which custom field to…","schema":{"type":"string","description":"Filter value of the custom field specied in custom_field_id_2. Requires value for custom_field_id_2 to specify which custom field to…"}},{"name":"custom_field_id_3","in":"query","required":false,"description":"Id of custom field to filter by. Requires value for custom_field_value_3 to specify the desired custom field value","schema":{"type":"string","description":"Id of custom field to filter by. Requires value for custom_field_value_3 to specify the desired custom field value"}},{"name":"custom_field_value_3","in":"query","required":false,"description":"Filter value of the custom field specied in custom_field_id_3. Requires value for custom_field_id_3 to specify which custom field to…","schema":{"type":"string","description":"Filter value of the custom field specied in custom_field_id_3. Requires value for custom_field_id_3 to specify which custom field to…"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/contacts-bulk-update":{"post":{"operationId":"payments_text_request_contacts_bulk_update","summary":"Bulk update contacts, updating contacts with matching phone numbers or creating new contacts for new phone…","description":"POST /dashboards/{dashboard_id}/contacts","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/contacts-get-by-phone-number":{"get":{"operationId":"payments_text_request_contacts_get_by_phone_number","summary":"Retrieves the contact with the specified phone number.","description":"GET /dashboards/{dashboard_id}/contacts/{phone_number}","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"phone_number","in":"query","required":true,"description":"Phone number","schema":{"type":"string","description":"Phone number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/contacts-create-or-update-by-phone-number":{"post":{"operationId":"payments_text_request_contacts_create_or_update_by_phone_number","summary":"Create or update a contact with the given phone number","description":"POST /dashboards/{dashboard_id}/contacts/{phone_number}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","phone_number"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"phone_number":{"type":"string","description":"Phone number"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/contacts-update-contact-details":{"post":{"operationId":"payments_text_request_contacts_update_contact_details","summary":"Add or remove a group, contact tag, or custom field to a contact with the given phone number","description":"PATCH /dashboards/{dashboard_id}/contacts/{phone_number}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","phone_number"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"phone_number":{"type":"string","description":"Phone number"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/contacts-delete-by-phone-number":{"post":{"operationId":"payments_text_request_contacts_delete_by_phone_number","summary":"Deletes the contact with the specified phone number.","description":"DELETE /dashboards/{dashboard_id}/contacts/{phone_number}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","phone_number"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"phone_number":{"type":"string","description":"Phone number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/groups-get-all":{"get":{"operationId":"payments_text_request_groups_get_all","summary":"Retrieves all groups.","description":"GET /dashboards/{dashboard_id}/groups","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/groups-create-new-group":{"post":{"operationId":"payments_text_request_groups_create_new_group","summary":"Creates a new group","description":"POST /dashboards/{dashboard_id}/groups","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/groups-get-by-id":{"get":{"operationId":"payments_text_request_groups_get_by_id","summary":"Retrieves the group with the specified id.","description":"GET /dashboards/{dashboard_id}/groups/{group_id}","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"group_id","in":"query","required":true,"description":"Id of group","schema":{"type":"integer","description":"Id of group"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/groups-update-group-name":{"post":{"operationId":"payments_text_request_groups_update_group_name","summary":"Update a group with the given id","description":"PUT /dashboards/{dashboard_id}/groups/{group_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","group_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"group_id":{"type":"integer","description":"Id of group"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/groups-delete-group-by-id":{"post":{"operationId":"payments_text_request_groups_delete_group_by_id","summary":"Deletes the group with the specified id.","description":"DELETE /dashboards/{dashboard_id}/groups/{group_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","group_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"group_id":{"type":"integer","description":"Id of group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/users-get-all-users":{"get":{"operationId":"payments_text_request_users_get_all_users","summary":"Retrieves all users.","description":"GET /users","tags":["payments"],"parameters":[{"name":"external_user_id","in":"query","required":false,"description":"External User Id to filter the results by. The External User Id is a custom value that can only be set from within the API. Multiple users…","schema":{"type":"string","description":"External User Id to filter the results by. The External User Id is a custom value that can only be set from within the API. Multiple users…"}},{"name":"email","in":"query","required":false,"description":"User's email address to filter the results by. A user's email address cannot be changed. Only one user can exist in an account for an…","schema":{"type":"string","description":"User's email address to filter the results by. A user's email address cannot be changed. Only one user can exist in an account for an…"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/users-create-user":{"post":{"operationId":"payments_text_request_users_create_user","summary":"Creates a new user","description":"POST /users","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/users-get-by-id":{"get":{"operationId":"payments_text_request_users_get_by_id","summary":"Retrieves the user with the specified id.","description":"GET /users/{user_id}","tags":["payments"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"Id of user","schema":{"type":"integer","description":"Id of user"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/users-update-user-details":{"post":{"operationId":"payments_text_request_users_update_user_details","summary":"Update a user with the given id","description":"PUT /users/{user_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"integer","description":"Id of user"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/users-delete-user-with-permissions":{"post":{"operationId":"payments_text_request_users_delete_user_with_permissions","summary":"Deletes the user with the specified id","description":"DELETE /users/{user_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"integer","description":"Id of user"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/keywords-get-all":{"get":{"operationId":"payments_text_request_keywords_get_all","summary":"Retrieves all keywords.","description":"GET /dashboards/{dashboard_id}/keywords","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/keywords-create-new-keyword":{"post":{"operationId":"payments_text_request_keywords_create_new_keyword","summary":"Creates a new keyword","description":"POST /dashboards/{dashboard_id}/keywords","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/keywords-get-by-id":{"get":{"operationId":"payments_text_request_keywords_get_by_id","summary":"Retrieves the keyword with the specified id.","description":"GET /dashboards/{dashboard_id}/keywords/{keyword_id}","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"keyword_id","in":"query","required":true,"description":"Id of keyword","schema":{"type":"integer","description":"Id of keyword"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/keywords-update-keyword-by-id":{"post":{"operationId":"payments_text_request_keywords_update_keyword_by_id","summary":"Update the keyword with the given id","description":"PUT /dashboards/{dashboard_id}/keywords/{keyword_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","keyword_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"keyword_id":{"type":"integer","description":"Id of keyword"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/keywords-delete-keyword-by-id":{"post":{"operationId":"payments_text_request_keywords_delete_keyword_by_id","summary":"Deletes the keywood with the specified id.","description":"DELETE /dashboards/{dashboard_id}/keywords/{keyword_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","keyword_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"keyword_id":{"type":"integer","description":"Id of keyword"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/tags-get-all-dashboard-tags":{"get":{"operationId":"payments_text_request_tags_get_all_dashboard_tags","summary":"Retrieves all the tags for this dashboard.","description":"GET /dashboards/{dashboard_id}/tags","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/tags-create-new-tag":{"post":{"operationId":"payments_text_request_tags_create_new_tag","summary":"Creates a new tag","description":"POST /dashboards/{dashboard_id}/tags","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/tags-get-tag-by-id":{"get":{"operationId":"payments_text_request_tags_get_tag_by_id","summary":"Retrieves the tag with the specified id.","description":"GET /dashboards/{dashboard_id}/tags/{tag_id}","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"tag_id","in":"query","required":true,"description":"Id of tag","schema":{"type":"string","description":"Id of tag"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/tags-update-tag-by-id":{"post":{"operationId":"payments_text_request_tags_update_tag_by_id","summary":"Update a tag with the given id","description":"PUT /dashboards/{dashboard_id}/tags/{tag_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","tag_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"tag_id":{"type":"string","description":"Id of tag"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/tags-delete-tag-by-id":{"post":{"operationId":"payments_text_request_tags_delete_tag_by_id","summary":"Deletes the tag with the specified id.","description":"DELETE /dashboards/{dashboard_id}/tags/{tag_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","tag_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"tag_id":{"type":"string","description":"Id of tag"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/custom-fields-get-field-by-id":{"get":{"operationId":"payments_text_request_custom_fields_get_field_by_id","summary":"Retrieves the custom field with the specified id.","description":"GET /dashboards/{dashboard_id}/fields/{field_id}","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"field_id","in":"query","required":true,"description":"Id of field","schema":{"type":"string","description":"Id of field"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/custom-fields-update-field-name":{"post":{"operationId":"payments_text_request_custom_fields_update_field_name","summary":"Update a custom field's name","description":"PUT /dashboards/{dashboard_id}/fields/{field_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","field_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"field_id":{"type":"string","description":"Id of field"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/custom-fields-delete-field-by-id":{"post":{"operationId":"payments_text_request_custom_fields_delete_field_by_id","summary":"Deletes the field with the specified id.","description":"DELETE /dashboards/{dashboard_id}/fields/{field_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","field_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"field_id":{"type":"string","description":"Id of field"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/custom-fields-get-all-fields":{"get":{"operationId":"payments_text_request_custom_fields_get_all_fields","summary":"Retrieves all custom fields.","description":"GET /dashboards/{dashboard_id}/fields","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/custom-fields-create-new-field":{"post":{"operationId":"payments_text_request_custom_fields_create_new_field","summary":"Create a new custom field.","description":"POST /dashboards/{dashboard_id}/fields","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/payments-get-all":{"get":{"operationId":"payments_text_request_payments_get_all","summary":"Retrieves all payments.","description":"GET /dashboards/{dashboard_id}/payments","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"reference_number","in":"query","required":false,"description":"User-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many…","schema":{"type":"string","description":"User-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many…"}},{"name":"phone_number","in":"query","required":false,"description":"Phone number","schema":{"type":"string","description":"Phone number"}},{"name":"sort_type","in":"query","required":false,"description":"Property to sort payments by.","schema":{"type":"string","enum":["amount","contact","date","status"],"default":"date","description":"Property to sort payments by."}},{"name":"sort_direction","in":"query","required":false,"description":"Direction to sort payments in. Either greatest to smallest, or smallest to greatest.","schema":{"type":"string","enum":["desc","asc"],"default":"desc","description":"Direction to sort payments in. Either greatest to smallest, or smallest to greatest."}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/payments-create-new-payment":{"post":{"operationId":"payments_text_request_payments_create_new_payment","summary":"Creates a new payment","description":"POST /dashboards/{dashboard_id}/payments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/payments-get-payment-by-id":{"get":{"operationId":"payments_text_request_payments_get_payment_by_id","summary":"Retrieves the payment with the specified id.","description":"GET /dashboards/{dashboard_id}/payments/{payment_id}","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"payment_id","in":"query","required":true,"description":"Id of payment","schema":{"type":"integer","description":"Id of payment"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/payments-mark-as-paid":{"post":{"operationId":"payments_text_request_payments_mark_as_paid","summary":"Mark a payment as paid","description":"POST /dashboards/{dashboard_id}/payments/{payment_id}/mark_as_paid","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","payment_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"payment_id":{"type":"integer","description":"Id of payment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/payments-send-reminder":{"post":{"operationId":"payments_text_request_payments_send_reminder","summary":"Send a follow-up text reminding the user to pay the specified payment.","description":"POST /dashboards/{dashboard_id}/payments/{payment_id}/resend","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","payment_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"payment_id":{"type":"integer","description":"Id of payment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/payments-cancel-payment":{"post":{"operationId":"payments_text_request_payments_cancel_payment","summary":"Cancels the specified payment.","description":"POST /dashboards/{dashboard_id}/payments/{payment_id}/cancel","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","payment_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"payment_id":{"type":"integer","description":"Id of payment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/payments-activate-dashboard-payments":{"post":{"operationId":"payments_text_request_payments_activate_dashboard_payments","summary":"Activates payments for a dashboard.","description":"POST /dashboards/{dashboard_id}/activate_payments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/reviews-get-matching-reviews":{"get":{"operationId":"payments_text_request_reviews_get_matching_reviews","summary":"Retrieves all reviews that match the specified filtering criterion.","description":"GET /dashboards/{dashboard_id}/reviews","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"start_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/reviews-get-all-campaigns":{"get":{"operationId":"payments_text_request_reviews_get_all_campaigns","summary":"Retrieves all campaigns.","description":"GET /dashboards/{dashboard_id}/campaigns","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/reviews-get-campaign-by-id":{"get":{"operationId":"payments_text_request_reviews_get_campaign_by_id","summary":"Retrieves the campaign with the specified id.","description":"GET /dashboards/{dashboard_id}/campaigns/{campaign_id}","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"campaign_id","in":"query","required":true,"description":"Id of campaign","schema":{"type":"integer","description":"Id of campaign"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/webhooks-get-all-types":{"get":{"operationId":"payments_text_request_webhooks_get_all_types","summary":"Retrieve all available web hooks types","description":"GET /eventTypes","tags":["payments"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/webhooks-get-all-for-dashboard":{"get":{"operationId":"payments_text_request_webhooks_get_all_for_dashboard","summary":"Retrieve all web hooks for a dashboard","description":"GET /dashboards/{dashboard_id}/hooks","tags":["payments"],"parameters":[{"name":"dashboard_id","in":"query","required":true,"description":"Id of dashboard","schema":{"type":"integer","description":"Id of dashboard"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:text-request/webhooks-register-new-webhook":{"post":{"operationId":"payments_text_request_webhooks_register_new_webhook","summary":"Register Web Hook","description":"POST /dashboards/{dashboard_id}/hooks","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:text-request/webhooks-delete-webhook-from-phone-number":{"post":{"operationId":"payments_text_request_webhooks_delete_webhook_from_phone_number","summary":"Deletes a web hook","description":"DELETE /dashboards/{dashboard_id}/hooks/{webhook_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dashboard_id","webhook_id"],"properties":{"dashboard_id":{"type":"integer","description":"Id of dashboard"},"webhook_id":{"type":"integer","description":"Id of the web hook that you want to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}