bandwidth-sdk 17.2.0 → 17.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c5d14b2821c1ff9ebb48adfc098d47c38af240d0a9465c0633bddb8b54601dc
-  data.tar.gz: e52f699ba29e164cf3f34e8555efa1c4114b65463ecc198b1f1bf12a3bc426aa
+  metadata.gz: 1b0bca65e0a4a616dda251dcb01f1057480b68382807d064184fe3b75c37eed5
+  data.tar.gz: ff5640dde4290a14575e2e282ebcc8a6840eb6598eef5f995e149ae6f3786850
 SHA512:
-  metadata.gz: 3de616049b04f80a2b473bbdcd24158ee9abbb65b4b457b156270b5a6729c3819c9b319a6da2e2e646c00e3f1825e48dc06c6f694e0e1f6225f83d03dce4999f
-  data.tar.gz: 8661311a1bedff724a5da1b99a1c46c85b6bdcd94866e5d1a44b7fe058df6bc50ff88ec9d949903720a10722c2d5db4defecab25dd599c5b81b59d4582113516
+  metadata.gz: 6ddcce0d0fc9ec1dacd815ee1e5baa073536ad8deca7c9d05de231e8d1b30465fdf81056e800618d63248a66103894575129acc76621e719df88291e739128b0
+  data.tar.gz: 94f1bf779801d16a0e4da36b9ad0ecb72338bff90a9d2716c6ac1f3d340d22c982643ae9f271e8470d86584a92e7e285877354653712e7328bd053574b46ef7e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bandwidth-sdk (17.2.0)
+    bandwidth-sdk (17.3.1)
       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,7 @@ GEM
     faraday-net_http (3.4.2)
       net-http (~> 0.5)
     io-console (0.8.2)
-    json (2.18.1)
+    json (2.19.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -38,7 +38,7 @@ 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.9.0)
@@ -64,7 +64,7 @@ GEM
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
@@ -79,7 +79,7 @@ GEM
       rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.0)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
     ruby-progressbar (1.13.0)

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

@@ -1484,7 +1484,7 @@ paths:
         $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest'
       responses:
         '202':
-          description: Accepted
+          $ref: '#/components/responses/verifyPutResponse'
         '400':
           $ref: '#/components/responses/tfvPostBadRequestResponse'
         '401':
@@ -1696,7 +1696,7 @@ components:
       type: string
       description: >-
         The ID of the Application your from number or senderId is associated
-        with in the Bandwidth Phone Number Dashboard.
+        with in the Bandwidth App.
       example: 93de2206-9669-4e07-948d-329f4b722ee2
     priorityEnum:
       type: string
@@ -1956,8 +1956,10 @@ components:
           type: string
         contentLength:
           type: integer
+          example: 1024
         mediaName:
           type: string
+          example: image.png
     segmentCount:
       type: integer
       description: >-
@@ -2744,6 +2746,7 @@ components:
       discriminator:
         propertyName: type
         mapping:
+          message-sending: '#/components/schemas/statusCallback'
           message-sent: '#/components/schemas/statusCallback'
           message-delivered: '#/components/schemas/statusCallback'
           message-failed: '#/components/schemas/statusCallback'
@@ -5510,10 +5513,14 @@ components:
 
         - UNKNOWN: Bandwidth cannot find an delivery status entry for the
         number.
+
+        - NOT_ENABLED: The phone number is not enabled for messaging, so there
+        is no delivery status information.
       enum:
         - ACTIVE
         - DEACTIVATED
         - UNKNOWN
+        - NOT_ENABLED
     lineTypeEnum:
       type: string
       enum:
@@ -5816,50 +5823,144 @@ components:
       type: string
     privacyPolicyUrl:
       description: The Toll-Free Verification request privacy policy URL.
+      maxLength: 500
       example: http://your-company.com/privacyPolicy
       type: string
     termsAndConditionsUrl:
       description: The Toll-Free Verification request terms and conditions policy URL.
+      maxLength: 500
       example: http://your-company.com/termsAndConditions
       type: string
     businessDba:
       description: The company 'Doing Business As'.
+      maxLength: 500
       example: Another Company Name Inc.
       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.
+
+
+        **Note:** If this field is provided, it is strongly recommended to also
+        provide `businessRegistrationType` and
+        `businessRegistrationIssuingCountry`. Submissions missing these fields
+        have a high likelihood of rejection.
       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
+      example: EIN
       nullable: true
-    businessEntityTypeEnum:
+    businessRegistrationIssuingCountryEnum:
       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.
