Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5759,6 +5759,19 @@ components:
items:
type: string
pattern: ^\+[1-9]\d{1,14}$
rcsAgent:
type: string
description: >-
Override the default RCS sender/agent ID used when checking RCS
capabilities.

When provided, this value is used as the `sender` in the RCS
capability-check request instead of the account default.

Must be 1–40 characters and contain only letters, digits,
underscores, or hyphens.
pattern: ^[A-Za-z0-9_-]{1,40}$
example: MyCustomRcsAgent
required:
- phoneNumbers
asyncLookupRequest:
Expand Down Expand Up @@ -8758,6 +8771,13 @@ components:
phoneNumbers:
- '+19196104423'
- '+19196104424'
rcsAgentRequestExample:
summary: Number Lookup Request with Custom RCS Agent
value:
phoneNumbers:
- '+19196104423'
- '+19196104424'
rcsAgent: MyCustomRcsAgent
lookupAcceptedExample:
summary: Numbers Lookup Accepted
value:
Expand Down Expand Up @@ -9518,6 +9538,8 @@ components:
$ref: '#/components/examples/singleNumberRequestExample'
multipleNumberRequestExample:
$ref: '#/components/examples/multipleNumberRequestExample'
rcsAgentRequestExample:
$ref: '#/components/examples/rcsAgentRequestExample'
createAsyncBulkLookupRequest:
description: Asynchronous bulk phone number lookup request.
required: true
Expand Down
2 changes: 2 additions & 0 deletions docs/SyncLookupRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**phoneNumbers** | **Array<string>** | Telephone numbers in E.164 format. | [default to undefined]
**rcsAgent** | **string** | Override the default RCS sender/agent ID used when checking RCS capabilities. When provided, this value is used as the `sender` in the RCS capability-check request instead of the account default. Must be 1–40 characters and contain only letters, digits, underscores, or hyphens. | [optional] [default to undefined]

## Example

Expand All @@ -14,6 +15,7 @@ import { SyncLookupRequest } from 'bandwidth-sdk';

const instance: SyncLookupRequest = {
phoneNumbers,
rcsAgent,
};
```

Expand Down
4 changes: 4 additions & 0 deletions models/sync-lookup-request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,9 @@ export interface SyncLookupRequest {
* Telephone numbers in E.164 format.
*/
'phoneNumbers': Array<string>;
/**
* Override the default RCS sender/agent ID used when checking RCS capabilities. When provided, this value is used as the `sender` in the RCS capability-check request instead of the account default. Must be 1–40 characters and contain only letters, digits, underscores, or hyphens.
*/
'rcsAgent'?: string;
}

5 changes: 4 additions & 1 deletion tests/unit/api/phone-number-lookup-api.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ describe('PhoneNumberLookupApi', () => {

describe('createSyncLookup', () => {
test('should create a sync lookup', async () => {
const request: SyncLookupRequest = { phoneNumbers };
const request: SyncLookupRequest = {
phoneNumbers,
rcsAgent: 'TestAgent'
};

const { status, data } = await phoneNumberLookupApi.createSyncLookup(BW_ACCOUNT_ID, request);

Expand Down
Loading