Skip to content

SWI-7879 Update SDK Based on Recent Spec Changes #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2025
Merged
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
2 changes: 2 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ docs/AccountStatistics.md
docs/AdditionalDenialReason.md
docs/Address.md
docs/AnswerCallback.md
docs/BlockedWebhook.md
docs/BridgeCompleteCallback.md
docs/BridgeTargetCompleteCallback.md
docs/CallDirectionEnum.md
Expand Down Expand Up @@ -176,6 +177,7 @@ models/account-statistics.ts
models/additional-denial-reason.ts
models/address.ts
models/answer-callback.ts
models/blocked-webhook.ts
models/bridge-complete-callback.ts
models/bridge-target-complete-callback.ts
models/call-direction-enum.ts
Expand Down
36 changes: 26 additions & 10 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5253,17 +5253,17 @@ components:
description: >-
The Toll-Free Verification request privacy policy URL. (Not Available
Until 5/28/2025)
example: http://your-company.com/privacyPolicyUrl.pdf
example: http://your-company.com/privacyPolicy
type: string
termsAndConditionsUrl:
description: >-
The Toll-Free Verification request terms and conditions policy URL. (Not
Available Until 5/28/2025)
example: http://your-company.com/termsAndConditionsUrl.pdf
example: http://your-company.com/termsAndConditions
type: string
businessDBA:
businessDba:
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
example: SecondCompany Name
example: Another Company Name Inc.
type: string
additionalDenialReason:
properties:
Expand Down Expand Up @@ -5349,8 +5349,8 @@ components:
$ref: '#/components/schemas/privacyPolicyUrl'
termsAndConditionsUrl:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDBA:
$ref: '#/components/schemas/businessDBA'
businessDba:
$ref: '#/components/schemas/businessDba'
verificationUpdateRequest:
type: object
required:
Expand Down Expand Up @@ -5388,8 +5388,8 @@ components:
$ref: '#/components/schemas/privacyPolicyUrl'
termsAndConditionsUrl:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDBA:
$ref: '#/components/schemas/businessDBA'
businessDba:
$ref: '#/components/schemas/businessDba'
tfvBasicAuthentication:
type: object
properties:
Expand Down Expand Up @@ -5483,6 +5483,21 @@ components:
$ref: '#/components/schemas/tfvCallbackStatusEnum'
internalTicketNumber:
$ref: '#/components/schemas/internalTicketNumberForWebhook'
blockedWebhook:
type: object
properties:
accountId:
$ref: '#/components/schemas/accountId1'
phoneNumber:
$ref: '#/components/schemas/tfPhoneNumber'
status:
$ref: '#/components/schemas/tfvCallbackStatusEnum'
internalTicketNumber:
$ref: '#/components/schemas/internalTicketNumberForWebhook'
blocked:
$ref: '#/components/schemas/blocked'
blockedReason:
$ref: '#/components/schemas/blockedReason'
tfvSubmissionWrapper:
type: object
properties:
Expand Down Expand Up @@ -5849,8 +5864,8 @@ components:
$ref: '#/components/schemas/privacyPolicyUrl'
termsAndConditionsUrl:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDBA:
$ref: '#/components/schemas/businessDBA'
businessDba:
$ref: '#/components/schemas/businessDba'
tfvStatusEnum:
type: string
enum:
Expand Down Expand Up @@ -7468,6 +7483,7 @@ components:
- $ref: '#/components/schemas/verificationWebhook'
- $ref: '#/components/schemas/verificationDenialWebhook'
- $ref: '#/components/schemas/failureWebhook'
- $ref: '#/components/schemas/blockedWebhook'
webhookSubscriptionRequest:
description: >-
Information about a webhook that Bandwidth should send upon the
Expand Down
30 changes: 30 additions & 0 deletions docs/BlockedWebhook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# BlockedWebhook


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accountId** | **string** | User\'s account ID. | [optional] [default to undefined]
**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined]
**status** | [**TfvCallbackStatusEnum**](TfvCallbackStatusEnum.md) | | [optional] [default to undefined]
**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined]
**blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]

