Class RulesConfigs

Index

Constructors

Methods

list set delete _getAuthorizationHeader

Properties

Constructors

constructor

new RulesConfigs(_options: RulesConfigs.Options): RulesConfigs
Parameters
- _options: RulesConfigs.Options
Returns RulesConfigs

Methods

list

list(
requestOptions?: RulesConfigs.RequestOptions,
): HttpResponsePromise<RulesConfig[]>
Retrieve rules config variable keys.
```
Note: For security, config variable values cannot be retrieved outside rule execution.
```
Parameters
- OptionalrequestOptions: RulesConfigs.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<RulesConfig[]>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.rulesConfigs.list()
```

set

set(
    key: string,
    request: Management.SetRulesConfigRequestContent,
    requestOptions?: RulesConfigs.RequestOptions,
): HttpResponsePromise<SetRulesConfigResponseContent>
Sets a rules config variable.
Parameters
- key: string
  Key of the rules config variable to set (max length: 127 characters).
- request: Management.SetRulesConfigRequestContent
- OptionalrequestOptions: RulesConfigs.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetRulesConfigResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.rulesConfigs.set("key", {
        value: "value"
    })
```

delete

delete(
key: string,
requestOptions?: RulesConfigs.RequestOptions,
): HttpResponsePromise<void>
Delete a rules config variable identified by its key.
Parameters
- key: string
  Key of the rules config variable to delete.
- OptionalrequestOptions: RulesConfigs.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.rulesConfigs.delete("key")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: RulesConfigs.Options