+        The country issuing the business registration in ISO-3166-1 alpha-3
+        format. Alpha-2 country codes are acceptable, but the application will
+        convert them to alpha-3 when received, so alpha-3 is encouraged.
+
+
+        **Note:** If this field is omitted but `businessRegistrationType` is
+        provided, the application will attempt to infer the country based on the
+        registration type. However, if the application cannot confidently infer
+        the country, the submission may be rejected. To ensure the highest
+        likelihood of acceptance, it is recommended to provide both
+        `businessRegistrationType` and `businessRegistrationIssuingCountry`.
+
+
+        | 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
+        - CYP
+        - IND
+        - CHN
+        - BGR
+      example: USA
+      nullable: false
+    businessEntityTypeEnum:
+      type: string
+      description: |
+        The type of registered business.
       enum:
         - SOLE_PROPRIETOR
         - PRIVATE_PROFIT
         - PUBLIC_PROFIT
         - NON_PROFIT
         - GOVERNMENT
-      nullable: true
+      example: PRIVATE_PROFIT
+      nullable: false
     helpMessageResponse:
       type: string
       description: A message that gets sent to users requesting help.
@@ -5914,6 +6015,7 @@ components:
         - useCaseSummary
         - productionMessageContent
         - optInWorkflow
+        - businessEntityType
       properties:
         businessAddress:
           $ref: '#/components/schemas/address'
@@ -5958,6 +6060,8 @@ components:
           $ref: '#/components/schemas/businessRegistrationNumber'
         businessRegistrationType:
           $ref: '#/components/schemas/businessRegistrationTypeEnum'
+        businessRegistrationIssuingCountry:
+          $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
         businessEntityType:
           $ref: '#/components/schemas/businessEntityTypeEnum'
         helpMessageResponse:
@@ -5965,7 +6069,7 @@ components:
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
         cvToken:
-          $ref: '#/components/schemas/cvToken'
+          $ref: '#/components/schemas/cvTokenNullable'
     verificationUpdateRequest:
       type: object
       required:
@@ -6011,12 +6115,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/cvToken'
+          $ref: '#/components/schemas/cvTokenNullable'
     tfvBasicAuthentication:
       type: object
       properties:
@@ -6469,7 +6575,7 @@ components:
         blockedReason:
           $ref: '#/components/schemas/blockedReason'
         cvToken:
-          $ref: '#/components/schemas/cvToken'
+          $ref: '#/components/schemas/cvTokenNullable'
     tfvSubmissionInfo:
       type: object
       properties:
@@ -6503,20 +6609,16 @@ 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.
+          description: Government-issued business identifying number.
         businessRegistrationType:
           $ref: '#/components/schemas/businessRegistrationTypeEnum'
+        businessRegistrationIssuingCountry:
+          $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
           description: >-
-            The type of business registration number. Available starting October
-            1st, 2025.
+            The country issuing the business registration in ISO-3166-1 alpha-3
+            format.
         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:
@@ -6534,13 +6636,13 @@ components:
       nullable: true
       pattern: ^[ -~]{16,64}$
       type: string
-    cvToken:
+    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. If you pass an
-        empty string, it will be passed along and potentially rejected.
+        527 political organization, this field should be omitted. Supplying an
+        empty string will likely result in rejection.
       minLength: 0
       maxLength: 500
       nullable: true
@@ -7214,6 +7316,8 @@ components:
           example:
             description: Service Unavailable Error.
             type: Service Unavailable
+    verifyPutResponse:
+      description: Accepted
   parameters:
     accountId:
       in: path
@@ -8050,7 +8154,7 @@ components:
               latestMessageDeliveryStatusDate: '2025-05-18'
             - phoneNumber: '+10072904498'
               countryCodeA3: USA
-              lineType: FIXED
+              lineType: MOBILE
               voiceProvider: VERIZON
               latestMessageDeliveryStatus: DEACTIVATED
               initialMessageDeliveryStatusDate: '2025-09-05'
@@ -8064,6 +8168,14 @@ components:
               deactivationDate: '2025-09-29 01:23:00'
               deactivationEvent: DEACTIVATED
               latestMessageDeliveryStatus: UNKNOWN
+            - phoneNumber: '+10072904500'
+              lineType: FIXED
+              countryCodeA3: USA
+              voiceProvider: VERIZON
+              deactivationReporter: Verizon Wireless
+              deactivationDate: '2025-09-29 01:23:00'
+              deactivationEvent: DEACTIVATED
+              latestMessageDeliveryStatus: NOT_ENABLED
         errors: []
     badRequestExample:
       summary: Example Bad Request Error

data/coverage/.resultset.json

@@ -199,6 +199,7 @@
           1,
           1,
           1,
+          1,
           null,
           null,
           1,
@@ -795,13 +796,13 @@
           null,
           null,
           1,
-          443,
+          462,
           null,
           45,
           null,
           8,
           null,
-          267,
+          277,
           null,
           21,
           null,
@@ -828,8 +829,8 @@
           null,
           null,
           null,
-          84,
-          84,
+          93,
+          93,
           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,
@@ -11662,6 +11667,6 @@
         ]
       }
     },
-    "timestamp": 1770147454
+    "timestamp": 1774382238
   }
 }