bandwidth-sdk 7.2.0 → 7.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +1 -0
  3. package/api/messages-api.ts +4 -4
  4. package/bandwidth.yml +127 -35
  5. package/configuration.ts +1 -1
  6. package/coverage/clover.xml +11 -6
  7. package/coverage/coverage-final.json +4 -3
  8. package/coverage/lcov-report/index.html +7 -7
  9. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
  10. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  11. package/coverage/lcov-report/node-sdk/api/index.html +1 -1
  12. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
  13. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +5 -5
  14. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  15. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +1 -1
  16. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  17. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
  18. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +1 -1
  20. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
  21. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  22. package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
  23. package/coverage/lcov-report/node-sdk/common.ts.html +2 -2
  24. package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
  25. package/coverage/lcov-report/node-sdk/index.html +1 -1
  26. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +2 -2
  27. package/coverage/lcov-report/node-sdk/models/business-registration-issuing-country-enum.ts.html +205 -0
  28. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +52 -4
  29. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  30. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  31. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  32. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  35. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +1 -1
  75. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/index.html +20 -5
  79. package/coverage/lcov-report/node-sdk/models/index.ts.html +7 -4
  80. package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
  82. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  83. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  84. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  85. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  86. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  87. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
  88. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
  89. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +1 -1
  90. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
  91. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
  92. package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +1 -1
  93. package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +1 -1
  94. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  95. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  96. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
  97. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +1 -1
  98. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
  99. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
  100. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
  101. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
  102. package/coverage/lcov.info +16 -5
  103. package/dist/api/messages-api.d.ts +4 -4
  104. package/dist/api/messages-api.js +4 -4
  105. package/dist/configuration.js +1 -1
  106. package/dist/models/business-entity-type-enum.d.ts +1 -1
  107. package/dist/models/business-entity-type-enum.js +1 -1
  108. package/dist/models/business-registration-issuing-country-enum.d.ts +30 -0
  109. package/dist/models/business-registration-issuing-country-enum.js +34 -0
  110. package/dist/models/business-registration-type-enum.d.ts +17 -1
  111. package/dist/models/business-registration-type-enum.js +18 -2
  112. package/dist/models/index.d.ts +1 -0
  113. package/dist/models/index.js +1 -0
  114. package/dist/models/rbm-message-media.d.ts +1 -1
  115. package/dist/models/tfv-status.d.ts +1 -1
  116. package/dist/models/tfv-submission-info.d.ts +4 -2
  117. package/dist/models/verification-request.d.ts +5 -3
  118. package/dist/models/verification-update-request.d.ts +5 -3
  119. package/docs/BusinessEntityTypeEnum.md +1 -1
  120. package/docs/BusinessRegistrationIssuingCountryEnum.md +33 -0
  121. package/docs/BusinessRegistrationTypeEnum.md +33 -1
  122. package/docs/MessagesApi.md +3 -2
  123. package/docs/MultiChannelChannelListRBMObjectAllOfContent.md +1 -1
  124. package/docs/RbmMessageMedia.md +1 -1
  125. package/docs/TfvStatus.md +1 -1
  126. package/docs/TfvSubmissionInfo.md +3 -1
  127. package/docs/VerificationRequest.md +5 -3
  128. package/docs/VerificationUpdateRequest.md +4 -2
  129. package/models/business-entity-type-enum.ts +1 -1
  130. package/models/business-registration-issuing-country-enum.ts +40 -0
  131. package/models/business-registration-type-enum.ts +18 -2
  132. package/models/index.ts +1 -0
  133. package/models/rbm-message-media.ts +1 -1
  134. package/models/tfv-status.ts +1 -1
  135. package/models/tfv-submission-info.ts +6 -2
  136. package/models/verification-request.ts +7 -3
  137. package/models/verification-update-request.ts +7 -3
  138. package/package.json +1 -1
  139. package/tests/smoke/multi-channel-api.test.ts +240 -4
  140. package/tests/unit/api/toll-free-verification-api.test.ts +2 -1
  141. package/tests/unit/models/business-registration-issuing-country-enum.test.ts +19 -0
  142. package/tests/unit/models/business-registration-type-enum.test.ts +16 -0
