Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
343 changes: 343 additions & 0 deletions openapi-raw.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -929,6 +929,47 @@ paths:
seo:
title: '_t__ApiAppList::SEO::TITLE'
description: '_t__ApiAppList::SEO::DESCRIPTION'
/notification/retry:
post:
tags:
- 'Callbacks and Events'
summary: 'Resend an API notification asynchronously.'
description: 'Queues an API notification by event_type and id. A new notification event is generated from current object state.'
operationId: apiNotificationRetry
responses:
'202':
description: 'Resend queued'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
-
api_key: []
-
oauth2:
- request_signature
- signature_request_access
x-hideOn:
- doc
- sdk
'/bulk_send_job/{bulk_send_job_id}':
get:
tags:
Expand Down Expand Up @@ -5026,6 +5067,8 @@ paths:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
Expand Down Expand Up @@ -11481,6 +11524,68 @@ components:
error_name:
description: '_t__ErrorResponseError::ERROR_NAME'
type: string
enum:
- bad_request
- unauthorized
- payment_required
- forbidden
- not_found
- conflict
- exceeded_rate
- unknown
- team_invite_failed
- max_faxes
- invalid_recipient
- signature_request_cancel_failed
- signature_request_remove_failed
- maintenance
- deleted
- method_not_supported
- invalid_reminder
- unavailable
- unprocessable_entity
- signature_request_expired
x-fern-enum:
bad_request:
description: '_t__ErrorCatalog::bad_request::SUMMARY'
unauthorized:
description: '_t__ErrorCatalog::unauthorized::SUMMARY'
payment_required:
description: '_t__ErrorCatalog::payment_required::SUMMARY'
forbidden:
description: '_t__ErrorCatalog::forbidden::SUMMARY'
not_found:
description: '_t__ErrorCatalog::not_found::SUMMARY'
conflict:
description: '_t__ErrorCatalog::conflict::SUMMARY'
exceeded_rate:
description: '_t__ErrorCatalog::exceeded_rate::SUMMARY'
unknown:
description: '_t__ErrorCatalog::unknown::SUMMARY'
team_invite_failed:
description: '_t__ErrorCatalog::team_invite_failed::SUMMARY'
max_faxes:
description: '_t__ErrorCatalog::max_faxes::SUMMARY'
invalid_recipient:
description: '_t__ErrorCatalog::invalid_recipient::SUMMARY'
signature_request_cancel_failed:
description: '_t__ErrorCatalog::signature_request_cancel_failed::SUMMARY'
signature_request_remove_failed:
description: '_t__ErrorCatalog::signature_request_remove_failed::SUMMARY'
maintenance:
description: '_t__ErrorCatalog::maintenance::SUMMARY'
deleted:
description: '_t__ErrorCatalog::deleted::SUMMARY'
method_not_supported:
description: '_t__ErrorCatalog::method_not_supported::SUMMARY'
invalid_reminder:
description: '_t__ErrorCatalog::invalid_reminder::SUMMARY'
unavailable:
description: '_t__ErrorCatalog::unavailable::SUMMARY'
unprocessable_entity:
description: '_t__ErrorCatalog::unprocessable_entity::SUMMARY'
signature_request_expired:
description: '_t__ErrorCatalog::signature_request_expired::SUMMARY'
type: object
FaxResponse:
required:
Expand Down Expand Up @@ -13928,3 +14033,241 @@ x-webhooks:
responses:
'200':
$ref: '#/components/responses/EventCallbackResponse'
x-error-codes:
bad_request:
http_status: 400
summary: '_t__ErrorCatalog::bad_request::SUMMARY'
cause: '_t__ErrorCatalog::bad_request::CAUSE'
remediation: '_t__ErrorCatalog::bad_request::REMEDIATION'
retryable: 'no'
unauthorized:
http_status: 401
summary: '_t__ErrorCatalog::unauthorized::SUMMARY'
cause: '_t__ErrorCatalog::unauthorized::CAUSE'
remediation: '_t__ErrorCatalog::unauthorized::REMEDIATION'
retryable: 'no'
payment_required:
http_status: 402
summary: '_t__ErrorCatalog::payment_required::SUMMARY'
cause: '_t__ErrorCatalog::payment_required::CAUSE'
remediation: '_t__ErrorCatalog::payment_required::REMEDIATION'
retryable: 'no'
forbidden:
http_status: 403
summary: '_t__ErrorCatalog::forbidden::SUMMARY'
cause: '_t__ErrorCatalog::forbidden::CAUSE'
remediation: '_t__ErrorCatalog::forbidden::REMEDIATION'
retryable: 'no'
not_found:
http_status: 404
summary: '_t__ErrorCatalog::not_found::SUMMARY'
cause: '_t__ErrorCatalog::not_found::CAUSE'
remediation: '_t__ErrorCatalog::not_found::REMEDIATION'
retryable: 'no'
conflict:
http_status: 409
summary: '_t__ErrorCatalog::conflict::SUMMARY'
cause: '_t__ErrorCatalog::conflict::CAUSE'
remediation: '_t__ErrorCatalog::conflict::REMEDIATION'
retryable: conditional
exceeded_rate:
http_status: 429
summary: '_t__ErrorCatalog::exceeded_rate::SUMMARY'
cause: '_t__ErrorCatalog::exceeded_rate::CAUSE'
remediation: '_t__ErrorCatalog::exceeded_rate::REMEDIATION'
retryable: 'yes'
backoff: '_t__ErrorCatalog::exceeded_rate::BACKOFF'
unknown:
http_status: 500
summary: '_t__ErrorCatalog::unknown::SUMMARY'
cause: '_t__ErrorCatalog::unknown::CAUSE'
remediation: '_t__ErrorCatalog::unknown::REMEDIATION'
retryable: conditional
backoff: '_t__ErrorCatalog::unknown::BACKOFF'
team_invite_failed:
http_status: 403
summary: '_t__ErrorCatalog::team_invite_failed::SUMMARY'
cause: '_t__ErrorCatalog::team_invite_failed::CAUSE'
remediation: '_t__ErrorCatalog::team_invite_failed::REMEDIATION'
retryable: 'no'
max_faxes:
http_status: 429
summary: '_t__ErrorCatalog::max_faxes::SUMMARY'
cause: '_t__ErrorCatalog::max_faxes::CAUSE'
remediation: '_t__ErrorCatalog::max_faxes::REMEDIATION'
retryable: 'yes'
backoff: '_t__ErrorCatalog::max_faxes::BACKOFF'
invalid_recipient:
http_status: 400
summary: '_t__ErrorCatalog::invalid_recipient::SUMMARY'
cause: '_t__ErrorCatalog::invalid_recipient::CAUSE'
remediation: '_t__ErrorCatalog::invalid_recipient::REMEDIATION'
retryable: 'no'
signature_request_cancel_failed:
http_status: 400
summary: '_t__ErrorCatalog::signature_request_cancel_failed::SUMMARY'
cause: '_t__ErrorCatalog::signature_request_cancel_failed::CAUSE'
remediation: '_t__ErrorCatalog::signature_request_cancel_failed::REMEDIATION'
retryable: 'no'
signature_request_remove_failed:
http_status: 400
summary: '_t__ErrorCatalog::signature_request_remove_failed::SUMMARY'
cause: '_t__ErrorCatalog::signature_request_remove_failed::CAUSE'
remediation: '_t__ErrorCatalog::signature_request_remove_failed::REMEDIATION'
retryable: 'no'
maintenance:
http_status: 503
summary: '_t__ErrorCatalog::maintenance::SUMMARY'
cause: '_t__ErrorCatalog::maintenance::CAUSE'
remediation: '_t__ErrorCatalog::maintenance::REMEDIATION'
retryable: 'yes'
backoff: '_t__ErrorCatalog::maintenance::BACKOFF'
deleted:
http_status: 410
summary: '_t__ErrorCatalog::deleted::SUMMARY'
cause: '_t__ErrorCatalog::deleted::CAUSE'
remediation: '_t__ErrorCatalog::deleted::REMEDIATION'
retryable: 'no'
method_not_supported:
http_status: 405
summary: '_t__ErrorCatalog::method_not_supported::SUMMARY'
cause: '_t__ErrorCatalog::method_not_supported::CAUSE'
remediation: '_t__ErrorCatalog::method_not_supported::REMEDIATION'
retryable: 'no'
invalid_reminder:
http_status: 400
summary: '_t__ErrorCatalog::invalid_reminder::SUMMARY'
cause: '_t__ErrorCatalog::invalid_reminder::CAUSE'
remediation: '_t__ErrorCatalog::invalid_reminder::REMEDIATION'
retryable: 'no'
unavailable:
http_status: 503
summary: '_t__ErrorCatalog::unavailable::SUMMARY'
cause: '_t__ErrorCatalog::unavailable::CAUSE'
remediation: '_t__ErrorCatalog::unavailable::REMEDIATION'
retryable: 'yes'
backoff: '_t__ErrorCatalog::unavailable::BACKOFF'
unprocessable_entity:
http_status: 422
summary: '_t__ErrorCatalog::unprocessable_entity::SUMMARY'
cause: '_t__ErrorCatalog::unprocessable_entity::CAUSE'
remediation: '_t__ErrorCatalog::unprocessable_entity::REMEDIATION'
retryable: conditional
backoff: '_t__ErrorCatalog::unprocessable_entity::BACKOFF'
signature_request_expired:
http_status:
- 400
- 403
summary: '_t__ErrorCatalog::signature_request_expired::SUMMARY'
cause: '_t__ErrorCatalog::signature_request_expired::CAUSE'
remediation: '_t__ErrorCatalog::signature_request_expired::REMEDIATION'
retryable: 'no'
x-oauth-error-codes:
invalid_grant:
http_status:
- 400
- 401
summary: '_t__OAuthErrorCatalog::invalid_grant::SUMMARY'
cause: '_t__OAuthErrorCatalog::invalid_grant::CAUSE'
remediation: '_t__OAuthErrorCatalog::invalid_grant::REMEDIATION'
retryable: 'no'
invalid_client:
http_status: 400
summary: '_t__OAuthErrorCatalog::invalid_client::SUMMARY'
cause: '_t__OAuthErrorCatalog::invalid_client::CAUSE'
remediation: '_t__OAuthErrorCatalog::invalid_client::REMEDIATION'
retryable: 'no'
invalid_request:
http_status: 400
summary: '_t__OAuthErrorCatalog::invalid_request::SUMMARY'
cause: '_t__OAuthErrorCatalog::invalid_request::CAUSE'
remediation: '_t__OAuthErrorCatalog::invalid_request::REMEDIATION'
retryable: 'no'
unauthorized_client:
http_status:
- 401
- 403
summary: '_t__OAuthErrorCatalog::unauthorized_client::SUMMARY'
cause: '_t__OAuthErrorCatalog::unauthorized_client::CAUSE'
remediation: '_t__OAuthErrorCatalog::unauthorized_client::REMEDIATION'
retryable: 'no'
unsupported_grant_type:
http_status: 400
summary: '_t__OAuthErrorCatalog::unsupported_grant_type::SUMMARY'
cause: '_t__OAuthErrorCatalog::unsupported_grant_type::CAUSE'
remediation: '_t__OAuthErrorCatalog::unsupported_grant_type::REMEDIATION'
retryable: 'no'
payment_required:
http_status: 402
summary: '_t__OAuthErrorCatalog::payment_required::SUMMARY'
cause: '_t__OAuthErrorCatalog::payment_required::CAUSE'
remediation: '_t__OAuthErrorCatalog::payment_required::REMEDIATION'
retryable: 'no'
addon_required:
http_status: 402
summary: '_t__OAuthErrorCatalog::addon_required::SUMMARY'
cause: '_t__OAuthErrorCatalog::addon_required::CAUSE'
remediation: '_t__OAuthErrorCatalog::addon_required::REMEDIATION'
retryable: 'no'
invalid_scope:
http_status: 400
summary: '_t__OAuthErrorCatalog::invalid_scope::SUMMARY'
cause: '_t__OAuthErrorCatalog::invalid_scope::CAUSE'
remediation: '_t__OAuthErrorCatalog::invalid_scope::REMEDIATION'
retryable: 'no'
quota_reached:
http_status: 402
summary: '_t__OAuthErrorCatalog::quota_reached::SUMMARY'
cause: '_t__OAuthErrorCatalog::quota_reached::CAUSE'
remediation: '_t__OAuthErrorCatalog::quota_reached::REMEDIATION'
retryable: 'no'
server_error:
http_status: 500
summary: '_t__OAuthErrorCatalog::server_error::SUMMARY'
cause: '_t__OAuthErrorCatalog::server_error::CAUSE'
remediation: '_t__OAuthErrorCatalog::server_error::REMEDIATION'
retryable: 'yes'
backoff: '_t__OAuthErrorCatalog::server_error::BACKOFF'
temporary_unavailable:
http_status: 503
summary: '_t__OAuthErrorCatalog::temporary_unavailable::SUMMARY'
cause: '_t__OAuthErrorCatalog::temporary_unavailable::CAUSE'
remediation: '_t__OAuthErrorCatalog::temporary_unavailable::REMEDIATION'
retryable: 'yes'
backoff: '_t__OAuthErrorCatalog::temporary_unavailable::BACKOFF'
x-error-events:
signature_request_invalid:
event_type: signature_request_invalid
delivery: webhook
summary: '_t__ErrorEventCatalog::signature_request_invalid::SUMMARY'
cause: '_t__ErrorEventCatalog::signature_request_invalid::CAUSE'
remediation: '_t__ErrorEventCatalog::signature_request_invalid::REMEDIATION'
retryable: conditional
unknown_error:
event_type: unknown_error
delivery: webhook
summary: '_t__ErrorEventCatalog::unknown_error::SUMMARY'
cause: '_t__ErrorEventCatalog::unknown_error::CAUSE'
remediation: '_t__ErrorEventCatalog::unknown_error::REMEDIATION'
retryable: conditional
file_error:
event_type: file_error
delivery: webhook
summary: '_t__ErrorEventCatalog::file_error::SUMMARY'
cause: '_t__ErrorEventCatalog::file_error::CAUSE'
remediation: '_t__ErrorEventCatalog::file_error::REMEDIATION'
retryable: conditional
template_error:
event_type: template_error
delivery: webhook
summary: '_t__ErrorEventCatalog::template_error::SUMMARY'
cause: '_t__ErrorEventCatalog::template_error::CAUSE'
remediation: '_t__ErrorEventCatalog::template_error::REMEDIATION'
retryable: conditional
sign_url_invalid:
event_type: sign_url_invalid
delivery: webhook
summary: '_t__ErrorEventCatalog::sign_url_invalid::SUMMARY'
cause: '_t__ErrorEventCatalog::sign_url_invalid::CAUSE'
remediation: '_t__ErrorEventCatalog::sign_url_invalid::REMEDIATION'
retryable: 'yes'
Loading
Loading