• management
• SDK
• RateLimitPoliciesClient

Class RateLimitPoliciesClient

Index

Constructors

constructor

Methods

listcreategetdeleteupdate

Properties

_options

Constructors

constructor

new RateLimitPoliciesClient(options: BaseClientOptions): RateLimitPoliciesClient

Parameters

• options: BaseClientOptions

Returns RateLimitPoliciesClient

Methods

list

list(
request?: ListRateLimitPoliciesRequestParameters,
requestOptions?: RateLimitPoliciesClient.RequestOptions,
): Promise<
Page<RateLimitPolicy, ListRateLimitPoliciesPaginatedResponseContent>,
>

Parameters

• request: ListRateLimitPoliciesRequestParameters = {}
• OptionalrequestOptions: RateLimitPoliciesClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<RateLimitPolicy, ListRateLimitPoliciesPaginatedResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.rateLimitPolicies.list({ resource: "oauth_authentication_api", consumer: "client", consumer_selector: "consumer_selector", take: 1, from: "from" })Copy

create

create(
request: CreateRateLimitPolicyRequestContent,
requestOptions?: RateLimitPoliciesClient.RequestOptions,
): HttpResponsePromise<CreateRateLimitPolicyResponseContent>

Parameters

• request: CreateRateLimitPolicyRequestContent
• OptionalrequestOptions: RateLimitPoliciesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateRateLimitPolicyResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.rateLimitPolicies.create({ resource: "oauth_authentication_api", consumer: "client", consumer_selector: "consumer_selector", configuration: { action: "allow" } })Copy

get

get(
id: string,
requestOptions?: RateLimitPoliciesClient.RequestOptions,
): HttpResponsePromise<GetRateLimitPolicyResponseContent>

Parameters

• id: string

Unique identifier for the Rate Limit Policy.

• OptionalrequestOptions: RateLimitPoliciesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetRateLimitPolicyResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.rateLimitPolicies.get("id")Copy

delete

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

Parameters

• id: string

Unique identifier for the Rate Limit Policy.

• OptionalrequestOptions: RateLimitPoliciesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.rateLimitPolicies.delete("id")Copy

update

update(
id: string,
request: PatchRateLimitPolicyRequestContent,
requestOptions?: RateLimitPoliciesClient.RequestOptions,
): HttpResponsePromise<UpdateRateLimitPolicyResponseContent>

Parameters

• id: string

Unique identifier for the Rate Limit Policy.

• request: PatchRateLimitPolicyRequestContent
• OptionalrequestOptions: RateLimitPoliciesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateRateLimitPolicyResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.rateLimitPolicies.update("id", { configuration: { action: "allow" } })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreategetdeleteupdate Properties _options