bandwidth-sdk 17.3.1 → 18.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b0bca65e0a4a616dda251dcb01f1057480b68382807d064184fe3b75c37eed5
-  data.tar.gz: ff5640dde4290a14575e2e282ebcc8a6840eb6598eef5f995e149ae6f3786850
+  metadata.gz: f21c9b7a965a264ef14618d42e01d9847b40b1a7a4cdd73ab1b6312acab09c0a
+  data.tar.gz: 25516a2746c0ef44f93af141edd18d0b78d5b3268d96f3eeb2e7c5eb1e963d33
 SHA512:
-  metadata.gz: 6ddcce0d0fc9ec1dacd815ee1e5baa073536ad8deca7c9d05de231e8d1b30465fdf81056e800618d63248a66103894575129acc76621e719df88291e739128b0
-  data.tar.gz: 94f1bf779801d16a0e4da36b9ad0ecb72338bff90a9d2716c6ac1f3d340d22c982643ae9f271e8470d86584a92e7e285877354653712e7328bd053574b46ef7e
+  metadata.gz: 9dfb299c7d584425ec24beb5709ccb4674fb75d8c5ee924225e9e53076a4585b548e8bd268d5b636aaf860617127a1ad92d13bb8c416bba437049c79ec8f9399
+  data.tar.gz: 16da8b388e7319c53343617c8afa05852976373778cd2c3f23827011473b28fd07ced43205d105d8cccc2059729d6796ff35bbd33b8625a8232c99685e1280b0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bandwidth-sdk (17.3.1)
+    bandwidth-sdk (18.0.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
       marcel
@@ -11,7 +11,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.3)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.1)
     byebug (13.0.0)
       reline (>= 0.6.0)
     coderay (1.1.3)
@@ -26,7 +26,7 @@ GEM
     faraday-net_http (3.4.2)
       net-http (~> 0.5)
     io-console (0.8.2)
-    json (2.19.2)
+    json (2.19.3)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -37,8 +37,8 @@ GEM
       uri (>= 0.11.1)
     ox (2.14.23)
       bigdecimal (>= 3.0)
-    parallel (1.27.0)
-    parser (3.3.10.2)
+    parallel (1.28.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
     prism (1.9.0)
@@ -52,7 +52,7 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.11.3)
+    regexp_parser (2.12.0)
     reline (0.6.3)
       io-console (~> 0.5)
     rspec (3.13.2)

data/README.md

@@ -180,7 +180,6 @@ 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

@@ -95,8 +95,8 @@ paths:
         under this account, the previous file will be overwritten.
 
 
