bandwidth-sdk 17.1.1 → 17.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd76cc98439fafb3ac66d351ab751eb98999d4e9112f6f9af72d88e37dcfeb27
-  data.tar.gz: 1422e600c22dddfa5a43cfa3bad323b64b8ee4725e24104c64bcb2554401717a
+  metadata.gz: c104607d4f93290aee6b7f6ddfae1b763e704869b461f9782a177630581a7b8b
+  data.tar.gz: 6e171382371ce86dd1685689a4d7bcb360e3f4232778b364e95117b0958cbe09
 SHA512:
-  metadata.gz: fc46be7d44dd35866c10f228c4d586dd7f37fa1d09fc5332fddd3a91d2f3c1e386c49678d0eaee3fb0841142a1f0aeb494a658a224a120a69cd124d1e0865fea
-  data.tar.gz: 91ec006f401c8b7a689ad8407b2d2225affff3d0ac1a7fca8c71ed1d4e332d026e713472b69db21efcf77a4439dc3b00104b4eabac5354f7d2dfbf75228b64a0
+  metadata.gz: 2492c79aa0113a31f75022987fa1e7a8be31c50960cfae79ff8efe35020bec55152b0b2d67137a1e732508bcf2f1dc455d9bfe14c41c4027995bf577db2c9097
+  data.tar.gz: 5f83bd244d36a7ced37bd7ff78d77286a1addae8a74f4f3640660953bb6d67e9d5d41b8b4460f6875187769aff19f166400599be33f0ef06585ad7fbba372fb2

data/Gemfile

@@ -5,6 +5,6 @@ gemspec
 group :development, :test do
   gem 'rake', '~> 13.2.1'
   gem 'pry-byebug'
-  gem 'rubocop', '~> 1.52.0'
+  gem 'rubocop', '~> 1.82.0'
   gem 'simplecov', '~> 0.21.2'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bandwidth-sdk (17.1.1)
+    bandwidth-sdk (17.3.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
       marcel
@@ -17,7 +17,7 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.6.2)
     docile (1.4.1)
-    faraday (2.14.0)
+    faraday (2.14.1)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
@@ -26,7 +26,9 @@ GEM
     faraday-net_http (3.4.2)
       net-http (~> 0.5)
     io-console (0.8.2)