@@ -24,6 +24,7 @@ docs/BlockedWebhook.md
24
24
  docs/BridgeCompleteCallback.md
25
25
  docs/BridgeTargetCompleteCallback.md
26
26
  docs/BusinessEntityTypeEnum.md
27
+ docs/BusinessRegistrationIssuingCountryEnum.md
27
28
  docs/BusinessRegistrationTypeEnum.md
28
29
  docs/CallDirectionEnum.md
29
30
  docs/CallRecordingMetadata.md
@@ -213,6 +214,7 @@ models/blocked-webhook.ts
213
214
  models/bridge-complete-callback.ts
214
215
  models/bridge-target-complete-callback.ts
215
216
  models/business-entity-type-enum.ts
217
+ models/business-registration-issuing-country-enum.ts
216
218
  models/business-registration-type-enum.ts
217
219
  models/call-direction-enum.ts
218
220
  models/call-recording-metadata.ts
package/README.md CHANGED
@@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
169
169
  - [BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
170
170
  - [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
171
171
  - [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
172
+ - [BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md)
172
173
  - [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
173
174
  - [CallDirectionEnum](docs/CallDirectionEnum.md)
174
175
  - [CallRecordingMetadata](docs/CallRecordingMetadata.md)
@@ -93,7 +93,7 @@ export const MessagesApiAxiosParamCreator = function (configuration?: Configurat
93
93
  };
94
94
  },
95
95
  /**
96
- * Returns a list of messages based on query parameters.
96
+ * Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
97
97
  * @summary List Messages
98
98
  * @param {string} accountId Your Bandwidth Account ID.
99
99
  * @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
@@ -293,7 +293,7 @@ export const MessagesApiFp = function(configuration?: Configuration) {
293
293
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
294
294
  },
295
295
  /**
296
- * Returns a list of messages based on query parameters.
296
+ * Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
297
297
  * @summary List Messages
298
298
  * @param {string} accountId Your Bandwidth Account ID.
299
299
  * @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
@@ -353,7 +353,7 @@ export const MessagesApiFactory = function (configuration?: Configuration, baseP
353
353
  return localVarFp.createMessage(accountId, messageRequest, options).then((request) => request(axios, basePath));
354
354
  },
355
355
  /**
356
- * Returns a list of messages based on query parameters.
356
+ * Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
357
357
  * @summary List Messages
358
358
  * @param {string} accountId Your Bandwidth Account ID.
359
359
  * @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
@@ -409,7 +409,7 @@ export class MessagesApi extends BaseAPI {
409
409
  }
410
410
 
411
411
  /**
412
- * Returns a list of messages based on query parameters.
412
+ * Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
413
413
  * @summary List Messages
414
414
  * @param {string} accountId Your Bandwidth Account ID.
415
415
  * @param {string} [messageId] The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
package/bandwidth.yml CHANGED
@@ -163,7 +163,13 @@ paths:
163
163
  /users/{accountId}/messages:
164
164
  get:
165
165
  summary: List Messages
166
- description: Returns a list of messages based on query parameters.
166
+ description: >
167
+ Returns a list of messages based on query parameters.
168
+
169
+
170
+ **Rate Limit:** This endpoint is rate limited to 3500 requests per 5
171
+ minutes per Source IP address. Exceeding the limit returns HTTP 429 with
172
+ a `Retry-After` header.
167
173
  operationId: listMessages
168
174
  tags:
169
175
  - Messages
@@ -207,10 +213,12 @@ paths:
207
213
  $ref: '#/components/responses/messagingForbiddenError'
208
214
  '404':
209
215
  $ref: '#/components/responses/messagingNotFoundError'
216
+ '405':
217
+ $ref: '#/components/responses/messagingMethodNotAllowedError'
210
218
  '415':
211
219
  $ref: '#/components/responses/messagingInvalidMediaTypeError'
212
220
  '429':
213
- $ref: '#/components/responses/messagingTooManyRequestsError'
221
+ $ref: '#/components/responses/listMessagesTooManyRequestsError'
214
222
  '500':
215
223
  $ref: '#/components/responses/messagingInternalServerError'
216
224
  post:
@@ -1476,7 +1484,7 @@ paths:
1476
1484
  $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest'
1477
1485
  responses:
1478
1486
  '202':
1479
- description: Accepted
1487
+ $ref: '#/components/responses/verifyPutResponse'
1480
1488
  '400':
1481
1489
  $ref: '#/components/responses/tfvPostBadRequestResponse'
1482
1490
  '401':
@@ -2257,7 +2265,9 @@ components:
2257
2265
  type: object
2258
2266
  properties:
2259
2267
  media:
2260
- $ref: '#/components/schemas/rbmMessageContentFile'
2268
+ type: array
2269
+ items:
2270
+ $ref: '#/components/schemas/rbmMessageContentFile'
2261
2271
  suggestions:
2262
2272
  $ref: '#/components/schemas/multiChannelFullActions'
2263
2273
  required:
@@ -5818,38 +5828,106 @@ components:
5818
5828
  type: string
5819
5829
  businessRegistrationNumber:
5820
5830
  type: string
5821
- description: >-
5822
- US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
5823
- until early 2026. If a value is provided for this field, a value must be
5824
- provided for `businessRegistrationType` and `businessEntityType`.
5825
- Available starting October 1st, 2025.
5831
+ description: Government-issued business identifying number.
5826
5832
  nullable: true
5827
5833
  maxLength: 500
5828
5834
  example: 12-3456789
5829
5835
  businessRegistrationTypeEnum:
5830
5836
  type: string
5831
- description: >-
5832
- The type of business registration number. Optional until early 2026;
5833
- required if `businessRegistrationNumber` is provided. Available starting
5834
- October 1st, 2025.
5837
+ description: The type of business registration number.
5835
5838
  enum:
5836
5839
  - EIN
5837
5840
  - CBN
5841
+ - NEQ
5842
+ - PROVINCIAL_NUMBER
5843
+ - CRN
5844
+ - VAT
5845
+ - ACN
5846
+ - ABN
5847
+ - BRN
5848
+ - SIREN
5849
+ - SIRET
5850
+ - NZBN
5851
+ - UST_IDNR
5852
+ - CIF
5853
+ - NIF
5854
+ - CNPJ
5855
+ - UID
5856
+ - OTHER
5838
5857
  nullable: true
5858
+ businessRegistrationIssuingCountryEnum:
5859
+ type: string
5860
+ description: >-
5861
+ The country issuing the business registration in ISO-3166-1 alpha-3
5862
+ format.
5863
+
5864
+
5865
+ | Registration Type | Supported Countries |
5866
+
5867
+ |----------------------|------------------------------------|
5868
+
5869
+ | EIN | USA |
5870
+
5871
+ | CBN | CAN |
5872
+
5873
+ | NEQ | CAN |
5874
+
5875
+ | PROVINCIAL_NUMBER | CAN |
5876
+
5877
+ | CRN | GBR, HKG |
5878
+
5879
+ | VAT | GBR, IRL, BRA, NLD |
5880
+
5881
+ | ACN | AUS |
5882
+
5883
+ | ABN | AUS |
5884
+
5885
+ | BRN | HKG |
5886
+
5887
+ | SIREN | FRA |
5888
+
5889
+ | SIRET | FRA |
5890
+
5891
+ | NZBN | NZL |
5892
+
5893
+ | UST_IDNR | DEU |
5894
+
5895
+ | CIF | ESP |
5896
+
5897
+ | NIF | ESP |
5898
+
5899
+ | CNPJ | BRA |
5900
+
5901
+ | UID | CHE |
5902
+
5903
+ | OTHER | Must Provide Country Code |
5904
+ enum:
5905
+ - USA
5906
+ - CAN
5907
+ - HKG
5908
+ - GBR
5909
+ - IRL
5910
+ - BRA
5911
+ - NLD
5912
+ - AUS
5913
+ - FRA
5914
+ - NZL
5915
+ - DEU
5916
+ - ESP
5917
+ - CHE
5918
+ nullable: false
5839
5919
  businessEntityTypeEnum:
5840
5920
  type: string
5841
5921
  description: >-
5842
5922
  The type of registered business. If no option is applicable, please
5843
- provide "SOLE_PROPRIETOR" as a value. Optional until early 2026;
5844
- required if `businessRegistrationNumber` is provided. Available starting
5845
- October 1st, 2025.
5923
+ provide "SOLE_PROPRIETOR" as a value.
5846
5924
  enum:
5847
5925
  - SOLE_PROPRIETOR
5848
5926
  - PRIVATE_PROFIT
5849
5927
  - PUBLIC_PROFIT
5850
5928
  - NON_PROFIT
5851
5929
  - GOVERNMENT
5852
- nullable: true
5930
+ nullable: false
5853
5931
  helpMessageResponse:
5854
5932
  type: string
5855
5933
  description: A message that gets sent to users requesting help.
@@ -5875,7 +5953,6 @@ components:
5875
5953
  type: object
5876
5954
  internalTicketNumber:
5877
5955
  type: string
5878
- format: uuid
5879
5956
  description: >-
5880
5957
  Unique identifier (UUID) generated by Bandwidth to assist in tracking
5881
5958
  the verification status of a toll-free number - included in all webhook
@@ -5883,7 +5960,6 @@ components:
5883
5960
  example: acde070d-8c4c-4f0d-9d8a-162843c10333
5884
5961
  internalTicketNumberForWebhook:
5885
5962
  type: string
5886
- format: uuid
5887
5963
  description: >-
5888
5964
  Unique identifier (UUID) generated by Bandwidth to assist in tracking
5889
5965
  the verification status of a toll-free number.
@@ -5906,6 +5982,7 @@ components:
5906
5982
  - useCaseSummary
5907
5983
  - productionMessageContent
5908
5984
  - optInWorkflow
5985
+ - businessEntityType
5909
5986
  properties:
5910
5987
  businessAddress:
5911
5988
  $ref: '#/components/schemas/address'
@@ -5950,6 +6027,8 @@ components:
5950
6027
  $ref: '#/components/schemas/businessRegistrationNumber'
5951
6028
  businessRegistrationType:
5952
6029
  $ref: '#/components/schemas/businessRegistrationTypeEnum'
6030
+ businessRegistrationIssuingCountry:
6031
+ $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
5953
6032
  businessEntityType:
5954
6033
  $ref: '#/components/schemas/businessEntityTypeEnum'
5955
6034
  helpMessageResponse:
@@ -5957,7 +6036,7 @@ components:
5957
6036
  ageGatedContent:
5958
6037
  $ref: '#/components/schemas/ageGatedContent'
5959
6038
  cvToken:
5960
- $ref: '#/components/schemas/cvToken'
6039
+ $ref: '#/components/schemas/cvTokenNullable'
5961
6040
  verificationUpdateRequest:
5962
6041
  type: object
5963
6042
  required:
@@ -6003,12 +6082,14 @@ components:
6003
6082
  $ref: '#/components/schemas/businessRegistrationTypeEnum'
6004
6083
  businessEntityType:
6005
6084
  $ref: '#/components/schemas/businessEntityTypeEnum'
6085
+ businessRegistrationIssuingCountry:
6086
+ $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6006
6087
  helpMessageResponse:
6007
6088
  $ref: '#/components/schemas/helpMessageResponse'
6008
6089
  ageGatedContent:
6009
6090
  $ref: '#/components/schemas/ageGatedContent'
6010
6091
  cvToken:
6011
- $ref: '#/components/schemas/cvToken'
6092
+ $ref: '#/components/schemas/cvTokenNullable'
6012
6093
  tfvBasicAuthentication:
6013
6094
  type: object
6014
6095
  properties:
@@ -6461,7 +6542,7 @@ components:
6461
6542
  blockedReason:
6462
6543
  $ref: '#/components/schemas/blockedReason'
6463
6544
  cvToken:
6464
- $ref: '#/components/schemas/cvToken'
6545
+ $ref: '#/components/schemas/cvTokenNullable'
6465
6546
  tfvSubmissionInfo:
6466
6547
  type: object
6467
6548
  properties:
@@ -6495,20 +6576,12 @@ components:
6495
6576
  $ref: '#/components/schemas/businessDba'
6496
6577
  businessRegistrationNumber:
6497
6578
  $ref: '#/components/schemas/businessRegistrationNumber'
6498
- description: >-
6499
- US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
6500
- Available starting October 1st, 2025.
6501
6579
  businessRegistrationType:
6502
6580
  $ref: '#/components/schemas/businessRegistrationTypeEnum'
6503
- description: >-
6504
- The type of business registration number. Available starting October
6505
- 1st, 2025.
6581
+ businessRegistrationIssuingCountry:
6582
+ $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6506
6583
  businessEntityType:
6507
6584
  $ref: '#/components/schemas/businessEntityTypeEnum'
6508
- description: >-
6509
- The type of registered business. If no option is applicable, please
6510
- provide "SOLE_PROPRIETOR" as a value. Available starting October
6511
- 1st, 2025.
6512
6585
  tfvStatusEnum:
6513
6586
  type: string
6514
6587
  enum:
@@ -6526,13 +6599,13 @@ components:
6526
6599
  nullable: true
6527
6600
  pattern: ^[ -~]{16,64}$
6528
6601
  type: string
6529
- cvToken:
6602
+ cvTokenNullable:
6530
6603
  type: string
6531
6604
  description: >-
6532
6605
  The token provided by Campaign Verify to validate your political use
6533
6606
  case. Only required for 527 political organizations. If you are not a
6534
- 527 political organization, this field should be omitted. If you pass an
6535
- empty string, it will be passed along and potentially rejected.
6607
+ 527 political organization, this field should be omitted. Supplying an
6608
+ empty string will likely result in rejection.
6536
6609
  minLength: 0
6537
6610
  maxLength: 500
6538
6611
  nullable: true
@@ -6752,6 +6825,23 @@ components:
6752
6825
  - type: internal-server-error
6753
6826
  description: Internal server error. No further information available
6754
6827
  source: {}
6828
+ listMessagesTooManyRequestsError:
6829
+ description: Too Many Requests
6830
+ headers:
6831
+ Retry-After:
6832
+ description: The number of seconds to wait before retrying the request.
6833
+ schema:
6834
+ type: integer
6835
+ example: 300
6836
+ content:
6837
+ application/json:
6838
+ schema:
6839
+ $ref: '#/components/schemas/messagingRequestError'
6840
+ example:
6841
+ type: rate_limit_exceeded
6842
+ description: >-
6843
+ Rate limit exceeded. Wait for Retry-After time before sending
6844
+ another request.
6755
6845
  createCallResponse:
6756
6846
  description: Created
6757
6847
  headers:
@@ -7189,6 +7279,8 @@ components:
7189
7279
  example:
7190
7280
  description: Service Unavailable Error.
7191
7281
  type: Service Unavailable
7282
+ verifyPutResponse:
7283
+ description: Accepted
7192
7284
  parameters:
7193
7285
  accountId:
7194
7286
  in: path
package/configuration.ts CHANGED
@@ -141,7 +141,7 @@ export class Configuration {
141
141
  ...param.baseOptions,
142
142
  headers: {
143
143
  ...param.baseOptions?.headers,
144
- 'User-Agent': "OpenAPI-Generator/7.2.0/typescript-axios"
144
+ 'User-Agent': "OpenAPI-Generator/7.4.0/typescript-axios"
145
145
  },
146
146
  };
147
147
  this.formDataCtor = param.formDataCtor;
@@ -1,7 +1,7 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <coverage generated="1769543123072" clover="3.2.0">
3
- <project timestamp="1769543123072" name="All files">
4
- <metrics statements="1970" coveredstatements="1807" conditionals="1466" coveredconditionals="1055" methods="497" coveredmethods="378" elements="3933" coveredelements="3240" complexity="0" loc="1970" ncloc="1970" packages="5" files="87" classes="87"/>
2
+ <coverage generated="1771970235450" clover="3.2.0">
3
+ <project timestamp="1771970235450" name="All files">
4
+ <metrics statements="1972" coveredstatements="1809" conditionals="1466" coveredconditionals="1055" methods="497" coveredmethods="378" elements="3935" coveredelements="3242" complexity="0" loc="1972" ncloc="1972" packages="5" files="88" classes="88"/>
5
5
  <package name="node-sdk">
6
6
  <metrics statements="108" coveredstatements="85" conditionals="91" coveredconditionals="52" methods="23" coveredmethods="20"/>
7
7
  <file name="api.ts" path="/home/runner/work/node-sdk/node-sdk/api.ts">
@@ -83,7 +83,7 @@
83
83
  <line num="97" count="23" type="stmt"/>
84
84
  <line num="98" count="23" type="cond" truecount="5" falsecount="0"/>
85
85
  <line num="101" count="23" type="cond" truecount="2" falsecount="0"/>
86
- <line num="102" count="139" type="cond" truecount="3" falsecount="1"/>
86
+ <line num="102" count="140" type="cond" truecount="3" falsecount="1"/>
87
87
  <line num="106" count="11" type="stmt"/>
88
88
  <line num="107" count="55" type="stmt"/>
89
89
  <line num="110" count="11" type="stmt"/>
@@ -1601,11 +1601,15 @@
1601
1601
  </file>
1602
1602
  </package>
1603
1603
  <package name="node-sdk.models">
1604
- <metrics statements="213" coveredstatements="213" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
1604
+ <metrics statements="215" coveredstatements="215" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
1605
1605
  <file name="business-entity-type-enum.ts" path="/home/runner/work/node-sdk/node-sdk/models/business-entity-type-enum.ts">
1606
1606
  <metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
1607
1607
  <line num="21" count="9" type="stmt"/>
1608
1608
  </file>
1609
+ <file name="business-registration-issuing-country-enum.ts" path="/home/runner/work/node-sdk/node-sdk/models/business-registration-issuing-country-enum.ts">
1610
+ <metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
1611
+ <line num="21" count="9" type="stmt"/>
1612
+ </file>
1609
1613
  <file name="business-registration-type-enum.ts" path="/home/runner/work/node-sdk/node-sdk/models/business-registration-type-enum.ts">
1610
1614
  <metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
1611
1615
  <line num="21" count="9" type="stmt"/>
@@ -1659,7 +1663,7 @@
1659
1663
  <line num="21" count="9" type="stmt"/>
1660
1664
  </file>
1661
1665
  <file name="index.ts" path="/home/runner/work/node-sdk/node-sdk/models/index.ts">
1662
- <metrics statements="177" coveredstatements="177" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
1666
+ <metrics statements="178" coveredstatements="178" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>
1663
1667
  <line num="1" count="8" type="stmt"/>
1664
1668
  <line num="2" count="8" type="stmt"/>
1665
1669
  <line num="3" count="8" type="stmt"/>
@@ -1837,6 +1841,7 @@
1837
1841
  <line num="175" count="8" type="stmt"/>
1838
1842
  <line num="176" count="8" type="stmt"/>
1839
1843
  <line num="177" count="8" type="stmt"/>
1844
+ <line num="178" count="8" type="stmt"/>
1840
1845
  </file>
1841
1846
  <file name="latest-message-delivery-status-enum.ts" path="/home/runner/work/node-sdk/node-sdk/models/latest-message-delivery-status-enum.ts">
1842
1847
  <metrics statements="1" coveredstatements="1" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0"/>