Class RateLimitPoliciesClient

Index

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

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

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

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

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

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class RateLimitPoliciesClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns RateLimitPoliciesClient

Methods

list

Parameters

Returns Promise<Page<RateLimitPolicy, ListRateLimitPoliciesPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateRateLimitPolicyResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetRateLimitPolicyResponseContent>

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateRateLimitPolicyResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options