Class TemplatesClient

Index

Constructors

constructor

new TemplatesClient(options: BaseClientOptions): TemplatesClient
Parameters
- options: BaseClientOptions
Returns TemplatesClient

Methods

list

list(
request?: ListPhoneTemplatesRequestParameters,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<ListPhoneTemplatesResponseContent>
Parameters
- request: ListPhoneTemplatesRequestParameters = {}
- OptionalrequestOptions: TemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ListPhoneTemplatesResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.templates.list({
        disabled: true
    })
```

create

create(
request?: CreatePhoneTemplateRequestContent,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<CreatePhoneTemplateResponseContent>
Parameters
- request: CreatePhoneTemplateRequestContent = {}
- OptionalrequestOptions: TemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreatePhoneTemplateResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.templates.create()
```

get

get(
id: string,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<GetPhoneTemplateResponseContent>
Parameters
- id: string
- OptionalrequestOptions: TemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetPhoneTemplateResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

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

delete

delete(
id: string,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
- OptionalrequestOptions: TemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

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

update

update(
    id: string,
    request?: UpdatePhoneTemplateRequestContent,
    requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<UpdatePhoneTemplateResponseContent>
Parameters
- id: string
- request: UpdatePhoneTemplateRequestContent = {}
- OptionalrequestOptions: TemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdatePhoneTemplateResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

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

reset

reset(
    id: string,
    request?: unknown,
    requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<ResetPhoneTemplateResponseContent>
Parameters
- id: string
- Optionalrequest: unknown
- OptionalrequestOptions: TemplatesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ResetPhoneTemplateResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.branding.phone.templates.reset("id", {
        "key": "value"
    })
```

test

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

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

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class TemplatesClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns TemplatesClient

Methods

list

Parameters

Returns HttpResponsePromise<ListPhoneTemplatesResponseContent>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreatePhoneTemplateResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetPhoneTemplateResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdatePhoneTemplateResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

reset

Parameters

Returns HttpResponsePromise<ResetPhoneTemplateResponseContent>

Throws

Throws

Throws

Throws

Example

test

Parameters

Returns HttpResponsePromise<CreatePhoneTemplateTestNotificationResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options