Skip to content

Commit bac4f18

Browse files
Remove error codes enum
1 parent 9dd7881 commit bac4f18

21 files changed

Lines changed: 76 additions & 776 deletions

File tree

openapi-raw.yaml

Lines changed: 6 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -11524,68 +11524,6 @@ components:
1152411524
error_name:
1152511525
description: '_t__ErrorResponseError::ERROR_NAME'
1152611526
type: string
11527-
enum:
11528-
- bad_request
11529-
- unauthorized
11530-
- payment_required
11531-
- forbidden
11532-
- not_found
11533-
- conflict
11534-
- exceeded_rate
11535-
- unknown
11536-
- team_invite_failed
11537-
- max_faxes
11538-
- invalid_recipient
11539-
- signature_request_cancel_failed
11540-
- signature_request_remove_failed
11541-
- maintenance
11542-
- deleted
11543-
- method_not_supported
11544-
- invalid_reminder
11545-
- unavailable
11546-
- unprocessable_entity
11547-
- signature_request_expired
11548-
x-fern-enum:
11549-
bad_request:
11550-
description: '_t__ErrorCatalog::bad_request::SUMMARY'
11551-
unauthorized:
11552-
description: '_t__ErrorCatalog::unauthorized::SUMMARY'
11553-
payment_required:
11554-
description: '_t__ErrorCatalog::payment_required::SUMMARY'
11555-
forbidden:
11556-
description: '_t__ErrorCatalog::forbidden::SUMMARY'
11557-
not_found:
11558-
description: '_t__ErrorCatalog::not_found::SUMMARY'
11559-
conflict:
11560-
description: '_t__ErrorCatalog::conflict::SUMMARY'
11561-
exceeded_rate:
11562-
description: '_t__ErrorCatalog::exceeded_rate::SUMMARY'
11563-
unknown:
11564-
description: '_t__ErrorCatalog::unknown::SUMMARY'
11565-
team_invite_failed:
11566-
description: '_t__ErrorCatalog::team_invite_failed::SUMMARY'
11567-
max_faxes:
11568-
description: '_t__ErrorCatalog::max_faxes::SUMMARY'
11569-
invalid_recipient:
11570-
description: '_t__ErrorCatalog::invalid_recipient::SUMMARY'
11571-
signature_request_cancel_failed:
11572-
description: '_t__ErrorCatalog::signature_request_cancel_failed::SUMMARY'
11573-
signature_request_remove_failed:
11574-
description: '_t__ErrorCatalog::signature_request_remove_failed::SUMMARY'
11575-
maintenance:
11576-
description: '_t__ErrorCatalog::maintenance::SUMMARY'
11577-
deleted:
11578-
description: '_t__ErrorCatalog::deleted::SUMMARY'
11579-
method_not_supported:
11580-
description: '_t__ErrorCatalog::method_not_supported::SUMMARY'
11581-
invalid_reminder:
11582-
description: '_t__ErrorCatalog::invalid_reminder::SUMMARY'
11583-
unavailable:
11584-
description: '_t__ErrorCatalog::unavailable::SUMMARY'
11585-
unprocessable_entity:
11586-
description: '_t__ErrorCatalog::unprocessable_entity::SUMMARY'
11587-
signature_request_expired:
11588-
description: '_t__ErrorCatalog::signature_request_expired::SUMMARY'
1158911527
type: object
1159011528
FaxResponse:
1159111529
required:
@@ -14858,12 +14796,6 @@ x-error-codes:
1485814796
remediation: '_t__ErrorCatalog::maintenance::REMEDIATION'
1485914797
retryable: 'yes'
1486014798
backoff: '_t__ErrorCatalog::maintenance::BACKOFF'
14861-
deleted:
14862-
http_status: 410
14863-
summary: '_t__ErrorCatalog::deleted::SUMMARY'
14864-
cause: '_t__ErrorCatalog::deleted::CAUSE'
14865-
remediation: '_t__ErrorCatalog::deleted::REMEDIATION'
14866-
retryable: 'no'
1486714799
method_not_supported:
1486814800
http_status: 405
1486914801
summary: '_t__ErrorCatalog::method_not_supported::SUMMARY'
@@ -14898,6 +14830,12 @@ x-error-codes:
1489814830
cause: '_t__ErrorCatalog::signature_request_expired::CAUSE'
1489914831
remediation: '_t__ErrorCatalog::signature_request_expired::REMEDIATION'
1490014832
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'
1490114839
x-oauth-error-codes:
1490214840
invalid_grant:
1490314841
http_status:

