Back to Node Auth0

Class TemplatesClient

docs/classes/management.SDK.TemplatesClient.html

5.9.111.1 KB
Original Source

Class TemplatesClient

Index

Constructors

constructor

Methods

listcreategetdeleteupdateresettest

Properties

_options

Constructors

constructor

new TemplatesClient(options: BaseClientOptions): TemplatesClient

Parameters

Returns TemplatesClient

Methods

list

list(
request?: ListPhoneTemplatesRequestParameters,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<ListPhoneTemplatesResponseContent>

Parameters

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 })Copy

create

create(
request?: CreatePhoneTemplateRequestContent,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<CreatePhoneTemplateResponseContent>

Parameters

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()Copy

get

get(
id: string,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<GetPhoneTemplateResponseContent>

Parameters

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")Copy

delete

delete(
id: string,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<void>

Parameters

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")Copy

update

update(
id: string,
request?: UpdatePhoneTemplateRequestContent,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<UpdatePhoneTemplateResponseContent>

Parameters

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")Copy

reset

reset(
id: string,
request?: unknown,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<ResetPhoneTemplateResponseContent>

Parameters

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" })Copy

test

test(
id: string,
request: CreatePhoneTemplateTestNotificationRequestContent,
requestOptions?: TemplatesClient.RequestOptions,
): HttpResponsePromise<CreatePhoneTemplateTestNotificationResponseContent>

Parameters

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" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreategetdeleteupdateresettest Properties _options