diff --git a/examples/json/EventCallbackFaxBlacklisted.json b/examples/json/EventCallbackFaxBlacklisted.json new file mode 100644 index 000000000..dbfadce16 --- /dev/null +++ b/examples/json/EventCallbackFaxBlacklisted.json @@ -0,0 +1,33 @@ +{ + "event": { + "event_time": "1738001529", + "event_type": "fax_blacklisted", + "event_hash": "950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81", + "event_metadata": { + "related_signature_id": null, + "reported_for_account_id": "63522885f9261e2b04eea043933ee7313eb674fd", + "reported_for_app_id": null + } + }, + "transmission": { + "test_mode": false, + "signature_request_id": "", + "title": "Example Fax", + "original_title": "Example Fax", + "subject": null, + "message": "Please read", + "metadata": {}, + "created_at": 1738001529, + "is_complete": false, + "is_declined": false, + "has_error": true, + "files_url": "https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "cc_email_addresses": [], + "final_copy_uri": "/v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "template_ids": [], + "custom_fields": [], + "attachments": [], + "response_data": [], + "signatures": [] + } +} diff --git a/examples/json/EventCallbackFaxBusy.json b/examples/json/EventCallbackFaxBusy.json new file mode 100644 index 000000000..c2a7d50d9 --- /dev/null +++ b/examples/json/EventCallbackFaxBusy.json @@ -0,0 +1,33 @@ +{ + "event": { + "event_time": "1738001529", + "event_type": "fax_busy", + "event_hash": "950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81", + "event_metadata": { + "related_signature_id": null, + "reported_for_account_id": "63522885f9261e2b04eea043933ee7313eb674fd", + "reported_for_app_id": null + } + }, + "transmission": { + "test_mode": false, + "signature_request_id": "", + "title": "Example Fax", + "original_title": "Example Fax", + "subject": null, + "message": "Please read", + "metadata": {}, + "created_at": 1738001529, + "is_complete": false, + "is_declined": false, + "has_error": true, + "files_url": "https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "cc_email_addresses": [], + "final_copy_uri": "/v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "template_ids": [], + "custom_fields": [], + "attachments": [], + "response_data": [], + "signatures": [] + } +} diff --git a/examples/json/EventCallbackFaxDisconnected.json b/examples/json/EventCallbackFaxDisconnected.json new file mode 100644 index 000000000..41a27bb31 --- /dev/null +++ b/examples/json/EventCallbackFaxDisconnected.json @@ -0,0 +1,33 @@ +{ + "event": { + "event_time": "1738001529", + "event_type": "fax_disconnected", + "event_hash": "950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81", + "event_metadata": { + "related_signature_id": null, + "reported_for_account_id": "63522885f9261e2b04eea043933ee7313eb674fd", + "reported_for_app_id": null + } + }, + "transmission": { + "test_mode": false, + "signature_request_id": "", + "title": "Example Fax", + "original_title": "Example Fax", + "subject": null, + "message": "Please read", + "metadata": {}, + "created_at": 1738001529, + "is_complete": false, + "is_declined": false, + "has_error": true, + "files_url": "https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "cc_email_addresses": [], + "final_copy_uri": "/v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "template_ids": [], + "custom_fields": [], + "attachments": [], + "response_data": [], + "signatures": [] + } +} diff --git a/examples/json/EventCallbackFaxNoAnswer.json b/examples/json/EventCallbackFaxNoAnswer.json new file mode 100644 index 000000000..897667d76 --- /dev/null +++ b/examples/json/EventCallbackFaxNoAnswer.json @@ -0,0 +1,33 @@ +{ + "event": { + "event_time": "1738001529", + "event_type": "fax_no_answer", + "event_hash": "950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81", + "event_metadata": { + "related_signature_id": null, + "reported_for_account_id": "63522885f9261e2b04eea043933ee7313eb674fd", + "reported_for_app_id": null + } + }, + "transmission": { + "test_mode": false, + "signature_request_id": "", + "title": "Example Fax", + "original_title": "Example Fax", + "subject": null, + "message": "Please read", + "metadata": {}, + "created_at": 1738001529, + "is_complete": false, + "is_declined": false, + "has_error": true, + "files_url": "https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "cc_email_addresses": [], + "final_copy_uri": "/v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "template_ids": [], + "custom_fields": [], + "attachments": [], + "response_data": [], + "signatures": [] + } +} diff --git a/examples/json/EventCallbackFaxOnHold.json b/examples/json/EventCallbackFaxOnHold.json new file mode 100644 index 000000000..4be759758 --- /dev/null +++ b/examples/json/EventCallbackFaxOnHold.json @@ -0,0 +1,33 @@ +{ + "event": { + "event_time": "1738001529", + "event_type": "fax_on_hold", + "event_hash": "950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81", + "event_metadata": { + "related_signature_id": null, + "reported_for_account_id": "63522885f9261e2b04eea043933ee7313eb674fd", + "reported_for_app_id": null + } + }, + "transmission": { + "test_mode": false, + "signature_request_id": "", + "title": "Example Fax", + "original_title": "Example Fax", + "subject": null, + "message": "Please read", + "metadata": {}, + "created_at": 1738001529, + "is_complete": false, + "is_declined": false, + "has_error": false, + "files_url": "https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "cc_email_addresses": [], + "final_copy_uri": "/v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "template_ids": [], + "custom_fields": [], + "attachments": [], + "response_data": [], + "signatures": [] + } +} diff --git a/examples/json/EventCallbackFaxReceived.json b/examples/json/EventCallbackFaxReceived.json new file mode 100644 index 000000000..31eed6d48 --- /dev/null +++ b/examples/json/EventCallbackFaxReceived.json @@ -0,0 +1,33 @@ +{ + "event": { + "event_time": "1738001529", + "event_type": "fax_received", + "event_hash": "950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81", + "event_metadata": { + "related_signature_id": null, + "reported_for_account_id": "63522885f9261e2b04eea043933ee7313eb674fd", + "reported_for_app_id": null + } + }, + "transmission": { + "test_mode": false, + "signature_request_id": "", + "title": "Example Fax", + "original_title": "Example Fax", + "subject": null, + "message": "Please read", + "metadata": {}, + "created_at": 1738001529, + "is_complete": false, + "is_declined": false, + "has_error": false, + "files_url": "https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "cc_email_addresses": [], + "final_copy_uri": "/v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "template_ids": [], + "custom_fields": [], + "attachments": [], + "response_data": [], + "signatures": [] + } +} diff --git a/examples/json/EventCallbackFaxSent.json b/examples/json/EventCallbackFaxSent.json new file mode 100644 index 000000000..d05a5a556 --- /dev/null +++ b/examples/json/EventCallbackFaxSent.json @@ -0,0 +1,33 @@ +{ + "event": { + "event_time": "1738001529", + "event_type": "fax_sent", + "event_hash": "950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81", + "event_metadata": { + "related_signature_id": null, + "reported_for_account_id": "63522885f9261e2b04eea043933ee7313eb674fd", + "reported_for_app_id": null + } + }, + "transmission": { + "test_mode": false, + "signature_request_id": "", + "title": "Example Fax", + "original_title": "Example Fax", + "subject": null, + "message": "Please read", + "metadata": {}, + "created_at": 1738001529, + "is_complete": false, + "is_declined": false, + "has_error": false, + "files_url": "https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "cc_email_addresses": [], + "final_copy_uri": "/v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407", + "template_ids": [], + "custom_fields": [], + "attachments": [], + "response_data": [], + "signatures": [] + } +} diff --git a/openapi-fern.yaml b/openapi-fern.yaml index 7ca8f36cc..7c774f64e 100644 --- a/openapi-fern.yaml +++ b/openapi-fern.yaml @@ -29062,6 +29062,13 @@ components: - template_error - callback_test - signature_request_signer_removed + - fax_received + - fax_sent + - fax_on_hold + - fax_busy + - fax_no_answer + - fax_disconnected + - fax_blacklisted event_hash: description: Generated hash used to verify source of event data. type: string @@ -29550,6 +29557,146 @@ components: type: object x-fern-audiences: - events + EventCallbackFaxReceived: + title: Fax Received Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - fax_received + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxSent: + title: Fax Sent Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - fax_sent + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxOnHold: + title: Fax On Hold Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - fax_on_hold + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxBusy: + title: Fax Busy Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - fax_busy + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxNoAnswer: + title: Fax No Answer Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - fax_no_answer + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxDisconnected: + title: Fax Disconnected Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - fax_disconnected + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxBlacklisted: + title: Fax Blacklisted Event + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - properties: + event_type: + type: string + enum: + - fax_blacklisted + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events EventCallbackPayload: title: Event Callback Payload description: JSON payload delivered for a webhook event. The concrete shape is selected by `event.event_type`. @@ -29600,6 +29747,20 @@ components: $ref: '#/components/schemas/EventCallbackSignUrlInvalid' - $ref: '#/components/schemas/EventCallbackCallbackTest' + - + $ref: '#/components/schemas/EventCallbackFaxReceived' + - + $ref: '#/components/schemas/EventCallbackFaxSent' + - + $ref: '#/components/schemas/EventCallbackFaxOnHold' + - + $ref: '#/components/schemas/EventCallbackFaxBusy' + - + $ref: '#/components/schemas/EventCallbackFaxNoAnswer' + - + $ref: '#/components/schemas/EventCallbackFaxDisconnected' + - + $ref: '#/components/schemas/EventCallbackFaxBlacklisted' x-fern-audiences: - events responses: @@ -34248,6 +34409,237 @@ components: reported_for_app_id: null x-fern-audiences: - events + EventCallbackFaxReceived: + summary: Fax Received Event Example + value: + event: + event_time: '1738001529' + event_type: fax_received + event_hash: 950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + transmission: + test_mode: false + signature_request_id: '' + title: Example Fax + original_title: Example Fax + subject: null + message: Please read + metadata: {} + created_at: 1738001529 + is_complete: false + is_declined: false + has_error: false + files_url: https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + cc_email_addresses: [] + final_copy_uri: /v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + template_ids: [] + custom_fields: [] + attachments: [] + response_data: [] + signatures: [] + x-fern-audiences: + - events + EventCallbackFaxSent: + summary: Fax Sent Event Example + value: + event: + event_time: '1738001529' + event_type: fax_sent + event_hash: 950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + transmission: + test_mode: false + signature_request_id: '' + title: Example Fax + original_title: Example Fax + subject: null + message: Please read + metadata: {} + created_at: 1738001529 + is_complete: false + is_declined: false + has_error: false + files_url: https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + cc_email_addresses: [] + final_copy_uri: /v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + template_ids: [] + custom_fields: [] + attachments: [] + response_data: [] + signatures: [] + x-fern-audiences: + - events + EventCallbackFaxOnHold: + summary: Fax On Hold Event Example + value: + event: + event_time: '1738001529' + event_type: fax_on_hold + event_hash: 950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + transmission: + test_mode: false + signature_request_id: '' + title: Example Fax + original_title: Example Fax + subject: null + message: Please read + metadata: {} + created_at: 1738001529 + is_complete: false + is_declined: false + has_error: false + files_url: https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + cc_email_addresses: [] + final_copy_uri: /v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + template_ids: [] + custom_fields: [] + attachments: [] + response_data: [] + signatures: [] + x-fern-audiences: + - events + EventCallbackFaxBusy: + summary: Fax Busy Event Example + value: + event: + event_time: '1738001529' + event_type: fax_busy + event_hash: 950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + transmission: + test_mode: false + signature_request_id: '' + title: Example Fax + original_title: Example Fax + subject: null + message: Please read + metadata: {} + created_at: 1738001529 + is_complete: false + is_declined: false + has_error: true + files_url: https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + cc_email_addresses: [] + final_copy_uri: /v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + template_ids: [] + custom_fields: [] + attachments: [] + response_data: [] + signatures: [] + x-fern-audiences: + - events + EventCallbackFaxNoAnswer: + summary: Fax No Answer Event Example + value: + event: + event_time: '1738001529' + event_type: fax_no_answer + event_hash: 950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + transmission: + test_mode: false + signature_request_id: '' + title: Example Fax + original_title: Example Fax + subject: null + message: Please read + metadata: {} + created_at: 1738001529 + is_complete: false + is_declined: false + has_error: true + files_url: https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + cc_email_addresses: [] + final_copy_uri: /v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + template_ids: [] + custom_fields: [] + attachments: [] + response_data: [] + signatures: [] + x-fern-audiences: + - events + EventCallbackFaxDisconnected: + summary: Fax Disconnected Event Example + value: + event: + event_time: '1738001529' + event_type: fax_disconnected + event_hash: 950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + transmission: + test_mode: false + signature_request_id: '' + title: Example Fax + original_title: Example Fax + subject: null + message: Please read + metadata: {} + created_at: 1738001529 + is_complete: false + is_declined: false + has_error: true + files_url: https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + cc_email_addresses: [] + final_copy_uri: /v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + template_ids: [] + custom_fields: [] + attachments: [] + response_data: [] + signatures: [] + x-fern-audiences: + - events + EventCallbackFaxBlacklisted: + summary: Fax Blacklisted Event Example + value: + event: + event_time: '1738001529' + event_type: fax_blacklisted + event_hash: 950d3bdf03a30d520dfa6ac51a952ff93fe3a4d9754dd1412b6aec36206c1e81 + event_metadata: + related_signature_id: null + reported_for_account_id: 63522885f9261e2b04eea043933ee7313eb674fd + reported_for_app_id: null + transmission: + test_mode: false + signature_request_id: '' + title: Example Fax + original_title: Example Fax + subject: null + message: Please read + metadata: {} + created_at: 1738001529 + is_complete: false + is_declined: false + has_error: true + files_url: https://api.hellosign.com/v3/fax/files/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + cc_email_addresses: [] + final_copy_uri: /v3/transmission/final_copy/9c2c7e8c2ed1839f75a9a0227ce2954b1d7c3407 + template_ids: [] + custom_fields: [] + attachments: [] + response_data: [] + signatures: [] + x-fern-audiences: + - events requestBodies: EventCallbackAccountRequest: description: |- @@ -34386,6 +34778,20 @@ webhooks: $ref: '#/components/examples/EventCallbackSignUrlInvalid' callback_test_example: $ref: '#/components/examples/EventCallbackCallbackTest' + fax_received_example: + $ref: '#/components/examples/EventCallbackFaxReceived' + fax_sent_example: + $ref: '#/components/examples/EventCallbackFaxSent' + fax_on_hold_example: + $ref: '#/components/examples/EventCallbackFaxOnHold' + fax_busy_example: + $ref: '#/components/examples/EventCallbackFaxBusy' + fax_no_answer_example: + $ref: '#/components/examples/EventCallbackFaxNoAnswer' + fax_disconnected_example: + $ref: '#/components/examples/EventCallbackFaxDisconnected' + fax_blacklisted_example: + $ref: '#/components/examples/EventCallbackFaxBlacklisted' responses: '200': $ref: '#/components/responses/EventCallbackResponse' @@ -34464,6 +34870,20 @@ webhooks: $ref: '#/components/examples/EventCallbackSignUrlInvalid' callback_test_example: $ref: '#/components/examples/EventCallbackCallbackTest' + fax_received_example: + $ref: '#/components/examples/EventCallbackFaxReceived' + fax_sent_example: + $ref: '#/components/examples/EventCallbackFaxSent' + fax_on_hold_example: + $ref: '#/components/examples/EventCallbackFaxOnHold' + fax_busy_example: + $ref: '#/components/examples/EventCallbackFaxBusy' + fax_no_answer_example: + $ref: '#/components/examples/EventCallbackFaxNoAnswer' + fax_disconnected_example: + $ref: '#/components/examples/EventCallbackFaxDisconnected' + fax_blacklisted_example: + $ref: '#/components/examples/EventCallbackFaxBlacklisted' responses: '200': $ref: '#/components/responses/EventCallbackResponse' diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 2b401a8c8..3b1aff36e 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -13246,6 +13246,13 @@ components: - template_error - callback_test - signature_request_signer_removed + - fax_received + - fax_sent + - fax_on_hold + - fax_busy + - fax_no_answer + - fax_disconnected + - fax_blacklisted event_hash: description: '_t__EventCallbackRequestEvent::EVENT_HASH' type: string @@ -13757,6 +13764,153 @@ components: x-fern-audiences: - events x-hideOn: sdk + EventCallbackFaxReceived: + title: '_t__EventCallbackFaxReceived::EVENT_TITLE' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_received] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + x-hideOn: sdk + EventCallbackFaxSent: + title: '_t__EventCallbackFaxSent::EVENT_TITLE' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_sent] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + x-hideOn: sdk + EventCallbackFaxOnHold: + title: '_t__EventCallbackFaxOnHold::EVENT_TITLE' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_on_hold] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + x-hideOn: sdk + EventCallbackFaxBusy: + title: '_t__EventCallbackFaxBusy::EVENT_TITLE' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_busy] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + x-hideOn: sdk + EventCallbackFaxNoAnswer: + title: '_t__EventCallbackFaxNoAnswer::EVENT_TITLE' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_no_answer] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + x-hideOn: sdk + EventCallbackFaxDisconnected: + title: '_t__EventCallbackFaxDisconnected::EVENT_TITLE' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_disconnected] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + x-hideOn: sdk + EventCallbackFaxBlacklisted: + title: '_t__EventCallbackFaxBlacklisted::EVENT_TITLE' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_blacklisted] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + x-hideOn: sdk EventCallbackPayload: title: 'Event Callback Payload' description: 'JSON payload delivered for a webhook event. The concrete shape is selected by `event.event_type`.' @@ -13807,6 +13961,20 @@ components: $ref: '#/components/schemas/EventCallbackSignUrlInvalid' - $ref: '#/components/schemas/EventCallbackCallbackTest' + - + $ref: '#/components/schemas/EventCallbackFaxReceived' + - + $ref: '#/components/schemas/EventCallbackFaxSent' + - + $ref: '#/components/schemas/EventCallbackFaxOnHold' + - + $ref: '#/components/schemas/EventCallbackFaxBusy' + - + $ref: '#/components/schemas/EventCallbackFaxNoAnswer' + - + $ref: '#/components/schemas/EventCallbackFaxDisconnected' + - + $ref: '#/components/schemas/EventCallbackFaxBlacklisted' x-fern-audiences: - events x-hideOn: sdk @@ -14492,6 +14660,48 @@ components: $ref: examples/json/EventCallbackCallbackTest.json x-fern-audiences: - events + EventCallbackFaxReceived: + summary: '_t__EventCallbackFaxReceived::EVENT_EXAMPLE_SUMMARY' + value: + $ref: examples/json/EventCallbackFaxReceived.json + x-fern-audiences: + - events + EventCallbackFaxSent: + summary: '_t__EventCallbackFaxSent::EVENT_EXAMPLE_SUMMARY' + value: + $ref: examples/json/EventCallbackFaxSent.json + x-fern-audiences: + - events + EventCallbackFaxOnHold: + summary: '_t__EventCallbackFaxOnHold::EVENT_EXAMPLE_SUMMARY' + value: + $ref: examples/json/EventCallbackFaxOnHold.json + x-fern-audiences: + - events + EventCallbackFaxBusy: + summary: '_t__EventCallbackFaxBusy::EVENT_EXAMPLE_SUMMARY' + value: + $ref: examples/json/EventCallbackFaxBusy.json + x-fern-audiences: + - events + EventCallbackFaxNoAnswer: + summary: '_t__EventCallbackFaxNoAnswer::EVENT_EXAMPLE_SUMMARY' + value: + $ref: examples/json/EventCallbackFaxNoAnswer.json + x-fern-audiences: + - events + EventCallbackFaxDisconnected: + summary: '_t__EventCallbackFaxDisconnected::EVENT_EXAMPLE_SUMMARY' + value: + $ref: examples/json/EventCallbackFaxDisconnected.json + x-fern-audiences: + - events + EventCallbackFaxBlacklisted: + summary: '_t__EventCallbackFaxBlacklisted::EVENT_EXAMPLE_SUMMARY' + value: + $ref: examples/json/EventCallbackFaxBlacklisted.json + x-fern-audiences: + - events requestBodies: EventCallbackAccountRequest: description: '_t__EventCallbackAccountRequest::DESCRIPTION' @@ -14666,6 +14876,20 @@ x-webhooks: $ref: '#/components/examples/EventCallbackSignUrlInvalid' callback_test_example: $ref: '#/components/examples/EventCallbackCallbackTest' + fax_received_example: + $ref: '#/components/examples/EventCallbackFaxReceived' + fax_sent_example: + $ref: '#/components/examples/EventCallbackFaxSent' + fax_on_hold_example: + $ref: '#/components/examples/EventCallbackFaxOnHold' + fax_busy_example: + $ref: '#/components/examples/EventCallbackFaxBusy' + fax_no_answer_example: + $ref: '#/components/examples/EventCallbackFaxNoAnswer' + fax_disconnected_example: + $ref: '#/components/examples/EventCallbackFaxDisconnected' + fax_blacklisted_example: + $ref: '#/components/examples/EventCallbackFaxBlacklisted' responses: '200': $ref: '#/components/responses/EventCallbackResponse' @@ -14736,6 +14960,20 @@ x-webhooks: $ref: '#/components/examples/EventCallbackSignUrlInvalid' callback_test_example: $ref: '#/components/examples/EventCallbackCallbackTest' + fax_received_example: + $ref: '#/components/examples/EventCallbackFaxReceived' + fax_sent_example: + $ref: '#/components/examples/EventCallbackFaxSent' + fax_on_hold_example: + $ref: '#/components/examples/EventCallbackFaxOnHold' + fax_busy_example: + $ref: '#/components/examples/EventCallbackFaxBusy' + fax_no_answer_example: + $ref: '#/components/examples/EventCallbackFaxNoAnswer' + fax_disconnected_example: + $ref: '#/components/examples/EventCallbackFaxDisconnected' + fax_blacklisted_example: + $ref: '#/components/examples/EventCallbackFaxBlacklisted' responses: '200': $ref: '#/components/responses/EventCallbackResponse' diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 72b323aeb..676758000 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -13818,6 +13818,13 @@ components: - template_error - callback_test - signature_request_signer_removed + - fax_received + - fax_sent + - fax_on_hold + - fax_busy + - fax_no_answer + - fax_disconnected + - fax_blacklisted event_hash: description: 'Generated hash used to verify source of event data.' type: string @@ -14523,6 +14530,48 @@ components: $ref: examples/json/EventCallbackCallbackTest.json x-fern-audiences: - events + EventCallbackFaxReceived: + summary: 'Fax Received Event Example' + value: + $ref: examples/json/EventCallbackFaxReceived.json + x-fern-audiences: + - events + EventCallbackFaxSent: + summary: 'Fax Sent Event Example' + value: + $ref: examples/json/EventCallbackFaxSent.json + x-fern-audiences: + - events + EventCallbackFaxOnHold: + summary: 'Fax On Hold Event Example' + value: + $ref: examples/json/EventCallbackFaxOnHold.json + x-fern-audiences: + - events + EventCallbackFaxBusy: + summary: 'Fax Busy Event Example' + value: + $ref: examples/json/EventCallbackFaxBusy.json + x-fern-audiences: + - events + EventCallbackFaxNoAnswer: + summary: 'Fax No Answer Event Example' + value: + $ref: examples/json/EventCallbackFaxNoAnswer.json + x-fern-audiences: + - events + EventCallbackFaxDisconnected: + summary: 'Fax Disconnected Event Example' + value: + $ref: examples/json/EventCallbackFaxDisconnected.json + x-fern-audiences: + - events + EventCallbackFaxBlacklisted: + summary: 'Fax Blacklisted Event Example' + value: + $ref: examples/json/EventCallbackFaxBlacklisted.json + x-fern-audiences: + - events requestBodies: EventCallbackAccountRequest: description: |- diff --git a/openapi.yaml b/openapi.yaml index b9ac61877..c7c5a9a96 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -13804,6 +13804,13 @@ components: - template_error - callback_test - signature_request_signer_removed + - fax_received + - fax_sent + - fax_on_hold + - fax_busy + - fax_no_answer + - fax_disconnected + - fax_blacklisted event_hash: description: 'Generated hash used to verify source of event data.' type: string @@ -14292,6 +14299,146 @@ components: type: object x-fern-audiences: - events + EventCallbackFaxReceived: + title: 'Fax Received Event' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_received] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxSent: + title: 'Fax Sent Event' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_sent] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxOnHold: + title: 'Fax On Hold Event' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_on_hold] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxBusy: + title: 'Fax Busy Event' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_busy] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxNoAnswer: + title: 'Fax No Answer Event' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_no_answer] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxDisconnected: + title: 'Fax Disconnected Event' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_disconnected] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events + EventCallbackFaxBlacklisted: + title: 'Fax Blacklisted Event' + required: + - event + properties: + event: + allOf: + - + $ref: '#/components/schemas/EventCallbackRequestEvent' + - + properties: + event_type: + type: string + enum: [fax_blacklisted] + type: object + transmission: + $ref: '#/components/schemas/SignatureRequestResponse' + type: object + x-fern-audiences: + - events EventCallbackPayload: title: 'Event Callback Payload' description: 'JSON payload delivered for a webhook event. The concrete shape is selected by `event.event_type`.' @@ -14342,6 +14489,20 @@ components: $ref: '#/components/schemas/EventCallbackSignUrlInvalid' - $ref: '#/components/schemas/EventCallbackCallbackTest' + - + $ref: '#/components/schemas/EventCallbackFaxReceived' + - + $ref: '#/components/schemas/EventCallbackFaxSent' + - + $ref: '#/components/schemas/EventCallbackFaxOnHold' + - + $ref: '#/components/schemas/EventCallbackFaxBusy' + - + $ref: '#/components/schemas/EventCallbackFaxNoAnswer' + - + $ref: '#/components/schemas/EventCallbackFaxDisconnected' + - + $ref: '#/components/schemas/EventCallbackFaxBlacklisted' x-fern-audiences: - events responses: @@ -15019,6 +15180,48 @@ components: $ref: examples/json/EventCallbackCallbackTest.json x-fern-audiences: - events + EventCallbackFaxReceived: + summary: 'Fax Received Event Example' + value: + $ref: examples/json/EventCallbackFaxReceived.json + x-fern-audiences: + - events + EventCallbackFaxSent: + summary: 'Fax Sent Event Example' + value: + $ref: examples/json/EventCallbackFaxSent.json + x-fern-audiences: + - events + EventCallbackFaxOnHold: + summary: 'Fax On Hold Event Example' + value: + $ref: examples/json/EventCallbackFaxOnHold.json + x-fern-audiences: + - events + EventCallbackFaxBusy: + summary: 'Fax Busy Event Example' + value: + $ref: examples/json/EventCallbackFaxBusy.json + x-fern-audiences: + - events + EventCallbackFaxNoAnswer: + summary: 'Fax No Answer Event Example' + value: + $ref: examples/json/EventCallbackFaxNoAnswer.json + x-fern-audiences: + - events + EventCallbackFaxDisconnected: + summary: 'Fax Disconnected Event Example' + value: + $ref: examples/json/EventCallbackFaxDisconnected.json + x-fern-audiences: + - events + EventCallbackFaxBlacklisted: + summary: 'Fax Blacklisted Event Example' + value: + $ref: examples/json/EventCallbackFaxBlacklisted.json + x-fern-audiences: + - events requestBodies: EventCallbackAccountRequest: description: |- @@ -15215,6 +15418,20 @@ x-webhooks: $ref: '#/components/examples/EventCallbackSignUrlInvalid' callback_test_example: $ref: '#/components/examples/EventCallbackCallbackTest' + fax_received_example: + $ref: '#/components/examples/EventCallbackFaxReceived' + fax_sent_example: + $ref: '#/components/examples/EventCallbackFaxSent' + fax_on_hold_example: + $ref: '#/components/examples/EventCallbackFaxOnHold' + fax_busy_example: + $ref: '#/components/examples/EventCallbackFaxBusy' + fax_no_answer_example: + $ref: '#/components/examples/EventCallbackFaxNoAnswer' + fax_disconnected_example: + $ref: '#/components/examples/EventCallbackFaxDisconnected' + fax_blacklisted_example: + $ref: '#/components/examples/EventCallbackFaxBlacklisted' responses: 200: $ref: '#/components/responses/EventCallbackResponse' @@ -15287,6 +15504,20 @@ x-webhooks: $ref: '#/components/examples/EventCallbackSignUrlInvalid' callback_test_example: $ref: '#/components/examples/EventCallbackCallbackTest' + fax_received_example: + $ref: '#/components/examples/EventCallbackFaxReceived' + fax_sent_example: + $ref: '#/components/examples/EventCallbackFaxSent' + fax_on_hold_example: + $ref: '#/components/examples/EventCallbackFaxOnHold' + fax_busy_example: + $ref: '#/components/examples/EventCallbackFaxBusy' + fax_no_answer_example: + $ref: '#/components/examples/EventCallbackFaxNoAnswer' + fax_disconnected_example: + $ref: '#/components/examples/EventCallbackFaxDisconnected' + fax_blacklisted_example: + $ref: '#/components/examples/EventCallbackFaxBlacklisted' responses: 200: $ref: '#/components/responses/EventCallbackResponse' diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEvent.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEvent.cs index 5308add39..070bc33e7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEvent.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEvent.cs @@ -176,7 +176,49 @@ public enum EventTypeEnum /// Enum SignatureRequestSignerRemoved for value: signature_request_signer_removed /// [EnumMember(Value = "signature_request_signer_removed")] - SignatureRequestSignerRemoved = 23 + SignatureRequestSignerRemoved = 23, + + /// + /// Enum FaxReceived for value: fax_received + /// + [EnumMember(Value = "fax_received")] + FaxReceived = 24, + + /// + /// Enum FaxSent for value: fax_sent + /// + [EnumMember(Value = "fax_sent")] + FaxSent = 25, + + /// + /// Enum FaxOnHold for value: fax_on_hold + /// + [EnumMember(Value = "fax_on_hold")] + FaxOnHold = 26, + + /// + /// Enum FaxBusy for value: fax_busy + /// + [EnumMember(Value = "fax_busy")] + FaxBusy = 27, + + /// + /// Enum FaxNoAnswer for value: fax_no_answer + /// + [EnumMember(Value = "fax_no_answer")] + FaxNoAnswer = 28, + + /// + /// Enum FaxDisconnected for value: fax_disconnected + /// + [EnumMember(Value = "fax_disconnected")] + FaxDisconnected = 29, + + /// + /// Enum FaxBlacklisted for value: fax_blacklisted + /// + [EnumMember(Value = "fax_blacklisted")] + FaxBlacklisted = 30 } diff --git a/sdks/java-v1/docs/EventCallbackRequestEvent.md b/sdks/java-v1/docs/EventCallbackRequestEvent.md index 19ab491c2..2f5cbd133 100644 --- a/sdks/java-v1/docs/EventCallbackRequestEvent.md +++ b/sdks/java-v1/docs/EventCallbackRequestEvent.md @@ -42,6 +42,13 @@ Basic information about the event that occurred. | TEMPLATE_ERROR | "template_error" | | CALLBACK_TEST | "callback_test" | | SIGNATURE_REQUEST_SIGNER_REMOVED | "signature_request_signer_removed" | +| FAX_RECEIVED | "fax_received" | +| FAX_SENT | "fax_sent" | +| FAX_ON_HOLD | "fax_on_hold" | +| FAX_BUSY | "fax_busy" | +| FAX_NO_ANSWER | "fax_no_answer" | +| FAX_DISCONNECTED | "fax_disconnected" | +| FAX_BLACKLISTED | "fax_blacklisted" | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java index a3e999816..32152454f 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java @@ -86,7 +86,21 @@ public enum EventTypeEnum { CALLBACK_TEST(String.valueOf("callback_test")), - SIGNATURE_REQUEST_SIGNER_REMOVED(String.valueOf("signature_request_signer_removed")); + SIGNATURE_REQUEST_SIGNER_REMOVED(String.valueOf("signature_request_signer_removed")), + + FAX_RECEIVED(String.valueOf("fax_received")), + + FAX_SENT(String.valueOf("fax_sent")), + + FAX_ON_HOLD(String.valueOf("fax_on_hold")), + + FAX_BUSY(String.valueOf("fax_busy")), + + FAX_NO_ANSWER(String.valueOf("fax_no_answer")), + + FAX_DISCONNECTED(String.valueOf("fax_disconnected")), + + FAX_BLACKLISTED(String.valueOf("fax_blacklisted")); private String value; diff --git a/sdks/java-v2/docs/EventCallbackRequestEvent.md b/sdks/java-v2/docs/EventCallbackRequestEvent.md index 19ab491c2..2f5cbd133 100644 --- a/sdks/java-v2/docs/EventCallbackRequestEvent.md +++ b/sdks/java-v2/docs/EventCallbackRequestEvent.md @@ -42,6 +42,13 @@ Basic information about the event that occurred. | TEMPLATE_ERROR | "template_error" | | CALLBACK_TEST | "callback_test" | | SIGNATURE_REQUEST_SIGNER_REMOVED | "signature_request_signer_removed" | +| FAX_RECEIVED | "fax_received" | +| FAX_SENT | "fax_sent" | +| FAX_ON_HOLD | "fax_on_hold" | +| FAX_BUSY | "fax_busy" | +| FAX_NO_ANSWER | "fax_no_answer" | +| FAX_DISCONNECTED | "fax_disconnected" | +| FAX_BLACKLISTED | "fax_blacklisted" | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java index 600430445..ac04a69ef 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java @@ -94,7 +94,21 @@ public enum EventTypeEnum { CALLBACK_TEST(String.valueOf("callback_test")), - SIGNATURE_REQUEST_SIGNER_REMOVED(String.valueOf("signature_request_signer_removed")); + SIGNATURE_REQUEST_SIGNER_REMOVED(String.valueOf("signature_request_signer_removed")), + + FAX_RECEIVED(String.valueOf("fax_received")), + + FAX_SENT(String.valueOf("fax_sent")), + + FAX_ON_HOLD(String.valueOf("fax_on_hold")), + + FAX_BUSY(String.valueOf("fax_busy")), + + FAX_NO_ANSWER(String.valueOf("fax_no_answer")), + + FAX_DISCONNECTED(String.valueOf("fax_disconnected")), + + FAX_BLACKLISTED(String.valueOf("fax_blacklisted")); private String value; diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index a1419df7a..58217eb4e 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -18163,6 +18163,13 @@ var EventCallbackRequestEvent = class _EventCallbackRequestEvent { EventTypeEnum2["TemplateError"] = "template_error"; EventTypeEnum2["CallbackTest"] = "callback_test"; EventTypeEnum2["SignatureRequestSignerRemoved"] = "signature_request_signer_removed"; + EventTypeEnum2["FaxReceived"] = "fax_received"; + EventTypeEnum2["FaxSent"] = "fax_sent"; + EventTypeEnum2["FaxOnHold"] = "fax_on_hold"; + EventTypeEnum2["FaxBusy"] = "fax_busy"; + EventTypeEnum2["FaxNoAnswer"] = "fax_no_answer"; + EventTypeEnum2["FaxDisconnected"] = "fax_disconnected"; + EventTypeEnum2["FaxBlacklisted"] = "fax_blacklisted"; })(EventTypeEnum = EventCallbackRequestEvent2.EventTypeEnum || (EventCallbackRequestEvent2.EventTypeEnum = {})); })(EventCallbackRequestEvent || (EventCallbackRequestEvent = {})); diff --git a/sdks/node/model/eventCallbackRequestEvent.ts b/sdks/node/model/eventCallbackRequestEvent.ts index 423380752..35cd907dc 100644 --- a/sdks/node/model/eventCallbackRequestEvent.ts +++ b/sdks/node/model/eventCallbackRequestEvent.ts @@ -103,5 +103,12 @@ export namespace EventCallbackRequestEvent { TemplateError = "template_error", CallbackTest = "callback_test", SignatureRequestSignerRemoved = "signature_request_signer_removed", + FaxReceived = "fax_received", + FaxSent = "fax_sent", + FaxOnHold = "fax_on_hold", + FaxBusy = "fax_busy", + FaxNoAnswer = "fax_no_answer", + FaxDisconnected = "fax_disconnected", + FaxBlacklisted = "fax_blacklisted", } } diff --git a/sdks/node/types/model/eventCallbackRequestEvent.d.ts b/sdks/node/types/model/eventCallbackRequestEvent.d.ts index ffacc7aea..4c18b54c4 100644 --- a/sdks/node/types/model/eventCallbackRequestEvent.d.ts +++ b/sdks/node/types/model/eventCallbackRequestEvent.d.ts @@ -34,6 +34,13 @@ export declare namespace EventCallbackRequestEvent { TemplateCreated = "template_created", TemplateError = "template_error", CallbackTest = "callback_test", - SignatureRequestSignerRemoved = "signature_request_signer_removed" + SignatureRequestSignerRemoved = "signature_request_signer_removed", + FaxReceived = "fax_received", + FaxSent = "fax_sent", + FaxOnHold = "fax_on_hold", + FaxBusy = "fax_busy", + FaxNoAnswer = "fax_no_answer", + FaxDisconnected = "fax_disconnected", + FaxBlacklisted = "fax_blacklisted" } } diff --git a/sdks/php/src/Model/EventCallbackRequestEvent.php b/sdks/php/src/Model/EventCallbackRequestEvent.php index 98683c88c..5e7ed0095 100644 --- a/sdks/php/src/Model/EventCallbackRequestEvent.php +++ b/sdks/php/src/Model/EventCallbackRequestEvent.php @@ -262,6 +262,13 @@ public function getModelName() public const EVENT_TYPE_TEMPLATE_ERROR = 'template_error'; public const EVENT_TYPE_CALLBACK_TEST = 'callback_test'; public const EVENT_TYPE_SIGNATURE_REQUEST_SIGNER_REMOVED = 'signature_request_signer_removed'; + public const EVENT_TYPE_FAX_RECEIVED = 'fax_received'; + public const EVENT_TYPE_FAX_SENT = 'fax_sent'; + public const EVENT_TYPE_FAX_ON_HOLD = 'fax_on_hold'; + public const EVENT_TYPE_FAX_BUSY = 'fax_busy'; + public const EVENT_TYPE_FAX_NO_ANSWER = 'fax_no_answer'; + public const EVENT_TYPE_FAX_DISCONNECTED = 'fax_disconnected'; + public const EVENT_TYPE_FAX_BLACKLISTED = 'fax_blacklisted'; /** * Gets allowable values of the enum @@ -294,6 +301,13 @@ public function getEventTypeAllowableValues() self::EVENT_TYPE_TEMPLATE_ERROR, self::EVENT_TYPE_CALLBACK_TEST, self::EVENT_TYPE_SIGNATURE_REQUEST_SIGNER_REMOVED, + self::EVENT_TYPE_FAX_RECEIVED, + self::EVENT_TYPE_FAX_SENT, + self::EVENT_TYPE_FAX_ON_HOLD, + self::EVENT_TYPE_FAX_BUSY, + self::EVENT_TYPE_FAX_NO_ANSWER, + self::EVENT_TYPE_FAX_DISCONNECTED, + self::EVENT_TYPE_FAX_BLACKLISTED, ]; } diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event.py b/sdks/python/dropbox_sign/models/event_callback_request_event.py index 7f263da42..adada9bea 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event.py @@ -80,10 +80,17 @@ def event_type_validate_enum(cls, value): "template_error", "callback_test", "signature_request_signer_removed", + "fax_received", + "fax_sent", + "fax_on_hold", + "fax_busy", + "fax_no_answer", + "fax_disconnected", + "fax_blacklisted", ] ): raise ValueError( - "must be one of enum values ('account_confirmed', 'unknown_error', 'file_error', 'sign_url_invalid', 'signature_request_viewed', 'signature_request_signed', 'signature_request_sent', 'signature_request_all_signed', 'signature_request_email_bounce', 'signature_request_remind', 'signature_request_incomplete_qes', 'signature_request_destroyed', 'signature_request_canceled', 'signature_request_downloadable', 'signature_request_declined', 'signature_request_reassigned', 'signature_request_invalid', 'signature_request_prepared', 'signature_request_expired', 'template_created', 'template_error', 'callback_test', 'signature_request_signer_removed')" + "must be one of enum values ('account_confirmed', 'unknown_error', 'file_error', 'sign_url_invalid', 'signature_request_viewed', 'signature_request_signed', 'signature_request_sent', 'signature_request_all_signed', 'signature_request_email_bounce', 'signature_request_remind', 'signature_request_incomplete_qes', 'signature_request_destroyed', 'signature_request_canceled', 'signature_request_downloadable', 'signature_request_declined', 'signature_request_reassigned', 'signature_request_invalid', 'signature_request_prepared', 'signature_request_expired', 'template_created', 'template_error', 'callback_test', 'signature_request_signer_removed', 'fax_received', 'fax_sent', 'fax_on_hold', 'fax_busy', 'fax_no_answer', 'fax_disconnected', 'fax_blacklisted')" ) return value diff --git a/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event.rb b/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event.rb index 134eceee0..80fb4e50e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event.rb +++ b/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event.rb @@ -174,7 +174,7 @@ def list_invalid_properties def valid? return false if @event_time.nil? return false if @event_type.nil? - event_type_validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test", "signature_request_signer_removed"]) + event_type_validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test", "signature_request_signer_removed", "fax_received", "fax_sent", "fax_on_hold", "fax_busy", "fax_no_answer", "fax_disconnected", "fax_blacklisted"]) return false unless event_type_validator.valid?(@event_type) return false if @event_hash.nil? true @@ -193,7 +193,7 @@ def event_time=(event_time) # Custom attribute writer method checking allowed values (enum). # @param [Object] event_type Object to be assigned def event_type=(event_type) - validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test", "signature_request_signer_removed"]) + validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test", "signature_request_signer_removed", "fax_received", "fax_sent", "fax_on_hold", "fax_busy", "fax_no_answer", "fax_disconnected", "fax_blacklisted"]) unless validator.valid?(event_type) fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}." end diff --git a/translations/en.yaml b/translations/en.yaml index c35b7c60b..48f0c2df1 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -1491,6 +1491,34 @@ "EventCallbackCallbackTest::EVENT_TITLE": Callback Test Event "EventCallbackCallbackTest::EVENT_EXAMPLE_SUMMARY": Callback Test Event Example +"EventCallbackFaxReceived::TITLE": Fax Received +"EventCallbackFaxReceived::EVENT_TITLE": Fax Received Event +"EventCallbackFaxReceived::EVENT_EXAMPLE_SUMMARY": Fax Received Event Example + +"EventCallbackFaxSent::TITLE": Fax Sent +"EventCallbackFaxSent::EVENT_TITLE": Fax Sent Event +"EventCallbackFaxSent::EVENT_EXAMPLE_SUMMARY": Fax Sent Event Example + +"EventCallbackFaxOnHold::TITLE": Fax On Hold +"EventCallbackFaxOnHold::EVENT_TITLE": Fax On Hold Event +"EventCallbackFaxOnHold::EVENT_EXAMPLE_SUMMARY": Fax On Hold Event Example + +"EventCallbackFaxBusy::TITLE": Fax Busy +"EventCallbackFaxBusy::EVENT_TITLE": Fax Busy Event +"EventCallbackFaxBusy::EVENT_EXAMPLE_SUMMARY": Fax Busy Event Example + +"EventCallbackFaxNoAnswer::TITLE": Fax No Answer +"EventCallbackFaxNoAnswer::EVENT_TITLE": Fax No Answer Event +"EventCallbackFaxNoAnswer::EVENT_EXAMPLE_SUMMARY": Fax No Answer Event Example + +"EventCallbackFaxDisconnected::TITLE": Fax Disconnected +"EventCallbackFaxDisconnected::EVENT_TITLE": Fax Disconnected Event +"EventCallbackFaxDisconnected::EVENT_EXAMPLE_SUMMARY": Fax Disconnected Event Example + +"EventCallbackFaxBlacklisted::TITLE": Fax Blacklisted +"EventCallbackFaxBlacklisted::EVENT_TITLE": Fax Blacklisted Event +"EventCallbackFaxBlacklisted::EVENT_EXAMPLE_SUMMARY": Fax Blacklisted Event Example + "ListInfoResponse::DESCRIPTION": Contains pagination information about the data returned. "ListInfoResponse::NUM_PAGES": Total number of pages available. "ListInfoResponse::NUM_RESULTS": Total number of objects available.