Class Providers

Index

Constructors

constructor

new Providers(_options: Providers.Options): Providers
Parameters
- _options: Providers.Options
Returns Providers

Methods

list

list(
request?: Management.ListBrandingPhoneProvidersRequestParameters,
requestOptions?: Providers.RequestOptions,
): HttpResponsePromise<ListBrandingPhoneProvidersResponseContent>
Retrieve a list of phone providers details set for a Tenant. A list of fields to include or exclude may also be specified.
Parameters
- request: Management.ListBrandingPhoneProvidersRequestParameters = {}
- OptionalrequestOptions: Providers.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ListBrandingPhoneProvidersResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.providers.list()
```

create

create(
request: Management.CreateBrandingPhoneProviderRequestContent,
requestOptions?: Providers.RequestOptions,
): HttpResponsePromise<CreateBrandingPhoneProviderResponseContent>
Create a phone provider. The credentials object requires different properties depending on the phone provider (which is specified using the name property).
Parameters
- request: Management.CreateBrandingPhoneProviderRequestContent
- OptionalrequestOptions: Providers.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateBrandingPhoneProviderResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.providers.create({
        name: "twilio",
        credentials: {
            auth_token: "auth_token"
        }
    })
```

get

get(
id: string,
requestOptions?: Providers.RequestOptions,
): HttpResponsePromise<GetBrandingPhoneProviderResponseContent>
Retrieve phone provider details. A list of fields to include or exclude may also be specified.
Parameters
- id: string
- OptionalrequestOptions: Providers.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetBrandingPhoneProviderResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.providers.get("id")
```

delete

delete(
id: string,
requestOptions?: Providers.RequestOptions,
): HttpResponsePromise<void>
Delete the configured phone provider.
Parameters
- id: string
- OptionalrequestOptions: Providers.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.providers.delete("id")
```

update

update(
    id: string,
    request?: Management.UpdateBrandingPhoneProviderRequestContent,
    requestOptions?: Providers.RequestOptions,
): HttpResponsePromise<UpdateBrandingPhoneProviderResponseContent>
Update a phone provider. The credentials object requires different properties depending on the phone provider (which is specified using the name property).
Parameters
- id: string
- request: Management.UpdateBrandingPhoneProviderRequestContent = {}
- OptionalrequestOptions: Providers.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateBrandingPhoneProviderResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.providers.update("id")
```

test

test(
    id: string,
    request: Management.CreatePhoneProviderSendTestRequestContent,
    requestOptions?: Providers.RequestOptions,
): HttpResponsePromise<CreatePhoneProviderSendTestResponseContent>
Parameters
- id: string
- request: Management.CreatePhoneProviderSendTestRequestContent
- OptionalrequestOptions: Providers.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreatePhoneProviderSendTestResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.providers.test("id", {
        to: "to"
    })
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Providers.Options

Class Providers

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Providers

Methods

list

Parameters

Returns HttpResponsePromise<ListBrandingPhoneProvidersResponseContent>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateBrandingPhoneProviderResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetBrandingPhoneProviderResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateBrandingPhoneProviderResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

test

Parameters

Returns HttpResponsePromise<CreatePhoneProviderSendTestResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options