-    json (2.18.0)
+    json (2.18.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     logger (1.7.0)
     marcel (1.1.0)
     method_source (1.1.0)
@@ -36,10 +38,10 @@ GEM
     ox (2.14.23)
       bigdecimal (>= 3.0)
     parallel (1.27.0)
-    parser (3.3.10.1)
+    parser (3.3.10.2)
       ast (~> 2.4.1)
       racc
-    prism (1.8.0)
+    prism (1.9.0)
     pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -53,7 +55,6 @@ GEM
     regexp_parser (2.11.3)
     reline (0.6.3)
       io-console (~> 0.5)
-    rexml (3.4.4)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -66,17 +67,18 @@ GEM
     rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
-    rubocop (1.52.1)
+    rspec-support (3.13.7)
+    rubocop (1.82.1)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
     rubocop-ast (1.49.0)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
@@ -87,7 +89,9 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.6.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
     uri (1.1.1)
 
 PLATFORMS
@@ -99,7 +103,7 @@ DEPENDENCIES
   pry-byebug
   rake (~> 13.2.1)
   rspec (~> 3.6, >= 3.6.0)
-  rubocop (~> 1.52.0)
+  rubocop (~> 1.82.0)
   simplecov (~> 0.21.2)
 
 BUNDLED WITH

data/README.md

@@ -180,6 +180,7 @@ Class | Method | HTTP request | Description
  - [Bandwidth::BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
  - [Bandwidth::BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
  - [Bandwidth::BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
+ - [Bandwidth::BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md)
  - [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
  - [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md)
  - [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)

data/bandwidth.yml

@@ -163,7 +163,13 @@ paths:
   /users/{accountId}/messages:
     get:
       summary: List Messages
-      description: Returns a list of messages based on query parameters.
+      description: >
+        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.
       operationId: listMessages
       tags:
         - Messages
@@ -207,10 +213,12 @@ paths:
           $ref: '#/components/responses/messagingForbiddenError'
         '404':
           $ref: '#/components/responses/messagingNotFoundError'
+        '405':
+          $ref: '#/components/responses/messagingMethodNotAllowedError'
         '415':
           $ref: '#/components/responses/messagingInvalidMediaTypeError'
         '429':
-          $ref: '#/components/responses/messagingTooManyRequestsError'
+          $ref: '#/components/responses/listMessagesTooManyRequestsError'
         '500':
           $ref: '#/components/responses/messagingInternalServerError'
     post:
@@ -1476,7 +1484,7 @@ paths:
         $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest'
       responses:
         '202':
-          description: Accepted
+          $ref: '#/components/responses/verifyPutResponse'
         '400':
           $ref: '#/components/responses/tfvPostBadRequestResponse'
         '401':
@@ -2257,7 +2265,9 @@ components:
       type: object
       properties:
         media:
-          $ref: '#/components/schemas/rbmMessageContentFile'
+          type: array
+          items:
+            $ref: '#/components/schemas/rbmMessageContentFile'
         suggestions:
           $ref: '#/components/schemas/multiChannelFullActions'
       required:
@@ -5818,38 +5828,106 @@ components:
       type: string
     businessRegistrationNumber:
       type: string
-      description: >-
-        US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
-        until early 2026. If a value is provided for this field, a value must be
-        provided for `businessRegistrationType` and `businessEntityType`.
-        Available starting October 1st, 2025.
+      description: Government-issued business identifying number.
       nullable: true
       maxLength: 500
       example: 12-3456789
     businessRegistrationTypeEnum:
       type: string
-      description: >-
-        The type of business registration number. Optional until early 2026;
-        required if `businessRegistrationNumber` is provided. Available starting
-        October 1st, 2025.
+      description: The type of business registration number.
       enum:
         - EIN
         - CBN
+        - NEQ
+        - PROVINCIAL_NUMBER
+        - CRN
+        - VAT
+        - ACN
+        - ABN
+        - BRN
+        - SIREN
+        - SIRET
+        - NZBN
+        - UST_IDNR
+        - CIF
+        - NIF
+        - CNPJ
+        - UID
+        - OTHER
       nullable: true
+    businessRegistrationIssuingCountryEnum:
+      type: string
+      description: >-
+        The country issuing the business registration in ISO-3166-1 alpha-3
+        format.
+
+
+        | Registration Type     | Supported Countries                |
+
+        |----------------------|------------------------------------|
+
+        | EIN                  | USA                                |
+
+        | CBN                  | CAN                                |
+
+        | NEQ                  | CAN                                |
+
+        | PROVINCIAL_NUMBER    | CAN                                |
+
+        | CRN                  | GBR, HKG                           |
+
+        | VAT                  | GBR, IRL, BRA, NLD                 |
+
+        | ACN                  | AUS                                |
+
+        | ABN                  | AUS                                |
+
+        | BRN                  | HKG                                |
+
+        | SIREN                | FRA                                |
+
+        | SIRET                | FRA                                |
+
+        | NZBN                 | NZL                                |
+
+        | UST_IDNR             | DEU                                |
+
+        | CIF                  | ESP                                |
+
+        | NIF                  | ESP                                |
+
+        | CNPJ                 | BRA                                |
+
+        | UID                  | CHE                                |
+
+        | OTHER                | Must Provide Country Code          |
+      enum:
+        - USA
+        - CAN
+        - HKG
+        - GBR
+        - IRL
+        - BRA
+        - NLD
+        - AUS
+        - FRA
+        - NZL
+        - DEU
+        - ESP
+        - CHE
+      nullable: false
     businessEntityTypeEnum:
       type: string
       description: >-
         The type of registered business. If no option is applicable, please
-        provide "SOLE_PROPRIETOR" as a value. Optional until early 2026;
-        required if `businessRegistrationNumber` is provided. Available starting
-        October 1st, 2025.
+        provide "SOLE_PROPRIETOR" as a value.
       enum:
         - SOLE_PROPRIETOR
         - PRIVATE_PROFIT
         - PUBLIC_PROFIT
         - NON_PROFIT
         - GOVERNMENT
-      nullable: true
+      nullable: false
     helpMessageResponse:
       type: string
       description: A message that gets sent to users requesting help.
@@ -5875,7 +5953,6 @@ components:
       type: object
     internalTicketNumber:
       type: string
-      format: uuid
       description: >-
         Unique identifier (UUID) generated by Bandwidth to assist in tracking
         the verification status of a toll-free number - included in all webhook
@@ -5883,7 +5960,6 @@ components:
       example: acde070d-8c4c-4f0d-9d8a-162843c10333
     internalTicketNumberForWebhook:
       type: string
-      format: uuid
       description: >-
         Unique identifier (UUID) generated by Bandwidth to assist in tracking
         the verification status of a toll-free number.
@@ -5906,6 +5982,7 @@ components:
         - useCaseSummary
         - productionMessageContent
         - optInWorkflow
+        - businessEntityType
       properties:
         businessAddress:
           $ref: '#/components/schemas/address'
@@ -5950,12 +6027,16 @@ components:
           $ref: '#/components/schemas/businessRegistrationNumber'
         businessRegistrationType:
           $ref: '#/components/schemas/businessRegistrationTypeEnum'
+        businessRegistrationIssuingCountry:
+          $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
         businessEntityType:
           $ref: '#/components/schemas/businessEntityTypeEnum'
         helpMessageResponse:
           $ref: '#/components/schemas/helpMessageResponse'
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
+        cvToken:
+          $ref: '#/components/schemas/cvTokenNullable'
     verificationUpdateRequest:
       type: object
       required:
@@ -6001,10 +6082,14 @@ components:
           $ref: '#/components/schemas/businessRegistrationTypeEnum'
         businessEntityType:
           $ref: '#/components/schemas/businessEntityTypeEnum'
+        businessRegistrationIssuingCountry:
+          $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
         helpMessageResponse:
           $ref: '#/components/schemas/helpMessageResponse'
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
+        cvToken:
+          $ref: '#/components/schemas/cvTokenNullable'
     tfvBasicAuthentication:
       type: object
       properties:
@@ -6456,6 +6541,8 @@ components:
           $ref: '#/components/schemas/blocked'
         blockedReason:
           $ref: '#/components/schemas/blockedReason'
+        cvToken:
+          $ref: '#/components/schemas/cvTokenNullable'
     tfvSubmissionInfo:
       type: object
       properties:
@@ -6489,20 +6576,12 @@ components:
           $ref: '#/components/schemas/businessDba'
         businessRegistrationNumber:
           $ref: '#/components/schemas/businessRegistrationNumber'
-          description: >-
-            US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
-            Available starting October 1st, 2025.
         businessRegistrationType:
           $ref: '#/components/schemas/businessRegistrationTypeEnum'
-          description: >-
-            The type of business registration number. Available starting October
-            1st, 2025.
+        businessRegistrationIssuingCountry:
+          $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
         businessEntityType:
           $ref: '#/components/schemas/businessEntityTypeEnum'
-          description: >-
-            The type of registered business. If no option is applicable, please
-            provide "SOLE_PROPRIETOR" as a value. Available starting October
-            1st, 2025.
     tfvStatusEnum:
       type: string
       enum:
@@ -6520,6 +6599,18 @@ components:
       nullable: true
       pattern: ^[ -~]{16,64}$
       type: string
+    cvTokenNullable:
+      type: string
+      description: >-
+        The token provided by Campaign Verify to validate your political use
+        case. Only required for 527 political organizations. If you are not a
+        527 political organization, this field should be omitted. Supplying an
+        empty string will likely result in rejection.
+      minLength: 0
+      maxLength: 500
+      nullable: true
+      example: >-
+        cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
   responses:
     createMessageResponse:
       description: Accepted
@@ -6734,6 +6825,23 @@ components:
               - type: internal-server-error
                 description: Internal server error. No further information available
                 source: {}
+    listMessagesTooManyRequestsError:
+      description: Too Many Requests
+      headers:
+        Retry-After:
+          description: The number of seconds to wait before retrying the request.
+          schema:
+            type: integer
+            example: 300
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/messagingRequestError'
+          example:
+            type: rate_limit_exceeded
+            description: >-
+              Rate limit exceeded. Wait for Retry-After time before sending
+              another request.
     createCallResponse:
       description: Created
       headers:
@@ -7171,6 +7279,8 @@ components:
           example:
             description: Service Unavailable Error.
             type: Service Unavailable
+    verifyPutResponse:
+      description: Accepted
   parameters:
     accountId:
       in: path

data/coverage/.resultset.json

@@ -199,6 +199,7 @@
           1,
           1,
           1,
+          1,
           null,
           null,
           1,
@@ -795,13 +796,13 @@
           null,
           null,
           1,
-          438,
+          444,
           null,
           45,
           null,
           8,
           null,
-          264,
+          267,
           null,
           21,
           null,
@@ -828,8 +829,8 @@
           null,
           null,
           null,
-          82,
-          82,
+          85,
+          85,
           null,
           null,
           null,
@@ -850,16 +851,16 @@
           null,
           null,
           1,
-          203,
+          211,
           20,
-          194,
+          202,
           5,
           14,
           null,
-          189,
+          197,
           10,
           null,
-          179,
+          187,
           null,
           null,
           null,
@@ -8606,6 +8607,10 @@
           null,
           null,
           null,
+          null,
+          null,
+          null,
+          null,
           6,
           8,
           null,
@@ -8692,6 +8697,10 @@
           1,
           1,
           1,
+          1,
+          1,
+          1,
+          1,
           null,
           null,
           1,
@@ -11658,6 +11667,6 @@
         ]
       }
     },
-    "timestamp": 1769537437
+    "timestamp": 1771970067
   }
 }