Skip to content

Commit 2a0596f

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-11216 Update SDK Based on Recent Spec Changes (#120)
* Generate SDK with OpenAPI Generator Version * add unit test --------- Co-authored-by: DX-Bandwidth <dx@bandwidth.com> Co-authored-by: Cameron Koegel <53310569+ckoegel@users.noreply.github.com> Co-authored-by: ckoegel <ckoegel1006@gmail.com>
1 parent 6d9a8f8 commit 2a0596f

4 files changed

Lines changed: 59 additions & 14 deletions

File tree

bandwidth.yml

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6034,12 +6034,30 @@ components:
60346034
description: Reason code for denial.
60356035
type: integer
60366036
example: 511
6037+
denialStatusCodeNullable:
6038+
description: Reason code for denial.
6039+
nullable: true
6040+
type: integer
6041+
example: 511
60376042
resubmitAllowed:
60386043
description: >-
60396044
Whether a Toll-Free Verification request qualifies for resubmission via
60406045
PUT.
60416046
example: true
60426047
type: boolean
6048+
additionalDenialReason:
6049+
type: object
6050+
properties:
6051+
statusCode:
6052+
$ref: '#/components/schemas/denialStatusCode'
6053+
reason:
6054+
$ref: '#/components/schemas/declineReasonDescription'
6055+
resubmitAllowed:
6056+
$ref: '#/components/schemas/resubmitAllowed'
6057+
required:
6058+
- statusCode
6059+
- reason
6060+
- resubmitAllowed
60436061
blocked:
60446062
description: >-
60456063
Whether a Toll-Free Verification is blocked. This attribute will only be
@@ -6194,19 +6212,6 @@ components:
61946212
type: boolean
61956213
description: Indicates whether the content is age-gated.
61966214
example: false
6197-
additionalDenialReason:
6198-
properties:
6199-
statusCode:
6200-
$ref: '#/components/schemas/denialStatusCode'
6201-
reason:
6202-
$ref: '#/components/schemas/declineReasonDescription'
6203-
resubmitAllowed:
6204-
$ref: '#/components/schemas/resubmitAllowed'
6205-
required:
6206-
- statusCode
6207-
- reason
6208-
- resubmitAllowed
6209-
type: object
62106215
internalTicketNumber:
62116216
type: string
62126217
description: >-
@@ -6402,6 +6407,7 @@ components:
64026407
description: >-
64036408
An optional list of denial reasons in addition to
64046409
declineReasonDescription when multiple reasons apply.
6410+
type: array
64056411
items:
64066412
$ref: '#/components/schemas/additionalDenialReason'
64076413
example:
@@ -6411,7 +6417,6 @@ components:
64116417
- statusCode: 513
64126418
reason: Reason B
64136419
resubmitAllowed: true
6414-
type: array
64156420
declineReasonDescription:
64166421
$ref: '#/components/schemas/declineReasonDescription'
64176422
denialStatusCode:
@@ -6779,6 +6784,23 @@ components:
67796784
$ref: '#/components/schemas/internalTicketNumber'
67806785
declineReasonDescription:
67816786
$ref: '#/components/schemas/declineReasonDescription'
6787+
denialStatusCode:
6788+
$ref: '#/components/schemas/denialStatusCodeNullable'
6789+
additionalDenialReasons:
6790+
description: >-
6791+
An optional list of denial reasons in addition to
6792+
declineReasonDescription when multiple reasons apply.
6793+
nullable: true
6794+
type: array
6795+
items:
6796+
$ref: '#/components/schemas/additionalDenialReason'
6797+
example:
6798+
- statusCode: 512
6799+
reason: Reason A
6800+
resubmitAllowed: true
6801+
- statusCode: 513
6802+
reason: Reason B
6803+
resubmitAllowed: true
67826804
resubmitAllowed:
67836805
$ref: '#/components/schemas/resubmitAllowed'
67846806
createdDateTime:

docs/TfvStatus.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
99
**status** | [**TfvStatusEnum**](TfvStatusEnum.md) | | [optional] [default to undefined]
1010
**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. | [optional] [default to undefined]
1111
**declineReasonDescription** | **string** | Explanation for why a verification request was declined. | [optional] [default to undefined]
12+
**denialStatusCode** | **number** | Reason code for denial. | [optional] [default to undefined]
13+
**additionalDenialReasons** | [**Array&lt;AdditionalDenialReason&gt;**](AdditionalDenialReason.md) | An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. | [optional] [default to undefined]
1214
**resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] [default to undefined]
1315
**createdDateTime** | **string** | Date and time the verification request was created. | [optional] [default to undefined]
1416
**modifiedDateTime** | **string** | Date and time the verification request was last modified. | [optional] [default to undefined]
@@ -27,6 +29,8 @@ const instance: TfvStatus = {
2729
status,
2830
internalTicketNumber,
2931
declineReasonDescription,
32+
denialStatusCode,
33+
additionalDenialReasons,
3034
resubmitAllowed,
3135
createdDateTime,
3236
modifiedDateTime,

models/tfv-status.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
*/
1414

1515

16+
// May contain unused imports in some cases
17+
// @ts-ignore
18+
import type { AdditionalDenialReason } from './additional-denial-reason';
1619
// May contain unused imports in some cases
1720
// @ts-ignore
1821
import type { TfvStatusEnum } from './tfv-status-enum';
@@ -34,6 +37,14 @@ export interface TfvStatus {
3437
* Explanation for why a verification request was declined.
3538
*/
3639
'declineReasonDescription'?: string;
40+
/**
41+
* Reason code for denial.
42+
*/
43+
'denialStatusCode'?: number | null;
44+
/**
45+
* An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply.
46+
*/
47+
'additionalDenialReasons'?: Array<AdditionalDenialReason> | null;
3748
/**
3849
* Whether a Toll-Free Verification request qualifies for resubmission via PUT.
3950
*/

tests/unit/models/tfv-status.test.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
import { TfvStatus } from '../../../models/tfv-status';
22
import { TfvStatusEnum } from '../../../models/tfv-status-enum';
33
import { TfvSubmissionInfo } from '../../../models/tfv-submission-info';
4+
import { AdditionalDenialReason } from '../../../models/additional-denial-reason';
45

56
describe('TfvStatus', () => {
67
test('should accept the expected shape', () => {
8+
const denialReason: AdditionalDenialReason = {
9+
statusCode: 1.5,
10+
reason: 'test-reason',
11+
resubmitAllowed: true,
12+
};
713
const fixture: TfvStatus = {
814
phoneNumber: 'test-phoneNumber',
915
status: TfvStatusEnum.Verified,
1016
internalTicketNumber: 'test-internalTicketNumber',
1117
declineReasonDescription: 'test-declineReasonDescription',
18+
denialStatusCode: 123,
19+
additionalDenialReasons: [denialReason],
1220
resubmitAllowed: true,
1321
createdDateTime: 'test-createdDateTime',
1422
modifiedDateTime: 'test-modifiedDateTime',

0 commit comments

Comments
 (0)