bandwidth-sdk 17.3.0 → 17.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c104607d4f93290aee6b7f6ddfae1b763e704869b461f9782a177630581a7b8b
-  data.tar.gz: 6e171382371ce86dd1685689a4d7bcb360e3f4232778b364e95117b0958cbe09
+  metadata.gz: a361e879b7e9eb3f73da743085677f7bb58c0b8b8ce1fa3e487e701e7fed01ba
+  data.tar.gz: f282c45a88a4c7d0a783952f3e9474b3e1b0e0802d44c7c4ca43adec07fab1cf
 SHA512:
-  metadata.gz: 2492c79aa0113a31f75022987fa1e7a8be31c50960cfae79ff8efe35020bec55152b0b2d67137a1e732508bcf2f1dc455d9bfe14c41c4027995bf577db2c9097
-  data.tar.gz: 5f83bd244d36a7ced37bd7ff78d77286a1addae8a74f4f3640660953bb6d67e9d5d41b8b4460f6875187769aff19f166400599be33f0ef06585ad7fbba372fb2
+  metadata.gz: 88b3ef75dbb38c6bc292fb581b0f287d276e93a439ad93e6a2683a6ba96d48be2affc4b5b0a4e5106928f9b34ad58b08048440e6175c39815e31df0ef2bcf709
+  data.tar.gz: 333ff1bf89dcea46a87f3f30e0ed374895ebcf06846b54c77d2cf1ada046ebfafe9b4a256b49886458b67e89ee2f6efe476d095024dadd734078a0c5ce2d0cd6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bandwidth-sdk (17.3.0)
+    bandwidth-sdk (17.3.2)
       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.0)
     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.18.1)
+    json (2.19.3)
     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.2)
+    parser (3.3.11.1)
       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/bandwidth.yml

@@ -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:
@@ -5545,6 +5552,10 @@ components:
           example: GET
     lookupErrorSchema:
       type: object
+      required:
+        - code
+        - type
+        - description
       properties:
         code:
           type: string
@@ -5692,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.
@@ -5750,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.
@@ -5816,25 +5868,36 @@ 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: Government-issued business identifying number.
+      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.
+      description: |
+        The type of business registration number.
       enum:
         - EIN
         - CBN
@@ -5854,12 +5917,22 @@ components:
         - CNPJ
         - UID
         - OTHER
+      example: EIN
       nullable: true
     businessRegistrationIssuingCountryEnum:
       type: string
       description: >-
         The country issuing the business registration in ISO-3166-1 alpha-3
-        format.
+        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                |
@@ -5915,18 +5988,23 @@ components:
         - DEU
         - ESP
         - CHE
+        - CYP
+        - IND
+        - CHN
+        - BGR
+      example: USA
       nullable: false
     businessEntityTypeEnum:
       type: string
-      description: >-
-        The type of registered business. If no option is applicable, please
-        provide "SOLE_PROPRIETOR" as a value.
+      description: |
+        The type of registered business.
       enum:
         - SOLE_PROPRIETOR
         - PRIVATE_PROFIT
         - PUBLIC_PROFIT
         - NON_PROFIT
         - GOVERNMENT
+      example: PRIVATE_PROFIT
       nullable: false
     helpMessageResponse:
       type: string
@@ -6576,10 +6654,14 @@ components:
           $ref: '#/components/schemas/businessDba'
         businessRegistrationNumber:
           $ref: '#/components/schemas/businessRegistrationNumber'
+          description: Government-issued business identifying number.
         businessRegistrationType:
           $ref: '#/components/schemas/businessRegistrationTypeEnum'
         businessRegistrationIssuingCountry:
           $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
+          description: >-
+            The country issuing the business registration in ISO-3166-1 alpha-3
+            format.
         businessEntityType:
           $ref: '#/components/schemas/businessEntityTypeEnum'
     tfvStatusEnum:
@@ -7112,6 +7194,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:
@@ -7123,8 +7209,8 @@ components:
           schema:
             $ref: '#/components/schemas/createAsyncBulkLookupResponse'
           examples:
-            lookupInProgressExample:
-              $ref: '#/components/examples/lookupInProgressExample'
+            lookupAcceptedExample:
+              $ref: '#/components/examples/lookupAcceptedExample'
     getAsyncBulkLookupResponse:
       description: OK
       content:
@@ -8012,25 +8098,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
@@ -8047,10 +8140,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
@@ -8077,10 +8167,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
@@ -8099,10 +8186,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
@@ -8117,7 +8201,7 @@ components:
               latestMessageDeliveryStatusDate: '2025-05-18'
             - phoneNumber: '+10072904498'
               countryCodeA3: USA
-              lineType: FIXED
+              lineType: MOBILE
               voiceProvider: VERIZON
               latestMessageDeliveryStatus: DEACTIVATED
               initialMessageDeliveryStatusDate: '2025-09-05'
@@ -8131,7 +8215,67 @@ 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: []
+    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/.resultset.json

@@ -796,13 +796,13 @@
           null,
           null,
           1,
-          444,
+          454,
           null,
           45,
           null,
           8,
           null,
-          267,
+          271,
           null,
           21,
           null,
@@ -829,8 +829,8 @@
           null,
           null,
           null,
-          85,
-          85,
+          91,
+          91,
           null,
           null,
           null,
@@ -8116,10 +8116,6 @@
           1,
           1,
           1,
-          1,
-          1,
-          1,
-          1,
           null,
           null,
           null,
@@ -8143,10 +8139,6 @@
           1,
           1,
           1,
-          1,
-          1,
-          1,
-          1,
           null,
           null,
           null
@@ -11667,6 +11659,6 @@
         ]
       }
     },
-    "timestamp": 1771970067
+    "timestamp": 1774988735
   }
 }