## Example

```typescript
import { BlockedWebhook } from 'bandwidth-sdk';

const instance: BlockedWebhook = {
accountId,
phoneNumber,
status,
internalTicketNumber,
blocked,
blockedReason,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
4 changes: 2 additions & 2 deletions docs/TfvSubmissionInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Name | Type | Description | Notes
**isvReseller** | **string** | ISV name. | [optional] [default to undefined]
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]

## Example

Expand All @@ -35,7 +35,7 @@ const instance: TfvSubmissionInfo = {
isvReseller,
privacyPolicyUrl,
termsAndConditionsUrl,
businessDBA,
businessDba,
};
```

Expand Down
4 changes: 2 additions & 2 deletions docs/VerificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**isvReseller** | **string** | ISV name. | [optional] [default to undefined]
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]

## Example

Expand All @@ -37,7 +37,7 @@ const instance: VerificationRequest = {
isvReseller,
privacyPolicyUrl,
termsAndConditionsUrl,
businessDBA,
businessDba,
};
```

Expand Down
4 changes: 2 additions & 2 deletions docs/VerificationUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Name | Type | Description | Notes
**isvReseller** | **string** | ISV name. | [optional] [default to undefined]
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]

## Example

Expand All @@ -35,7 +35,7 @@ const instance: VerificationUpdateRequest = {
isvReseller,
privacyPolicyUrl,
termsAndConditionsUrl,
businessDBA,
businessDba,
};
```

Expand Down
65 changes: 65 additions & 0 deletions models/blocked-webhook.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/* tslint:disable */
/* eslint-disable */
/**
* Bandwidth
* Bandwidth\'s Communication APIs
*
* The version of the OpenAPI document: 1.0.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/


// May contain unused imports in some cases
// @ts-ignore
import type { TfvCallbackStatusEnum } from './tfv-callback-status-enum';

/**
*
* @export
* @interface BlockedWebhook
*/
export interface BlockedWebhook {
/**
* User\'s account ID.
* @type {string}
* @memberof BlockedWebhook
*/
'accountId'?: string;
/**
* Toll-free telephone number in E.164 format.
* @type {string}
* @memberof BlockedWebhook
*/
'phoneNumber'?: string;
/**
*
* @type {TfvCallbackStatusEnum}
* @memberof BlockedWebhook
*/
'status'?: TfvCallbackStatusEnum;
/**
* Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
* @type {string}
* @memberof BlockedWebhook
*/
'internalTicketNumber'?: string;
/**
* Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
* @type {boolean}
* @memberof BlockedWebhook
*/
'blocked'?: boolean;
/**
* The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
* @type {string}
* @memberof BlockedWebhook
*/
'blockedReason'?: string;
}



1 change: 1 addition & 0 deletions models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ export * from './account-statistics';
export * from './additional-denial-reason';
export * from './address';
export * from './answer-callback';
export * from './blocked-webhook';
export * from './bridge-complete-callback';
export * from './bridge-target-complete-callback';
export * from './call-direction-enum';
Expand Down
2 changes: 1 addition & 1 deletion models/tfv-submission-info.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,6 @@ export interface TfvSubmissionInfo {
* @type {string}
* @memberof TfvSubmissionInfo
*/
'businessDBA'?: string;
'businessDba'?: string;
}

2 changes: 1 addition & 1 deletion models/verification-request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,6 @@ export interface VerificationRequest {
* @type {string}
* @memberof VerificationRequest
*/
'businessDBA'?: string;
'businessDba'?: string;
}

2 changes: 1 addition & 1 deletion models/verification-update-request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,6 @@ export interface VerificationUpdateRequest {
* @type {string}
* @memberof VerificationUpdateRequest
*/
'businessDBA'?: string;
'businessDba'?: string;
}