docs/classes/management.SDK.SecretsClient.html
new SecretsClient(options: BaseClientOptions): SecretsClient
get(
id: string,
requestOptions?: SecretsClient.RequestOptions,
): HttpResponsePromise<GetHookSecretResponseContent>
Retrieve a hook's secrets by the ID of the hook.
ID of the hook to retrieve secrets from.
OptionalrequestOptions: SecretsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.hooks.secrets.get("id")Copy
create(
id: string,
request: CreateHookSecretRequestContent,
requestOptions?: SecretsClient.RequestOptions,
): HttpResponsePromise<void>
Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.
The id of the hook to retrieve
OptionalrequestOptions: SecretsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.hooks.secrets.create("id", { "key": "value" })Copy
delete(
id: string,
request: DeleteHookSecretRequestContent,
requestOptions?: SecretsClient.RequestOptions,
): HttpResponsePromise<void>
Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.
ID of the hook whose secrets to delete.
OptionalrequestOptions: SecretsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.hooks.secrets.delete("id", ["string"])Copy
update(
id: string,
request: UpdateHookSecretRequestContent,
requestOptions?: SecretsClient.RequestOptions,
): HttpResponsePromise<void>
Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.
ID of the hook whose secrets to update.
OptionalrequestOptions: SecretsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.hooks.secrets.update("id", { "key": "value" })Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods getcreatedeleteupdate Properties _options