openapi-sdk.yaml

Lines changed: 7 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -11945,70 +11945,8 @@ components:
1194511945
description: 'Path at which an error occurred.'
1194611946
type: string
1194711947
error_name:
11948-
description: 'Name of the error.'
11948+
description: 'Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance.'
1194911949
type: string
11950-
enum:
11951-
- bad_request
11952-
- unauthorized
11953-
- payment_required
11954-
- forbidden
11955-
- not_found
11956-
- conflict
11957-
- exceeded_rate
11958-
- unknown
11959-
- team_invite_failed
11960-
- max_faxes
11961-
- invalid_recipient
11962-
- signature_request_cancel_failed
11963-
- signature_request_remove_failed
11964-
- maintenance
11965-
- deleted
11966-
- method_not_supported
11967-
- invalid_reminder
11968-
- unavailable
11969-
- unprocessable_entity
11970-
- signature_request_expired
11971-
x-fern-enum:
11972-
bad_request:
11973-
description: 'The request contained invalid or malformed parameters.'
11974-
unauthorized:
11975-
description: 'The credentials supplied are missing or invalid.'
11976-
payment_required:
11977-
description: 'The account must be credited or upgraded to perform this action.'
11978-
forbidden:
11979-
description: 'The action is not allowed for these credentials or in the current context.'
11980-
not_found:
11981-
description: 'Nothing matches the requested resource.'
11982-
conflict:
11983-
description: 'The request was well-formed but conflicts with the current state.'
11984-
exceeded_rate:
11985-
description: 'Your account''s API request rate limit has been exceeded.'
11986-
unknown:
11987-
description: 'An unexpected error occurred.'
11988-
team_invite_failed:
11989-
description: 'The team invitation could not be completed.'
11990-
max_faxes:
11991-
description: 'Too many fax transmissions are currently pending or transmitting.'
11992-
invalid_recipient:
11993-
description: 'The recipient (fax number or email address) is invalid.'
11994-
signature_request_cancel_failed:
11995-
description: 'The signature request could not be cancelled.'
11996-
signature_request_remove_failed:
11997-
description: 'Access to the signature request could not be removed.'
11998-
maintenance:
11999-
description: 'The request could not be completed because the site is under maintenance.'
12000-
deleted:
12001-
description: 'The request was cancelled or deleted.'
12002-
method_not_supported:
12003-
description: 'The HTTP method is not supported for this endpoint.'
12004-
invalid_reminder:
12005-
description: 'The signature request reminder was invalid.'
12006-
unavailable:
12007-
description: 'The service is temporarily unavailable.'
12008-
unprocessable_entity:
12009-
description: 'The request was understood but the target entity cannot be processed.'
12010-
signature_request_expired:
12011-
description: 'The signature request has expired.'
1201211950
type: object
1201311951
FaxResponse:
1201411952
required:
@@ -14720,12 +14658,6 @@ x-error-codes:
1472014658
remediation: 'Retry once the maintenance window ends.'
1472114659
retryable: 'yes'
1472214660
backoff: 'Retry later with exponential backoff.'
14723-
deleted:
14724-
http_status: 410
14725-
summary: 'The request was cancelled or deleted.'
14726-
cause: 'The resource has been cancelled or removed and is no longer available.'
14727-
remediation: 'Do not retry; the resource is permanently gone.'
14728-
retryable: 'no'
1472914661
method_not_supported:
1473014662
http_status: 405
1473114663
summary: 'The HTTP method is not supported for this endpoint.'
@@ -14760,6 +14692,12 @@ x-error-codes:
1476014692
cause: 'The operation targets a request whose expiration has passed. Most endpoints return 400; final-copy/download endpoints return 403.'
1476114693
remediation: 'The request can no longer be acted upon; create a new signature request.'
1476214694
retryable: 'no'
14695+
deleted:
14696+
http_status: 410
14697+
summary: 'The request was cancelled or deleted.'
14698+
cause: 'The resource has been cancelled or removed and is no longer available.'
14699+
remediation: 'Do not retry; the resource is permanently gone.'
14700+
retryable: 'no'
1476314701
x-oauth-error-codes:
1476414702
invalid_grant:
1476514703
http_status:

openapi.yaml