-        A list of supported media types can be found
-        [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
+        A list of supported media types can be found at [Bandwidth
+        Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
       operationId: uploadMedia
       tags:
         - Media
@@ -2255,8 +2255,8 @@ components:
 
             For MMS, the API limits file size to 3.5MB. Specific carriers and
             channels may have a smaller limit that could cause a large file to
-            fail, see
-            [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits)
+            fail, see more at [Bandwidth
+            Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits)
             for more details.
           example: https://dev.bandwidth.com/images/bandwidth-logo.png
           maxLength: 1000
@@ -5552,6 +5552,10 @@ components:
           example: GET
     lookupErrorSchema:
       type: object
+      required:
+        - code
+        - type
+        - description
       properties:
         code:
           type: string
@@ -5699,6 +5703,39 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/lookupErrorSchema'
+    rcsErrorEnum:
+      type: string
+      description: >-
+        [RCS-Only](#section/RCS-Only). Error encountered during RCS capability
+        lookup. Appears as the `code` field in the top-level `errors` array.
+
+
+        **RCS service pass-through codes:**
+
+        - `REQUEST_FAILED`: The RCS service returned this error code.
+
+        - `UNKNOWN_CODE`: The RCS service returned this error code.
+
+        - `INVALID_DESTINATION_ADDRESS`: The RCS service returned this error
+        code.
+
+        - `UNKNOWN_STATUS: <code>`: The RCS service returned an unrecognized
+        status code, where `<code>` is the raw value.
+
+
+        **Service-level errors:**
+
+        - `MISSING_FROM_RESPONSE`: The phone number was absent from the RCS
+        service response.
+
+        - `RCS_SERVICE_UNAVAILABLE`: An exception was thrown during the async
+        RCS service call.
+
+        - `RCS_SERVICE_DISABLED`: RCS lookup is disabled in configuration.
+
+        - `EMPTY_RESPONSE`: The RCS service returned a null or empty response
+        body.
+      example: RCS_SERVICE_UNAVAILABLE
     lookupResult:
       type: object
       description: Carrier information results for the specified telephone number.
@@ -5757,13 +5794,21 @@ components:
           format: date
           description: >-
             [DNI-Only](#section/DNI-Only). The date bandwidth last received
-            delivery status information for this phone number. 
+            delivery status information for this phone number.
 
             Use this field to understand how up-to-date the
             `latestMessageDeliveryStatus` is.
 
             Value resets every time the `latestMessageDeliveryStatus` changes.
           example: '2025-06-21'
+        rcsEnabled:
+          type: boolean
+          description: >
+            [RCS-Only](#section/RCS-Only). Indicates whether the phone number is
+            capable of receiving RCS messages. Value will be null if account has
+            RCS, but no value was returned. Absent when account does not have
+            RCS.
+          example: true
     accountId1:
       type: string
       description: User's account ID.
@@ -5842,17 +5887,21 @@ components:
         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.
+        **Note: As of October 19th, 2026 this field will be required when
+        `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is
+        provided, `businessRegistrationType` and
+        `businessRegistrationIssuingCountry` are also required.**
       nullable: true
       maxLength: 500
       example: 12-3456789
     businessRegistrationTypeEnum:
       type: string
-      description: |
+      description: >
         The type of business registration number.
+
+
+        **Note: As of October 19th, 2026 this field will be required when
+        `businessRegistrationNumber` is provided.**
       enum:
         - EIN
         - CBN
@@ -5874,20 +5923,16 @@ components:
         - OTHER
       example: EIN
       nullable: true
-    businessRegistrationIssuingCountryEnum:
+    businessRegistrationIssuingCountry:
       type: string
       description: >-
         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.
+        format. Alpha-2 format is accepted by the API, but alpha-3 is highly
+        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`.
+        **Note: As of October 19th, 2026 this field will be required when
+        `businessRegistrationNumber` is provided.**
 
 
         | Registration Type     | Supported Countries                |
@@ -5929,30 +5974,22 @@ components:
         | 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
+      nullable: true
     businessEntityTypeEnum:
       type: string
-      description: |
+      description: >
         The type of registered business.
+
+
+        **Note: As of October 19th, 2026 submissions using a value other than
+        `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`,
+        `businessRegistrationType`, and `businessRegistrationIssuingCountry`. 
+
+        Submissions using `SOLE_PROPRIETOR` must _omit_
+        `businessRegistrationNumber`, `businessRegistrationType`, and
+        `businessRegistrationIssuingCountry`. Failure to adhere to these
+        constraints will result in a 400 Bad Request rejection.**
       enum:
         - SOLE_PROPRIETOR
         - PRIVATE_PROFIT
@@ -6061,7 +6098,7 @@ components:
         businessRegistrationType:
           $ref: '#/components/schemas/businessRegistrationTypeEnum'
         businessRegistrationIssuingCountry:
-          $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
+          $ref: '#/components/schemas/businessRegistrationIssuingCountry'
         businessEntityType:
           $ref: '#/components/schemas/businessEntityTypeEnum'
         helpMessageResponse:
@@ -6116,7 +6153,7 @@ components:
         businessEntityType:
           $ref: '#/components/schemas/businessEntityTypeEnum'
         businessRegistrationIssuingCountry:
-          $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
+          $ref: '#/components/schemas/businessRegistrationIssuingCountry'
         helpMessageResponse:
           $ref: '#/components/schemas/helpMessageResponse'
         ageGatedContent:
@@ -6612,13 +6649,15 @@ components:
           description: Government-issued business identifying number.
         businessRegistrationType:
           $ref: '#/components/schemas/businessRegistrationTypeEnum'
+          description: The type of business registration number.
         businessRegistrationIssuingCountry:
-          $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
+          $ref: '#/components/schemas/businessRegistrationIssuingCountry'
           description: >-
             The country issuing the business registration in ISO-3166-1 alpha-3
             format.
         businessEntityType:
           $ref: '#/components/schemas/businessEntityTypeEnum'
+          description: The type of registered business.
     tfvStatusEnum:
       type: string
       enum:
@@ -7149,6 +7188,10 @@ components:
               $ref: '#/components/examples/lookupCompleteWithDniExample'
             lookupCompleteExample:
               $ref: '#/components/examples/lookupCompleteExample'
+            lookupCompleteWithRcsExample:
+              $ref: '#/components/examples/lookupCompleteWithRcsExample'
+            lookupCompleteWithRcsErrorExample:
+              $ref: '#/components/examples/lookupCompleteWithRcsErrorExample'
             lookupPartialExample:
               $ref: '#/components/examples/lookupPartialExample'
             lookupFailedExample:
@@ -7160,8 +7203,8 @@ components:
           schema:
             $ref: '#/components/schemas/createAsyncBulkLookupResponse'
           examples:
-            lookupInProgressExample:
-              $ref: '#/components/examples/lookupInProgressExample'
+            lookupAcceptedExample:
+              $ref: '#/components/examples/lookupAcceptedExample'
     getAsyncBulkLookupResponse:
       description: OK
       content:
@@ -8049,25 +8092,32 @@ components:
         phoneNumbers:
           - '+19196104423'
           - '+19196104424'
-    lookupInProgressExample:
-      summary: Numbers Lookup In Progress
+    lookupAcceptedExample:
+      summary: Numbers Lookup Accepted
       value:
         links:
-          - href: href
-            rel: rel
+          - href: >-
+              /accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590
+            rel: createdRequest
             method: GET
         data:
           requestId: 004223a0-8b17-41b1-bf81-20732adf5590
           status: IN_PROGRESS
           results: []
         errors: []
+    lookupInProgressExample:
+      summary: Numbers Lookup In Progress
+      value:
+        links: []
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: IN_PROGRESS
+          results: []
+        errors: []
     lookupFailedExample:
       summary: Numbers Lookup Failed
       value:
-        links:
-          - href: href
-            rel: rel
-            method: GET
+        links: []
         data:
           requestId: 004223a0-8b17-41b1-bf81-20732adf5590
           status: FAILED
@@ -8084,10 +8134,7 @@ components:
     lookupPartialExample:
       summary: Numbers Lookup Partial Complete
       value:
-        links:
-          - href: href
-            rel: rel
-            method: GET
+        links: []
         data:
           requestId: 004223a0-8b17-41b1-bf81-20732adf5590
           status: PARTIAL_COMPLETE
@@ -8114,10 +8161,7 @@ components:
     lookupCompleteExample:
       summary: Numbers Lookup Complete (without DNI)
       value:
-        links:
-          - href: href
-            rel: rel
-            method: GET
+        links: []
         data:
           requestId: 004223a0-8b17-41b1-bf81-20732adf5590
           status: COMPLETE
@@ -8136,10 +8180,7 @@ components:
     lookupCompleteWithDniExample:
       summary: Numbers Lookup Complete (with DNI)
       value:
-        links:
-          - href: href
-            rel: rel
-            method: GET
+        links: []
         data:
           requestId: 20732adf-bf81-8b17-41b1-004223a05590
           status: COMPLETE
@@ -8177,6 +8218,58 @@ components:
               deactivationEvent: DEACTIVATED
               latestMessageDeliveryStatus: NOT_ENABLED
         errors: []
+    lookupCompleteWithRcsExample:
+      summary: Numbers Lookup Complete (with RCS)
+      value:
+        links: []
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: COMPLETE
+          results:
+            - phoneNumber: '+10072904497'
+              lineType: MOBILE
+              messagingProvider: Verizon Wireless
+              voiceProvider: Verizon Wireless
+              countryCodeA3: USA
+              rcsEnabled: true
+            - phoneNumber: '+10072904498'
+              lineType: MOBILE
+              messagingProvider: T-Mobile USA
+              voiceProvider: T-Mobile USA
+              countryCodeA3: USA
+              rcsEnabled: false
+        errors: []
+    lookupCompleteWithRcsErrorExample:
+      summary: Numbers Lookup Complete (with RCS error)
+      value:
+        links: []
+        data:
+          requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+          status: COMPLETE
+          results:
+            - phoneNumber: '+10072904497'
+              lineType: MOBILE
+              messagingProvider: Verizon Wireless
+              voiceProvider: Verizon Wireless
+              countryCodeA3: USA
+            - phoneNumber: '+10072904498'
+              lineType: MOBILE
+              messagingProvider: T-Mobile USA
+              voiceProvider: T-Mobile USA
+              countryCodeA3: USA
+        errors:
+          - code: RCS_SERVICE_UNAVAILABLE
+            type: rcs-error
+            description: An exception was thrown during the async RCS service call.
+            meta:
+              phoneNumbers:
+                - '+10072904497'
+          - code: MISSING_FROM_RESPONSE
+            type: rcs-error
+            description: The phone number was absent from the RCS service response.
+            meta:
+              phoneNumbers:
+                - '+10072904498'
     badRequestExample:
       summary: Example Bad Request Error
       value:

data/coverage/.last_run.json

@@ -1,5 +1,5 @@
 {
   "result": {
-    "line": 95.78
+    "line": 95.77
   }
 }

data/coverage/.resultset.json

@@ -199,7 +199,6 @@
           1,
           1,
           1,
-          1,
           null,
           null,
           1,
@@ -796,13 +795,13 @@
           null,
           null,
           1,
-          462,
+          454,
           null,
           45,
           null,
           8,
           null,
-          277,
+          272,
           null,
           21,
           null,
@@ -829,8 +828,8 @@
           null,
           null,
           null,
-          93,
-          93,
+          90,
+          90,
           null,
           null,
           null,
@@ -8116,10 +8115,6 @@
           1,
           1,
           1,
-          1,
-          1,
-          1,
-          1,
           null,
           null,
           null,
@@ -8143,10 +8138,6 @@
           1,
           1,
           1,
-          1,
-          1,
-          1,
-          1,
           null,
           null,
           null
@@ -11667,6 +11658,6 @@
         ]
       }
     },
-    "timestamp": 1774382238
+    "timestamp": 1775593319
   }
 }