docs/classes/management.SDK.ProvidersClient.html
new ProvidersClient(options: BaseClientOptions): ProvidersClient
list(
request?: ListBrandingPhoneProvidersRequestParameters,
requestOptions?: ProvidersClient.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.
OptionalrequestOptions: ProvidersClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.phone.providers.list({ disabled: true })Copy
create(
request: CreateBrandingPhoneProviderRequestContent,
requestOptions?: ProvidersClient.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).
OptionalrequestOptions: ProvidersClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.phone.providers.create({ name: "twilio", credentials: { auth_token: "auth_token" } })Copy
get(
id: string,
requestOptions?: ProvidersClient.RequestOptions,
): HttpResponsePromise<GetBrandingPhoneProviderResponseContent>
Retrieve phone provider details. A list of fields to include or exclude may also be specified.
OptionalrequestOptions: ProvidersClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.phone.providers.get("id")Copy
delete(
id: string,
requestOptions?: ProvidersClient.RequestOptions,
): HttpResponsePromise<void>
Delete the configured phone provider.
OptionalrequestOptions: ProvidersClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.phone.providers.delete("id")Copy
update(
id: string,
request?: UpdateBrandingPhoneProviderRequestContent,
requestOptions?: ProvidersClient.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).
OptionalrequestOptions: ProvidersClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.phone.providers.update("id")Copy
test(
id: string,
request: CreatePhoneProviderSendTestRequestContent,
requestOptions?: ProvidersClient.RequestOptions,
): HttpResponsePromise<CreatePhoneProviderSendTestResponseContent>
OptionalrequestOptions: ProvidersClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.branding.phone.providers.test("id", { to: "to" })Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listcreategetdeleteupdatetest Properties _options