Skip to content

Commit 31136f9

Browse files
Openapi files with new error catalog (#550)
1 parent 2e271d6 commit 31136f9

18 files changed

Lines changed: 908 additions & 20 deletions

File tree

openapi-raw.yaml

Lines changed: 241 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -968,8 +968,8 @@ paths:
968968
- request_signature
969969
- signature_request_access
970970
x-hideOn:
971-
- sdk
972971
- doc
972+
- sdk
973973
'/bulk_send_job/{bulk_send_job_id}':
974974
get:
975975
tags:
@@ -5067,6 +5067,8 @@ paths:
50675067
$ref: '#/components/examples/Error429Response'
50685068
404_example:
50695069
$ref: '#/components/examples/Error404Response'
5070+
409_example:
5071+
$ref: '#/components/examples/Error409Response'
50705072
4XX_example:
50715073
$ref: '#/components/examples/Error4XXResponse'
50725074
security:
@@ -14705,3 +14707,241 @@ x-webhooks:
1470514707
responses:
1470614708
'200':
1470714709
$ref: '#/components/responses/EventCallbackResponse'
14710+
x-error-codes:
14711+
bad_request:
14712+
http_status: 400
14713+
summary: '_t__ErrorCatalog::bad_request::SUMMARY'
14714+
cause: '_t__ErrorCatalog::bad_request::CAUSE'
14715+
remediation: '_t__ErrorCatalog::bad_request::REMEDIATION'
14716+
retryable: 'no'
14717+
unauthorized:
14718+
http_status: 401
14719+
summary: '_t__ErrorCatalog::unauthorized::SUMMARY'
14720+
cause: '_t__ErrorCatalog::unauthorized::CAUSE'
14721+
remediation: '_t__ErrorCatalog::unauthorized::REMEDIATION'
14722+
retryable: 'no'
14723+
payment_required:
14724+
http_status: 402
14725+
summary: '_t__ErrorCatalog::payment_required::SUMMARY'
14726+
cause: '_t__ErrorCatalog::payment_required::CAUSE'
14727+
remediation: '_t__ErrorCatalog::payment_required::REMEDIATION'
14728+
retryable: 'no'
14729+
forbidden:
14730+
http_status: 403
14731+
summary: '_t__ErrorCatalog::forbidden::SUMMARY'
14732+
cause: '_t__ErrorCatalog::forbidden::CAUSE'
14733+
remediation: '_t__ErrorCatalog::forbidden::REMEDIATION'
14734+
retryable: 'no'
14735+
not_found:
14736+
http_status: 404
14737+
summary: '_t__ErrorCatalog::not_found::SUMMARY'
14738+
cause: '_t__ErrorCatalog::not_found::CAUSE'
14739+
remediation: '_t__ErrorCatalog::not_found::REMEDIATION'
14740+
retryable: 'no'
14741+
conflict:
14742+
http_status: 409
14743+
summary: '_t__ErrorCatalog::conflict::SUMMARY'
14744+
cause: '_t__ErrorCatalog::conflict::CAUSE'
14745+
remediation: '_t__ErrorCatalog::conflict::REMEDIATION'
14746+
retryable: conditional
14747+
exceeded_rate:
14748+
http_status: 429
14749+
summary: '_t__ErrorCatalog::exceeded_rate::SUMMARY'
14750+
cause: '_t__ErrorCatalog::exceeded_rate::CAUSE'
14751+
remediation: '_t__ErrorCatalog::exceeded_rate::REMEDIATION'
14752+
retryable: 'yes'
14753+
backoff: '_t__ErrorCatalog::exceeded_rate::BACKOFF'
14754+
unknown:
14755+
http_status: 500
14756+
summary: '_t__ErrorCatalog::unknown::SUMMARY'
14757+
cause: '_t__ErrorCatalog::unknown::CAUSE'
14758+
remediation: '_t__ErrorCatalog::unknown::REMEDIATION'
14759+
retryable: conditional
14760+
backoff: '_t__ErrorCatalog::unknown::BACKOFF'
14761+
team_invite_failed:
14762+
http_status: 403
14763+
summary: '_t__ErrorCatalog::team_invite_failed::SUMMARY'
14764+
cause: '_t__ErrorCatalog::team_invite_failed::CAUSE'
14765+
remediation: '_t__ErrorCatalog::team_invite_failed::REMEDIATION'
14766+
retryable: 'no'
14767+
max_faxes:
14768+
http_status: 429
14769+
summary: '_t__ErrorCatalog::max_faxes::SUMMARY'
14770+
cause: '_t__ErrorCatalog::max_faxes::CAUSE'
14771+
remediation: '_t__ErrorCatalog::max_faxes::REMEDIATION'
14772+
retryable: 'yes'
14773+
backoff: '_t__ErrorCatalog::max_faxes::BACKOFF'
14774+
invalid_recipient:
14775+
http_status: 400
14776+
summary: '_t__ErrorCatalog::invalid_recipient::SUMMARY'
14777+
cause: '_t__ErrorCatalog::invalid_recipient::CAUSE'
14778+
remediation: '_t__ErrorCatalog::invalid_recipient::REMEDIATION'
14779+
retryable: 'no'
14780+
signature_request_cancel_failed:
14781+
http_status: 400
14782+
summary: '_t__ErrorCatalog::signature_request_cancel_failed::SUMMARY'
14783+
cause: '_t__ErrorCatalog::signature_request_cancel_failed::CAUSE'
14784+
remediation: '_t__ErrorCatalog::signature_request_cancel_failed::REMEDIATION'
14785+
retryable: 'no'
14786+
signature_request_remove_failed:
14787+
http_status: 400
14788+
summary: '_t__ErrorCatalog::signature_request_remove_failed::SUMMARY'
14789+
cause: '_t__ErrorCatalog::signature_request_remove_failed::CAUSE'
14790+
remediation: '_t__ErrorCatalog::signature_request_remove_failed::REMEDIATION'
14791+
retryable: 'no'
14792+
maintenance:
14793+
http_status: 503
14794+
summary: '_t__ErrorCatalog::maintenance::SUMMARY'
14795+
cause: '_t__ErrorCatalog::maintenance::CAUSE'
14796+
remediation: '_t__ErrorCatalog::maintenance::REMEDIATION'
14797+
retryable: 'yes'
14798+
backoff: '_t__ErrorCatalog::maintenance::BACKOFF'
14799+
method_not_supported:
14800+
http_status: 405
14801+
summary: '_t__ErrorCatalog::method_not_supported::SUMMARY'
14802+
cause: '_t__ErrorCatalog::method_not_supported::CAUSE'
14803+
remediation: '_t__ErrorCatalog::method_not_supported::REMEDIATION'
14804+
retryable: 'no'
14805+
invalid_reminder:
14806+
http_status: 400
14807+
summary: '_t__ErrorCatalog::invalid_reminder::SUMMARY'
14808+
cause: '_t__ErrorCatalog::invalid_reminder::CAUSE'
14809+
remediation: '_t__ErrorCatalog::invalid_reminder::REMEDIATION'
14810+
retryable: 'no'
14811+
unavailable:
14812+
http_status: 503
14813+
summary: '_t__ErrorCatalog::unavailable::SUMMARY'
14814+
cause: '_t__ErrorCatalog::unavailable::CAUSE'
14815+
remediation: '_t__ErrorCatalog::unavailable::REMEDIATION'
14816+
retryable: 'yes'
14817+
backoff: '_t__ErrorCatalog::unavailable::BACKOFF'
14818+
unprocessable_entity:
14819+
http_status: 422
14820+
summary: '_t__ErrorCatalog::unprocessable_entity::SUMMARY'
14821+
cause: '_t__ErrorCatalog::unprocessable_entity::CAUSE'
14822+
remediation: '_t__ErrorCatalog::unprocessable_entity::REMEDIATION'
14823+
retryable: conditional
14824+
backoff: '_t__ErrorCatalog::unprocessable_entity::BACKOFF'
14825+
signature_request_expired:
14826+
http_status:
14827+
- 400
14828+
- 403
14829+
summary: '_t__ErrorCatalog::signature_request_expired::SUMMARY'
14830+
cause: '_t__ErrorCatalog::signature_request_expired::CAUSE'
14831+
remediation: '_t__ErrorCatalog::signature_request_expired::REMEDIATION'
14832+
retryable: 'no'
14833+
deleted:
14834+
http_status: 410
14835+
summary: '_t__ErrorCatalog::deleted::SUMMARY'
14836+
cause: '_t__ErrorCatalog::deleted::CAUSE'
14837+
remediation: '_t__ErrorCatalog::deleted::REMEDIATION'
14838+
retryable: 'no'
14839+
x-oauth-error-codes:
14840+
invalid_grant:
14841+
http_status:
14842+
- 400
14843+
- 401
14844+
summary: '_t__OAuthErrorCatalog::invalid_grant::SUMMARY'
14845+
cause: '_t__OAuthErrorCatalog::invalid_grant::CAUSE'
14846+
remediation: '_t__OAuthErrorCatalog::invalid_grant::REMEDIATION'
14847+
retryable: 'no'
14848+
invalid_client:
14849+
http_status: 400
14850+
summary: '_t__OAuthErrorCatalog::invalid_client::SUMMARY'
14851+
cause: '_t__OAuthErrorCatalog::invalid_client::CAUSE'
14852+
remediation: '_t__OAuthErrorCatalog::invalid_client::REMEDIATION'
14853+
retryable: 'no'
14854+
invalid_request:
14855+
http_status: 400
14856+
summary: '_t__OAuthErrorCatalog::invalid_request::SUMMARY'
14857+
cause: '_t__OAuthErrorCatalog::invalid_request::CAUSE'
14858+
remediation: '_t__OAuthErrorCatalog::invalid_request::REMEDIATION'
14859+
retryable: 'no'
14860+
unauthorized_client:
14861+
http_status:
14862+
- 401
14863+
- 403
14864+
summary: '_t__OAuthErrorCatalog::unauthorized_client::SUMMARY'
14865+
cause: '_t__OAuthErrorCatalog::unauthorized_client::CAUSE'
14866+
remediation: '_t__OAuthErrorCatalog::unauthorized_client::REMEDIATION'
14867+
retryable: 'no'
14868+
unsupported_grant_type:
14869+
http_status: 400
14870+
summary: '_t__OAuthErrorCatalog::unsupported_grant_type::SUMMARY'
14871+
cause: '_t__OAuthErrorCatalog::unsupported_grant_type::CAUSE'
14872+
remediation: '_t__OAuthErrorCatalog::unsupported_grant_type::REMEDIATION'
14873+
retryable: 'no'
14874+
payment_required:
14875+
http_status: 402
14876+
summary: '_t__OAuthErrorCatalog::payment_required::SUMMARY'
14877+
cause: '_t__OAuthErrorCatalog::payment_required::CAUSE'
14878+
remediation: '_t__OAuthErrorCatalog::payment_required::REMEDIATION'
14879+
retryable: 'no'
14880+
addon_required:
14881+
http_status: 402
14882+
summary: '_t__OAuthErrorCatalog::addon_required::SUMMARY'
14883+
cause: '_t__OAuthErrorCatalog::addon_required::CAUSE'
14884+
remediation: '_t__OAuthErrorCatalog::addon_required::REMEDIATION'
14885+
retryable: 'no'
14886+
invalid_scope:
14887+
http_status: 400
14888+
summary: '_t__OAuthErrorCatalog::invalid_scope::SUMMARY'
14889+
cause: '_t__OAuthErrorCatalog::invalid_scope::CAUSE'
14890+
remediation: '_t__OAuthErrorCatalog::invalid_scope::REMEDIATION'
14891+
retryable: 'no'
14892+
quota_reached:
14893+
http_status: 402
14894+
summary: '_t__OAuthErrorCatalog::quota_reached::SUMMARY'
14895+
cause: '_t__OAuthErrorCatalog::quota_reached::CAUSE'
14896+
remediation: '_t__OAuthErrorCatalog::quota_reached::REMEDIATION'
14897+
retryable: 'no'
14898+
server_error:
14899+
http_status: 500
14900+
summary: '_t__OAuthErrorCatalog::server_error::SUMMARY'
14901+
cause: '_t__OAuthErrorCatalog::server_error::CAUSE'
14902+
remediation: '_t__OAuthErrorCatalog::server_error::REMEDIATION'
14903+
retryable: 'yes'
14904+
backoff: '_t__OAuthErrorCatalog::server_error::BACKOFF'
14905+
temporary_unavailable:
14906+
http_status: 503
14907+
summary: '_t__OAuthErrorCatalog::temporary_unavailable::SUMMARY'
14908+
cause: '_t__OAuthErrorCatalog::temporary_unavailable::CAUSE'
14909+
remediation: '_t__OAuthErrorCatalog::temporary_unavailable::REMEDIATION'
14910+
retryable: 'yes'
14911+
backoff: '_t__OAuthErrorCatalog::temporary_unavailable::BACKOFF'
14912+
x-error-events:
14913+
signature_request_invalid:
14914+
event_type: signature_request_invalid
14915+
delivery: webhook
14916+
summary: '_t__ErrorEventCatalog::signature_request_invalid::SUMMARY'
14917+
cause: '_t__ErrorEventCatalog::signature_request_invalid::CAUSE'
14918+
remediation: '_t__ErrorEventCatalog::signature_request_invalid::REMEDIATION'
14919+
retryable: conditional
14920+
unknown_error:
14921+
event_type: unknown_error
14922+
delivery: webhook
14923+
summary: '_t__ErrorEventCatalog::unknown_error::SUMMARY'
14924+
cause: '_t__ErrorEventCatalog::unknown_error::CAUSE'
14925+
remediation: '_t__ErrorEventCatalog::unknown_error::REMEDIATION'
14926+
retryable: conditional
14927+
file_error:
14928+
event_type: file_error
14929+
delivery: webhook
14930+
summary: '_t__ErrorEventCatalog::file_error::SUMMARY'
14931+
cause: '_t__ErrorEventCatalog::file_error::CAUSE'
14932+
remediation: '_t__ErrorEventCatalog::file_error::REMEDIATION'
14933+
retryable: conditional
14934+
template_error:
14935+
event_type: template_error
14936+
delivery: webhook
14937+
summary: '_t__ErrorEventCatalog::template_error::SUMMARY'
14938+
cause: '_t__ErrorEventCatalog::template_error::CAUSE'
14939+
remediation: '_t__ErrorEventCatalog::template_error::REMEDIATION'
14940+
retryable: conditional
14941+
sign_url_invalid:
14942+
event_type: sign_url_invalid
14943+
delivery: webhook
14944+
summary: '_t__ErrorEventCatalog::sign_url_invalid::SUMMARY'
14945+
cause: '_t__ErrorEventCatalog::sign_url_invalid::CAUSE'
14946+
remediation: '_t__ErrorEventCatalog::sign_url_invalid::REMEDIATION'
14947+
retryable: 'yes'

0 commit comments

Comments
 (0)