Lines changed: 7 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -11925,70 +11925,8 @@ components:
1192511925
description: 'Path at which an error occurred.'
1192611926
type: string
1192711927
error_name:
11928-
description: 'Name of the error.'
11928+
description: 'Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance.'
1192911929
type: string
11930-
enum:
11931-
- bad_request
11932-
- unauthorized
11933-
- payment_required
11934-
- forbidden
11935-
- not_found
11936-
- conflict
11937-
- exceeded_rate
11938-
- unknown
11939-
- team_invite_failed
11940-
- max_faxes
11941-
- invalid_recipient
11942-
- signature_request_cancel_failed
11943-
- signature_request_remove_failed
11944-
- maintenance
11945-
- deleted
11946-
- method_not_supported
11947-
- invalid_reminder
11948-
- unavailable
11949-
- unprocessable_entity
11950-
- signature_request_expired
11951-
x-fern-enum:
11952-
bad_request:
11953-
description: 'The request contained invalid or malformed parameters.'
11954-
unauthorized:
11955-
description: 'The credentials supplied are missing or invalid.'
11956-
payment_required:
11957-
description: 'The account must be credited or upgraded to perform this action.'
11958-
forbidden:
11959-
description: 'The action is not allowed for these credentials or in the current context.'
11960-
not_found:
11961-
description: 'Nothing matches the requested resource.'
11962-
conflict:
11963-
description: 'The request was well-formed but conflicts with the current state.'
11964-
exceeded_rate:
11965-
description: 'Your account''s API request rate limit has been exceeded.'
11966-
unknown:
11967-
description: 'An unexpected error occurred.'
11968-
team_invite_failed:
11969-
description: 'The team invitation could not be completed.'
11970-
max_faxes:
11971-
description: 'Too many fax transmissions are currently pending or transmitting.'
11972-
invalid_recipient:
11973-
description: 'The recipient (fax number or email address) is invalid.'
11974-
signature_request_cancel_failed:
11975-
description: 'The signature request could not be cancelled.'
11976-
signature_request_remove_failed:
11977-
description: 'Access to the signature request could not be removed.'
11978-
maintenance:
11979-
description: 'The request could not be completed because the site is under maintenance.'
11980-
deleted:
11981-
description: 'The request was cancelled or deleted.'
11982-
method_not_supported:
11983-
description: 'The HTTP method is not supported for this endpoint.'
11984-
invalid_reminder:
11985-
description: 'The signature request reminder was invalid.'
11986-
unavailable:
11987-
description: 'The service is temporarily unavailable.'
11988-
unprocessable_entity:
11989-
description: 'The request was understood but the target entity cannot be processed.'
11990-
signature_request_expired:
11991-
description: 'The signature request has expired.'
1199211930
type: object
1199311931
FaxResponse:
1199411932
required:
@@ -15409,12 +15347,6 @@ x-error-codes:
1540915347
remediation: 'Retry once the maintenance window ends.'
1541015348
retryable: 'yes'
1541115349
backoff: 'Retry later with exponential backoff.'
15412-
deleted:
15413-
http_status: 410
15414-
summary: 'The request was cancelled or deleted.'
15415-
cause: 'The resource has been cancelled or removed and is no longer available.'
15416-
remediation: 'Do not retry; the resource is permanently gone.'
15417-
retryable: 'no'
1541815350
method_not_supported:
1541915351
http_status: 405
1542015352
summary: 'The HTTP method is not supported for this endpoint.'
@@ -15449,6 +15381,12 @@ x-error-codes:
1544915381
cause: 'The operation targets a request whose expiration has passed. Most endpoints return 400; final-copy/download endpoints return 403.'
1545015382
remediation: 'The request can no longer be acted upon; create a new signature request.'
1545115383
retryable: 'no'
15384+
deleted:
15385+
http_status: 410
15386+
summary: 'The request was cancelled or deleted.'
15387+
cause: 'The resource has been cancelled or removed and is no longer available.'
15388+
remediation: 'Do not retry; the resource is permanently gone.'
15389+
retryable: 'no'
1545215390
x-oauth-error-codes:
1545315391
invalid_grant:
1545415392
http_status:

sdks/dotnet/docs/ErrorResponseError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Contains information about an error that occurred.
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**ErrorMsg** | **string** | Message describing an error. | **ErrorName** | **string** | Name of the error. | **ErrorPath** | **string** | Path at which an error occurred. | [optional]
8+
**ErrorMsg** | **string** | Message describing an error. | **ErrorName** | **string** | Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance. | **ErrorPath** | **string** | Path at which an error occurred. | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

0 commit comments

Comments
 (0)