/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { CreateWebhookMtlsConfigRequest } from '../models'; import { CreateWebhookOauthRequest } from '../models'; import { CreateWebhookRequest } from '../models'; import { DeleteWebhookMtlsConfigResponse } from '../models'; import { DeleteWebhookOauthResponse } from '../models'; import { NotificationAttemptsPaginatedResponse } from '../models'; import { NotificationPaginatedResponse } from '../models'; import { NotificationStatus } from '../models'; import { NotificationWithData } from '../models'; import { ResendByQueryRequest } from '../models'; import { ResendByQueryResponse } from '../models'; import { ResendFailedNotificationsJobStatusResponse } from '../models'; import { ResendFailedNotificationsRequest } from '../models'; import { ResendFailedNotificationsResponse } from '../models'; import { ResendNotificationsByResourceIdRequest } from '../models'; import { UpdateWebhookMtlsConfigRequest } from '../models'; import { UpdateWebhookOauthRequest } from '../models'; import { UpdateWebhookRequest } from '../models'; import { Webhook } from '../models'; import { WebhookEvent } from '../models'; import { WebhookMetric } from '../models'; import { WebhookMtlsConfig } from '../models'; import { WebhookMtlsConfigsList } from '../models'; import { WebhookMtlsCsrResponse } from '../models'; import { WebhookOauthCredentials } from '../models'; import { WebhookOauthList } from '../models'; import { WebhookPaginatedResponse } from '../models'; /** * WebhooksV2Api - axios parameter creator * @export */ export declare const WebhooksV2ApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new webhook, which will be triggered on the specified events **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create a new webhook * @param {CreateWebhookRequest} createWebhookRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook: (createWebhookRequest: CreateWebhookRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Stores a certificate signed against the CSR from `GET /v1/webhooks_settings/mtls_csr` and returns its id, which is then set as `webhookMtlsId` on a webhook or on OAuth credentials. The private key the certificate was issued for is derived from the certificate, so it is never named by the caller. Re-uploading a certificate already stored returns the existing id rather than creating a second configuration, so several webhooks and OAuth credentials can share one certificate. A certificate that was not issued for a private key this workspace holds is rejected with a `400`. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create an mTLS configuration * @param {CreateWebhookMtlsConfigRequest} createWebhookMtlsConfigRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookMtlsConfig: (createWebhookMtlsConfigRequest: CreateWebhookMtlsConfigRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a reusable OAuth client credential set. Attach it to a webhook by passing the returned id as that webhook\'s `webhookOauthId`. Several webhooks may share one credential set, so rotating its client secret covers all of them at once. The client secret is write-only and is never returned. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create OAuth credentials * @param {CreateWebhookOauthRequest} createWebhookOauthRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookOauth: (createWebhookOauthRequest: CreateWebhookOauthRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Delete a webhook by its id Endpoint Permission: Owner, Admin, Non-Signing Admin. * @summary Delete webhook * @param {string} webhookId The unique identifier of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes an mTLS configuration. By default the delete is refused while the configuration is still in use: if any webhook or OAuth credentials reference it, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of what references it. This protects a shared configuration from being removed out from under the webhooks and token requests that depend on it. Pass `forceDelete=true` to delete anyway. That detaches everything referencing it — it clears `webhookMtlsId` on each webhook and OAuth credentials, it does **not** delete them — then deletes the configuration and returns the deleted resource together with `detachedWebhookIds` and `detachedWebhookOauthIds`. Detached webhooks keep delivering notifications, and detached OAuth credentials keep requesting tokens, but without a client certificate, so an endpoint that requires mTLS will reject them from that point on. When nothing references the configuration the delete succeeds either way, and both lists come back empty. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Delete an mTLS configuration * @param {string} webhookMtlsId The unique identifier of the mTLS configuration * @param {boolean} [forceDelete] Delete the configuration even while webhooks or OAuth credentials still reference it, detaching them instead of refusing; their ids are returned in `detachedWebhookIds` and `detachedWebhookOauthIds`. Leave it unset, or `false`, to get a `409 Conflict` whenever anything still references the configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookMtlsConfig: (webhookMtlsId: string, forceDelete?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Deletes an OAuth credential set. By default the delete is refused while the credentials are still in use: if any webhook references them, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of the referencing webhooks. This protects a shared credential set from being removed out from under the webhooks that depend on it, since several webhooks may reference the same one. Pass `forceDelete=true` to delete anyway. That detaches every referencing webhook — it clears each webhook\'s `webhookOauthId`, it does **not** delete the webhook — then deletes the credential set and returns the deleted resource together with `detachedWebhookIds`. The detached webhooks keep delivering notifications, but without an `Authorization` header, so their endpoints will see unauthenticated deliveries from that point on. When nothing references the credentials the delete succeeds either way, and `detachedWebhookIds` comes back empty. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Delete OAuth credentials * @param {string} webhookOauthId The unique identifier of the OAuth credentials * @param {boolean} [forceDelete] Delete the credentials even while webhooks still reference them, detaching those webhooks instead of refusing. Leave it unset, or `false`, to get a `409 Conflict` whenever anything still references the credentials. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookOauth: (webhookOauthId: string, forceDelete?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get webhook metrics by webhook id and metric name * @summary Get webhook metrics * @param {string} webhookId * @param {GetMetricsMetricNameEnum} metricName Name of the metric to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetrics: (webhookId: string, metricName: GetMetricsMetricNameEnum, options?: RawAxiosRequestConfig) => Promise; /** * Returns the Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. The private key the CSR is built from is held by Fireblocks and is specific to this workspace. It is created on the first request for a given key type, and the same CSR is returned on subsequent requests for that type. Pass `keyAlgorithm` to choose RSA or ECDSA. A workspace may hold one key of each: the CSR returned is always the one for the type requested, so a certificate signed against it matches the key used at delivery time. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Get mTLS CSR * @param {GetMtlsCsrKeyAlgorithmEnum} [keyAlgorithm] Algorithm of the private key the CSR is generated for. ECDSA keys are smaller and quicker to issue, but the certificate authority signing the request has to accept an EC subject key, which some do not by default. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMtlsCsr: (keyAlgorithm?: GetMtlsCsrKeyAlgorithmEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get notification by id * @summary Get notification by id * @param {string} webhookId The ID of the webhook to fetch * @param {string} notificationId The ID of the notification to fetch * @param {boolean} [includeData] Include the data of the notification * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotification: (webhookId: string, notificationId: string, includeData?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get notification attempts by notification id * @summary Get notification attempts * @param {string} webhookId The ID of the webhook to fetch * @param {string} notificationId The ID of the notification to fetch * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotificationAttempts: (webhookId: string, notificationId: string, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get all notifications by webhook id (paginated) * @summary Get all notifications by webhook id * @param {string} webhookId * @param {GetNotificationsOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {GetNotificationsSortByEnum} [sortBy] Sort by field * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {number} [startTime] Start time in milliseconds since epoch to filter by notifications created after this time (default 31 days ago) * @param {number} [endTime] End time in milliseconds since epoch to filter by notifications created before this time (default current time) * @param {Array} [statuses] List of notification statuses to filter by * @param {Array} [events] List of webhook event types to filter by * @param {string} [resourceId] Resource ID to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotifications: (webhookId: string, order?: GetNotificationsOrderEnum, sortBy?: GetNotificationsSortByEnum, pageCursor?: string, pageSize?: number, startTime?: number, endTime?: number, statuses?: Array, events?: Array, resourceId?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the status of a resend by query job * @summary Get resend by query job status * @param {string} webhookId The ID of the webhook * @param {string} jobId The ID of the resend job * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResendByQueryJobStatus: (webhookId: string, jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the status of a resend job * @summary Get resend job status * @param {string} webhookId The ID of the webhook * @param {string} jobId The ID of the resend job * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResendJobStatus: (webhookId: string, jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a webhook by its id * @summary Get webhook by id * @param {string} webhookId The unique identifier of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve one stored mTLS configuration by its id. * @summary Get an mTLS configuration by id * @param {string} webhookMtlsId The unique identifier of the mTLS configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMtlsConfig: (webhookMtlsId: string, options?: RawAxiosRequestConfig) => Promise; /** * Lists the workspace\'s mTLS configurations, newest first. Pass `ids` to ask about particular ones instead — useful for resolving the `webhookMtlsId` values on a set of webhooks in one call. * @summary List the uploaded mTLS configurations * @param {Array} [ids] Return only the configurations with these ids, instead of all of them. Repeat the parameter for each id. An id belonging to another workspace, or to nothing, is left out of the response rather than failing the request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMtlsConfigs: (ids?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve an OAuth credential set by its id. The client secret is never returned. * @summary Get OAuth credentials by id * @param {string} webhookOauthId The unique identifier of the OAuth credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookOauth: (webhookOauthId: string, options?: RawAxiosRequestConfig) => Promise; /** * Lists every OAuth credential set for the workspace. Client secrets are never returned. * @summary Get all OAuth credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookOauths: (options?: RawAxiosRequestConfig) => Promise; /** * Get all webhooks (paginated). * @summary Get all webhooks * @param {GetWebhooksOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhooks: (order?: GetWebhooksOrderEnum, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig) => Promise; /** * Resend all failed notifications for a webhook in the last 24 hours Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend failed notifications * @param {ResendFailedNotificationsRequest} resendFailedNotificationsRequest * @param {string} webhookId The ID of the webhook * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendFailedNotifications: (resendFailedNotificationsRequest: ResendFailedNotificationsRequest, webhookId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Resend notification by ID Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notification by id * @param {string} webhookId The ID of the webhook * @param {string} notificationId The ID of the notification * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationById: (webhookId: string, notificationId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Resend notifications matching the given query filters (statuses, events, time range, resource ID) Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notifications by query * @param {ResendByQueryRequest} resendByQueryRequest * @param {string} webhookId The ID of the webhook * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationsByQuery: (resendByQueryRequest: ResendByQueryRequest, webhookId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Resend notifications by resource Id Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notifications by resource Id * @param {ResendNotificationsByResourceIdRequest} resendNotificationsByResourceIdRequest * @param {string} webhookId The ID of the webhook * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationsByResourceId: (resendNotificationsByResourceIdRequest: ResendNotificationsByResourceIdRequest, webhookId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update a webhook by its id Endpoint Permission: Owner, Admin, Non-Signing Admin. * @summary Update webhook * @param {UpdateWebhookRequest} updateWebhookRequest * @param {string} webhookId The unique identifier of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhook: (updateWebhookRequest: UpdateWebhookRequest, webhookId: string, options?: RawAxiosRequestConfig) => Promise; /** * Renames a configuration, replaces its certificate, or both. Only the fields present in the request are changed; anything omitted is left as it is, and a request with neither field is rejected with a `400`. Replacing `signedCert` switches every webhook and OAuth credentials set using this configuration over to the new certificate in one write, and the private key it was issued for is re-derived from the certificate. A replacement that was not issued for a private key this workspace holds is rejected with a `400`. Sending `name: null` removes the label. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Update an mTLS configuration * @param {UpdateWebhookMtlsConfigRequest} updateWebhookMtlsConfigRequest * @param {string} webhookMtlsId The unique identifier of the mTLS configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookMtlsConfig: (updateWebhookMtlsConfigRequest: UpdateWebhookMtlsConfigRequest, webhookMtlsId: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates only the fields present in the request; anything omitted is left as it is. Sending `clientSecret` on its own rotates the secret for every webhook using these credentials. `customJwtClaims`, `customBodyParams` and `customHeaders` are all merged key by key rather than replaced, the same way a webhook\'s own `customHeaders` behaves: a key sent with a value is added or overwritten, a key sent with a `null` value is deleted, and a key you omit is left alone. Setting one of the three to `null` as a whole clears that map, which is the quick way to empty it without naming every key. There is no ambiguity between the two uses of `null` — one names an entry to delete, the other names the field. A claim cannot be set to JSON `null`, though, on this endpoint or on create, because `null` is spent on deletion. `webhookMtlsId` is a scalar rather than a map, so `null` there does remove it. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Update OAuth credentials * @param {UpdateWebhookOauthRequest} updateWebhookOauthRequest * @param {string} webhookOauthId The unique identifier of the OAuth credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookOauth: (updateWebhookOauthRequest: UpdateWebhookOauthRequest, webhookOauthId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * WebhooksV2Api - functional programming interface * @export */ export declare const WebhooksV2ApiFp: (configuration?: Configuration) => { /** * Creates a new webhook, which will be triggered on the specified events **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create a new webhook * @param {CreateWebhookRequest} createWebhookRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook(createWebhookRequest: CreateWebhookRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Stores a certificate signed against the CSR from `GET /v1/webhooks_settings/mtls_csr` and returns its id, which is then set as `webhookMtlsId` on a webhook or on OAuth credentials. The private key the certificate was issued for is derived from the certificate, so it is never named by the caller. Re-uploading a certificate already stored returns the existing id rather than creating a second configuration, so several webhooks and OAuth credentials can share one certificate. A certificate that was not issued for a private key this workspace holds is rejected with a `400`. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create an mTLS configuration * @param {CreateWebhookMtlsConfigRequest} createWebhookMtlsConfigRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookMtlsConfig(createWebhookMtlsConfigRequest: CreateWebhookMtlsConfigRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a reusable OAuth client credential set. Attach it to a webhook by passing the returned id as that webhook\'s `webhookOauthId`. Several webhooks may share one credential set, so rotating its client secret covers all of them at once. The client secret is write-only and is never returned. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create OAuth credentials * @param {CreateWebhookOauthRequest} createWebhookOauthRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookOauth(createWebhookOauthRequest: CreateWebhookOauthRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a webhook by its id Endpoint Permission: Owner, Admin, Non-Signing Admin. * @summary Delete webhook * @param {string} webhookId The unique identifier of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes an mTLS configuration. By default the delete is refused while the configuration is still in use: if any webhook or OAuth credentials reference it, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of what references it. This protects a shared configuration from being removed out from under the webhooks and token requests that depend on it. Pass `forceDelete=true` to delete anyway. That detaches everything referencing it — it clears `webhookMtlsId` on each webhook and OAuth credentials, it does **not** delete them — then deletes the configuration and returns the deleted resource together with `detachedWebhookIds` and `detachedWebhookOauthIds`. Detached webhooks keep delivering notifications, and detached OAuth credentials keep requesting tokens, but without a client certificate, so an endpoint that requires mTLS will reject them from that point on. When nothing references the configuration the delete succeeds either way, and both lists come back empty. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Delete an mTLS configuration * @param {string} webhookMtlsId The unique identifier of the mTLS configuration * @param {boolean} [forceDelete] Delete the configuration even while webhooks or OAuth credentials still reference it, detaching them instead of refusing; their ids are returned in `detachedWebhookIds` and `detachedWebhookOauthIds`. Leave it unset, or `false`, to get a `409 Conflict` whenever anything still references the configuration. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookMtlsConfig(webhookMtlsId: string, forceDelete?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes an OAuth credential set. By default the delete is refused while the credentials are still in use: if any webhook references them, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of the referencing webhooks. This protects a shared credential set from being removed out from under the webhooks that depend on it, since several webhooks may reference the same one. Pass `forceDelete=true` to delete anyway. That detaches every referencing webhook — it clears each webhook\'s `webhookOauthId`, it does **not** delete the webhook — then deletes the credential set and returns the deleted resource together with `detachedWebhookIds`. The detached webhooks keep delivering notifications, but without an `Authorization` header, so their endpoints will see unauthenticated deliveries from that point on. When nothing references the credentials the delete succeeds either way, and `detachedWebhookIds` comes back empty. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Delete OAuth credentials * @param {string} webhookOauthId The unique identifier of the OAuth credentials * @param {boolean} [forceDelete] Delete the credentials even while webhooks still reference them, detaching those webhooks instead of refusing. Leave it unset, or `false`, to get a `409 Conflict` whenever anything still references the credentials. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookOauth(webhookOauthId: string, forceDelete?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get webhook metrics by webhook id and metric name * @summary Get webhook metrics * @param {string} webhookId * @param {GetMetricsMetricNameEnum} metricName Name of the metric to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetrics(webhookId: string, metricName: GetMetricsMetricNameEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. The private key the CSR is built from is held by Fireblocks and is specific to this workspace. It is created on the first request for a given key type, and the same CSR is returned on subsequent requests for that type. Pass `keyAlgorithm` to choose RSA or ECDSA. A workspace may hold one key of each: the CSR returned is always the one for the type requested, so a certificate signed against it matches the key used at delivery time. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Get mTLS CSR * @param {GetMtlsCsrKeyAlgorithmEnum} [keyAlgorithm] Algorithm of the private key the CSR is generated for. ECDSA keys are smaller and quicker to issue, but the certificate authority signing the request has to accept an EC subject key, which some do not by default. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMtlsCsr(keyAlgorithm?: GetMtlsCsrKeyAlgorithmEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get notification by id * @summary Get notification by id * @param {string} webhookId The ID of the webhook to fetch * @param {string} notificationId The ID of the notification to fetch * @param {boolean} [includeData] Include the data of the notification * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotification(webhookId: string, notificationId: string, includeData?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get notification attempts by notification id * @summary Get notification attempts * @param {string} webhookId The ID of the webhook to fetch * @param {string} notificationId The ID of the notification to fetch * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotificationAttempts(webhookId: string, notificationId: string, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all notifications by webhook id (paginated) * @summary Get all notifications by webhook id * @param {string} webhookId * @param {GetNotificationsOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {GetNotificationsSortByEnum} [sortBy] Sort by field * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {number} [startTime] Start time in milliseconds since epoch to filter by notifications created after this time (default 31 days ago) * @param {number} [endTime] End time in milliseconds since epoch to filter by notifications created before this time (default current time) * @param {Array} [statuses] List of notification statuses to filter by * @param {Array} [events] List of webhook event types to filter by * @param {string} [resourceId] Resource ID to filter by * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotifications(webhookId: string, order?: GetNotificationsOrderEnum, sortBy?: GetNotificationsSortByEnum, pageCursor?: string, pageSize?: number, startTime?: number, endTime?: number, statuses?: Array, events?: Array, resourceId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the status of a resend by query job * @summary Get resend by query job status * @param {string} webhookId The ID of the webhook * @param {string} jobId The ID of the resend job * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResendByQueryJobStatus(webhookId: string, jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the status of a resend job * @summary Get resend job status * @param {string} webhookId The ID of the webhook * @param {string} jobId The ID of the resend job * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResendJobStatus(webhookId: string, jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a webhook by its id * @summary Get webhook by id * @param {string} webhookId The unique identifier of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve one stored mTLS configuration by its id. * @summary Get an mTLS configuration by id * @param {string} webhookMtlsId The unique identifier of the mTLS configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMtlsConfig(webhookMtlsId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists the workspace\'s mTLS configurations, newest first. Pass `ids` to ask about particular ones instead — useful for resolving the `webhookMtlsId` values on a set of webhooks in one call. * @summary List the uploaded mTLS configurations * @param {Array} [ids] Return only the configurations with these ids, instead of all of them. Repeat the parameter for each id. An id belonging to another workspace, or to nothing, is left out of the response rather than failing the request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMtlsConfigs(ids?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve an OAuth credential set by its id. The client secret is never returned. * @summary Get OAuth credentials by id * @param {string} webhookOauthId The unique identifier of the OAuth credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookOauth(webhookOauthId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists every OAuth credential set for the workspace. Client secrets are never returned. * @summary Get all OAuth credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookOauths(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all webhooks (paginated). * @summary Get all webhooks * @param {GetWebhooksOrderEnum} [order] ASC / DESC ordering (default DESC) * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhooks(order?: GetWebhooksOrderEnum, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resend all failed notifications for a webhook in the last 24 hours Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend failed notifications * @param {ResendFailedNotificationsRequest} resendFailedNotificationsRequest * @param {string} webhookId The ID of the webhook * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendFailedNotifications(resendFailedNotificationsRequest: ResendFailedNotificationsRequest, webhookId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resend notification by ID Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notification by id * @param {string} webhookId The ID of the webhook * @param {string} notificationId The ID of the notification * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationById(webhookId: string, notificationId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resend notifications matching the given query filters (statuses, events, time range, resource ID) Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notifications by query * @param {ResendByQueryRequest} resendByQueryRequest * @param {string} webhookId The ID of the webhook * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationsByQuery(resendByQueryRequest: ResendByQueryRequest, webhookId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resend notifications by resource Id Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notifications by resource Id * @param {ResendNotificationsByResourceIdRequest} resendNotificationsByResourceIdRequest * @param {string} webhookId The ID of the webhook * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationsByResourceId(resendNotificationsByResourceIdRequest: ResendNotificationsByResourceIdRequest, webhookId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a webhook by its id Endpoint Permission: Owner, Admin, Non-Signing Admin. * @summary Update webhook * @param {UpdateWebhookRequest} updateWebhookRequest * @param {string} webhookId The unique identifier of the webhook * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhook(updateWebhookRequest: UpdateWebhookRequest, webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Renames a configuration, replaces its certificate, or both. Only the fields present in the request are changed; anything omitted is left as it is, and a request with neither field is rejected with a `400`. Replacing `signedCert` switches every webhook and OAuth credentials set using this configuration over to the new certificate in one write, and the private key it was issued for is re-derived from the certificate. A replacement that was not issued for a private key this workspace holds is rejected with a `400`. Sending `name: null` removes the label. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Update an mTLS configuration * @param {UpdateWebhookMtlsConfigRequest} updateWebhookMtlsConfigRequest * @param {string} webhookMtlsId The unique identifier of the mTLS configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookMtlsConfig(updateWebhookMtlsConfigRequest: UpdateWebhookMtlsConfigRequest, webhookMtlsId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates only the fields present in the request; anything omitted is left as it is. Sending `clientSecret` on its own rotates the secret for every webhook using these credentials. `customJwtClaims`, `customBodyParams` and `customHeaders` are all merged key by key rather than replaced, the same way a webhook\'s own `customHeaders` behaves: a key sent with a value is added or overwritten, a key sent with a `null` value is deleted, and a key you omit is left alone. Setting one of the three to `null` as a whole clears that map, which is the quick way to empty it without naming every key. There is no ambiguity between the two uses of `null` — one names an entry to delete, the other names the field. A claim cannot be set to JSON `null`, though, on this endpoint or on create, because `null` is spent on deletion. `webhookMtlsId` is a scalar rather than a map, so `null` there does remove it. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Update OAuth credentials * @param {UpdateWebhookOauthRequest} updateWebhookOauthRequest * @param {string} webhookOauthId The unique identifier of the OAuth credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookOauth(updateWebhookOauthRequest: UpdateWebhookOauthRequest, webhookOauthId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebhooksV2Api - factory interface * @export */ export declare const WebhooksV2ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new webhook, which will be triggered on the specified events **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create a new webhook * @param {WebhooksV2ApiCreateWebhookRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook(requestParameters: WebhooksV2ApiCreateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Stores a certificate signed against the CSR from `GET /v1/webhooks_settings/mtls_csr` and returns its id, which is then set as `webhookMtlsId` on a webhook or on OAuth credentials. The private key the certificate was issued for is derived from the certificate, so it is never named by the caller. Re-uploading a certificate already stored returns the existing id rather than creating a second configuration, so several webhooks and OAuth credentials can share one certificate. A certificate that was not issued for a private key this workspace holds is rejected with a `400`. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create an mTLS configuration * @param {WebhooksV2ApiCreateWebhookMtlsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookMtlsConfig(requestParameters: WebhooksV2ApiCreateWebhookMtlsConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a reusable OAuth client credential set. Attach it to a webhook by passing the returned id as that webhook\'s `webhookOauthId`. Several webhooks may share one credential set, so rotating its client secret covers all of them at once. The client secret is write-only and is never returned. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create OAuth credentials * @param {WebhooksV2ApiCreateWebhookOauthRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookOauth(requestParameters: WebhooksV2ApiCreateWebhookOauthRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a webhook by its id Endpoint Permission: Owner, Admin, Non-Signing Admin. * @summary Delete webhook * @param {WebhooksV2ApiDeleteWebhookRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(requestParameters: WebhooksV2ApiDeleteWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes an mTLS configuration. By default the delete is refused while the configuration is still in use: if any webhook or OAuth credentials reference it, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of what references it. This protects a shared configuration from being removed out from under the webhooks and token requests that depend on it. Pass `forceDelete=true` to delete anyway. That detaches everything referencing it — it clears `webhookMtlsId` on each webhook and OAuth credentials, it does **not** delete them — then deletes the configuration and returns the deleted resource together with `detachedWebhookIds` and `detachedWebhookOauthIds`. Detached webhooks keep delivering notifications, and detached OAuth credentials keep requesting tokens, but without a client certificate, so an endpoint that requires mTLS will reject them from that point on. When nothing references the configuration the delete succeeds either way, and both lists come back empty. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Delete an mTLS configuration * @param {WebhooksV2ApiDeleteWebhookMtlsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookMtlsConfig(requestParameters: WebhooksV2ApiDeleteWebhookMtlsConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes an OAuth credential set. By default the delete is refused while the credentials are still in use: if any webhook references them, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of the referencing webhooks. This protects a shared credential set from being removed out from under the webhooks that depend on it, since several webhooks may reference the same one. Pass `forceDelete=true` to delete anyway. That detaches every referencing webhook — it clears each webhook\'s `webhookOauthId`, it does **not** delete the webhook — then deletes the credential set and returns the deleted resource together with `detachedWebhookIds`. The detached webhooks keep delivering notifications, but without an `Authorization` header, so their endpoints will see unauthenticated deliveries from that point on. When nothing references the credentials the delete succeeds either way, and `detachedWebhookIds` comes back empty. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Delete OAuth credentials * @param {WebhooksV2ApiDeleteWebhookOauthRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookOauth(requestParameters: WebhooksV2ApiDeleteWebhookOauthRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get webhook metrics by webhook id and metric name * @summary Get webhook metrics * @param {WebhooksV2ApiGetMetricsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetrics(requestParameters: WebhooksV2ApiGetMetricsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. The private key the CSR is built from is held by Fireblocks and is specific to this workspace. It is created on the first request for a given key type, and the same CSR is returned on subsequent requests for that type. Pass `keyAlgorithm` to choose RSA or ECDSA. A workspace may hold one key of each: the CSR returned is always the one for the type requested, so a certificate signed against it matches the key used at delivery time. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Get mTLS CSR * @param {WebhooksV2ApiGetMtlsCsrRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMtlsCsr(requestParameters?: WebhooksV2ApiGetMtlsCsrRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get notification by id * @summary Get notification by id * @param {WebhooksV2ApiGetNotificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotification(requestParameters: WebhooksV2ApiGetNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get notification attempts by notification id * @summary Get notification attempts * @param {WebhooksV2ApiGetNotificationAttemptsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotificationAttempts(requestParameters: WebhooksV2ApiGetNotificationAttemptsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get all notifications by webhook id (paginated) * @summary Get all notifications by webhook id * @param {WebhooksV2ApiGetNotificationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNotifications(requestParameters: WebhooksV2ApiGetNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the status of a resend by query job * @summary Get resend by query job status * @param {WebhooksV2ApiGetResendByQueryJobStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResendByQueryJobStatus(requestParameters: WebhooksV2ApiGetResendByQueryJobStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the status of a resend job * @summary Get resend job status * @param {WebhooksV2ApiGetResendJobStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResendJobStatus(requestParameters: WebhooksV2ApiGetResendJobStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a webhook by its id * @summary Get webhook by id * @param {WebhooksV2ApiGetWebhookRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(requestParameters: WebhooksV2ApiGetWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve one stored mTLS configuration by its id. * @summary Get an mTLS configuration by id * @param {WebhooksV2ApiGetWebhookMtlsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMtlsConfig(requestParameters: WebhooksV2ApiGetWebhookMtlsConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists the workspace\'s mTLS configurations, newest first. Pass `ids` to ask about particular ones instead — useful for resolving the `webhookMtlsId` values on a set of webhooks in one call. * @summary List the uploaded mTLS configurations * @param {WebhooksV2ApiGetWebhookMtlsConfigsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMtlsConfigs(requestParameters?: WebhooksV2ApiGetWebhookMtlsConfigsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve an OAuth credential set by its id. The client secret is never returned. * @summary Get OAuth credentials by id * @param {WebhooksV2ApiGetWebhookOauthRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookOauth(requestParameters: WebhooksV2ApiGetWebhookOauthRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists every OAuth credential set for the workspace. Client secrets are never returned. * @summary Get all OAuth credentials * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookOauths(options?: RawAxiosRequestConfig): AxiosPromise; /** * Get all webhooks (paginated). * @summary Get all webhooks * @param {WebhooksV2ApiGetWebhooksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhooks(requestParameters?: WebhooksV2ApiGetWebhooksRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resend all failed notifications for a webhook in the last 24 hours Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend failed notifications * @param {WebhooksV2ApiResendFailedNotificationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendFailedNotifications(requestParameters: WebhooksV2ApiResendFailedNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resend notification by ID Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notification by id * @param {WebhooksV2ApiResendNotificationByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationById(requestParameters: WebhooksV2ApiResendNotificationByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resend notifications matching the given query filters (statuses, events, time range, resource ID) Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notifications by query * @param {WebhooksV2ApiResendNotificationsByQueryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationsByQuery(requestParameters: WebhooksV2ApiResendNotificationsByQueryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resend notifications by resource Id Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notifications by resource Id * @param {WebhooksV2ApiResendNotificationsByResourceIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendNotificationsByResourceId(requestParameters: WebhooksV2ApiResendNotificationsByResourceIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update a webhook by its id Endpoint Permission: Owner, Admin, Non-Signing Admin. * @summary Update webhook * @param {WebhooksV2ApiUpdateWebhookRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhook(requestParameters: WebhooksV2ApiUpdateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Renames a configuration, replaces its certificate, or both. Only the fields present in the request are changed; anything omitted is left as it is, and a request with neither field is rejected with a `400`. Replacing `signedCert` switches every webhook and OAuth credentials set using this configuration over to the new certificate in one write, and the private key it was issued for is re-derived from the certificate. A replacement that was not issued for a private key this workspace holds is rejected with a `400`. Sending `name: null` removes the label. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Update an mTLS configuration * @param {WebhooksV2ApiUpdateWebhookMtlsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookMtlsConfig(requestParameters: WebhooksV2ApiUpdateWebhookMtlsConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates only the fields present in the request; anything omitted is left as it is. Sending `clientSecret` on its own rotates the secret for every webhook using these credentials. `customJwtClaims`, `customBodyParams` and `customHeaders` are all merged key by key rather than replaced, the same way a webhook\'s own `customHeaders` behaves: a key sent with a value is added or overwritten, a key sent with a `null` value is deleted, and a key you omit is left alone. Setting one of the three to `null` as a whole clears that map, which is the quick way to empty it without naming every key. There is no ambiguity between the two uses of `null` — one names an entry to delete, the other names the field. A claim cannot be set to JSON `null`, though, on this endpoint or on create, because `null` is spent on deletion. `webhookMtlsId` is a scalar rather than a map, so `null` there does remove it. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Update OAuth credentials * @param {WebhooksV2ApiUpdateWebhookOauthRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookOauth(requestParameters: WebhooksV2ApiUpdateWebhookOauthRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createWebhook operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiCreateWebhookRequest */ export interface WebhooksV2ApiCreateWebhookRequest { /** * * @type {CreateWebhookRequest} * @memberof WebhooksV2ApiCreateWebhook */ readonly createWebhookRequest: CreateWebhookRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof WebhooksV2ApiCreateWebhook */ readonly idempotencyKey?: string; } /** * Request parameters for createWebhookMtlsConfig operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiCreateWebhookMtlsConfigRequest */ export interface WebhooksV2ApiCreateWebhookMtlsConfigRequest { /** * * @type {CreateWebhookMtlsConfigRequest} * @memberof WebhooksV2ApiCreateWebhookMtlsConfig */ readonly createWebhookMtlsConfigRequest: CreateWebhookMtlsConfigRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof WebhooksV2ApiCreateWebhookMtlsConfig */ readonly idempotencyKey?: string; } /** * Request parameters for createWebhookOauth operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiCreateWebhookOauthRequest */ export interface WebhooksV2ApiCreateWebhookOauthRequest { /** * * @type {CreateWebhookOauthRequest} * @memberof WebhooksV2ApiCreateWebhookOauth */ readonly createWebhookOauthRequest: CreateWebhookOauthRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof WebhooksV2ApiCreateWebhookOauth */ readonly idempotencyKey?: string; } /** * Request parameters for deleteWebhook operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiDeleteWebhookRequest */ export interface WebhooksV2ApiDeleteWebhookRequest { /** * The unique identifier of the webhook * @type {string} * @memberof WebhooksV2ApiDeleteWebhook */ readonly webhookId: string; } /** * Request parameters for deleteWebhookMtlsConfig operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiDeleteWebhookMtlsConfigRequest */ export interface WebhooksV2ApiDeleteWebhookMtlsConfigRequest { /** * The unique identifier of the mTLS configuration * @type {string} * @memberof WebhooksV2ApiDeleteWebhookMtlsConfig */ readonly webhookMtlsId: string; /** * Delete the configuration even while webhooks or OAuth credentials still reference it, detaching them instead of refusing; their ids are returned in `detachedWebhookIds` and `detachedWebhookOauthIds`. Leave it unset, or `false`, to get a `409 Conflict` whenever anything still references the configuration. * @type {boolean} * @memberof WebhooksV2ApiDeleteWebhookMtlsConfig */ readonly forceDelete?: boolean; } /** * Request parameters for deleteWebhookOauth operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiDeleteWebhookOauthRequest */ export interface WebhooksV2ApiDeleteWebhookOauthRequest { /** * The unique identifier of the OAuth credentials * @type {string} * @memberof WebhooksV2ApiDeleteWebhookOauth */ readonly webhookOauthId: string; /** * Delete the credentials even while webhooks still reference them, detaching those webhooks instead of refusing. Leave it unset, or `false`, to get a `409 Conflict` whenever anything still references the credentials. * @type {boolean} * @memberof WebhooksV2ApiDeleteWebhookOauth */ readonly forceDelete?: boolean; } /** * Request parameters for getMetrics operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetMetricsRequest */ export interface WebhooksV2ApiGetMetricsRequest { /** * * @type {string} * @memberof WebhooksV2ApiGetMetrics */ readonly webhookId: string; /** * Name of the metric to retrieve * @type {'LAST_ACTIVE_HOUR_ERROR_RATE'} * @memberof WebhooksV2ApiGetMetrics */ readonly metricName: GetMetricsMetricNameEnum; } /** * Request parameters for getMtlsCsr operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetMtlsCsrRequest */ export interface WebhooksV2ApiGetMtlsCsrRequest { /** * Algorithm of the private key the CSR is generated for. ECDSA keys are smaller and quicker to issue, but the certificate authority signing the request has to accept an EC subject key, which some do not by default. * @type {'RSA' | 'ECDSA'} * @memberof WebhooksV2ApiGetMtlsCsr */ readonly keyAlgorithm?: GetMtlsCsrKeyAlgorithmEnum; } /** * Request parameters for getNotification operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetNotificationRequest */ export interface WebhooksV2ApiGetNotificationRequest { /** * The ID of the webhook to fetch * @type {string} * @memberof WebhooksV2ApiGetNotification */ readonly webhookId: string; /** * The ID of the notification to fetch * @type {string} * @memberof WebhooksV2ApiGetNotification */ readonly notificationId: string; /** * Include the data of the notification * @type {boolean} * @memberof WebhooksV2ApiGetNotification */ readonly includeData?: boolean; } /** * Request parameters for getNotificationAttempts operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetNotificationAttemptsRequest */ export interface WebhooksV2ApiGetNotificationAttemptsRequest { /** * The ID of the webhook to fetch * @type {string} * @memberof WebhooksV2ApiGetNotificationAttempts */ readonly webhookId: string; /** * The ID of the notification to fetch * @type {string} * @memberof WebhooksV2ApiGetNotificationAttempts */ readonly notificationId: string; /** * Cursor of the required page * @type {string} * @memberof WebhooksV2ApiGetNotificationAttempts */ readonly pageCursor?: string; /** * Maximum number of items in the page * @type {number} * @memberof WebhooksV2ApiGetNotificationAttempts */ readonly pageSize?: number; } /** * Request parameters for getNotifications operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetNotificationsRequest */ export interface WebhooksV2ApiGetNotificationsRequest { /** * * @type {string} * @memberof WebhooksV2ApiGetNotifications */ readonly webhookId: string; /** * ASC / DESC ordering (default DESC) * @type {'ASC' | 'DESC'} * @memberof WebhooksV2ApiGetNotifications */ readonly order?: GetNotificationsOrderEnum; /** * Sort by field * @type {'id' | 'createdAt' | 'updatedAt' | 'status' | 'eventType' | 'resourceId'} * @memberof WebhooksV2ApiGetNotifications */ readonly sortBy?: GetNotificationsSortByEnum; /** * Cursor of the required page * @type {string} * @memberof WebhooksV2ApiGetNotifications */ readonly pageCursor?: string; /** * Maximum number of items in the page * @type {number} * @memberof WebhooksV2ApiGetNotifications */ readonly pageSize?: number; /** * Start time in milliseconds since epoch to filter by notifications created after this time (default 31 days ago) * @type {number} * @memberof WebhooksV2ApiGetNotifications */ readonly startTime?: number; /** * End time in milliseconds since epoch to filter by notifications created before this time (default current time) * @type {number} * @memberof WebhooksV2ApiGetNotifications */ readonly endTime?: number; /** * List of notification statuses to filter by * @type {Array} * @memberof WebhooksV2ApiGetNotifications */ readonly statuses?: Array; /** * List of webhook event types to filter by * @type {Array} * @memberof WebhooksV2ApiGetNotifications */ readonly events?: Array; /** * Resource ID to filter by * @type {string} * @memberof WebhooksV2ApiGetNotifications */ readonly resourceId?: string; } /** * Request parameters for getResendByQueryJobStatus operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetResendByQueryJobStatusRequest */ export interface WebhooksV2ApiGetResendByQueryJobStatusRequest { /** * The ID of the webhook * @type {string} * @memberof WebhooksV2ApiGetResendByQueryJobStatus */ readonly webhookId: string; /** * The ID of the resend job * @type {string} * @memberof WebhooksV2ApiGetResendByQueryJobStatus */ readonly jobId: string; } /** * Request parameters for getResendJobStatus operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetResendJobStatusRequest */ export interface WebhooksV2ApiGetResendJobStatusRequest { /** * The ID of the webhook * @type {string} * @memberof WebhooksV2ApiGetResendJobStatus */ readonly webhookId: string; /** * The ID of the resend job * @type {string} * @memberof WebhooksV2ApiGetResendJobStatus */ readonly jobId: string; } /** * Request parameters for getWebhook operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetWebhookRequest */ export interface WebhooksV2ApiGetWebhookRequest { /** * The unique identifier of the webhook * @type {string} * @memberof WebhooksV2ApiGetWebhook */ readonly webhookId: string; } /** * Request parameters for getWebhookMtlsConfig operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetWebhookMtlsConfigRequest */ export interface WebhooksV2ApiGetWebhookMtlsConfigRequest { /** * The unique identifier of the mTLS configuration * @type {string} * @memberof WebhooksV2ApiGetWebhookMtlsConfig */ readonly webhookMtlsId: string; } /** * Request parameters for getWebhookMtlsConfigs operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetWebhookMtlsConfigsRequest */ export interface WebhooksV2ApiGetWebhookMtlsConfigsRequest { /** * Return only the configurations with these ids, instead of all of them. Repeat the parameter for each id. An id belonging to another workspace, or to nothing, is left out of the response rather than failing the request. * @type {Array} * @memberof WebhooksV2ApiGetWebhookMtlsConfigs */ readonly ids?: Array; } /** * Request parameters for getWebhookOauth operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetWebhookOauthRequest */ export interface WebhooksV2ApiGetWebhookOauthRequest { /** * The unique identifier of the OAuth credentials * @type {string} * @memberof WebhooksV2ApiGetWebhookOauth */ readonly webhookOauthId: string; } /** * Request parameters for getWebhooks operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiGetWebhooksRequest */ export interface WebhooksV2ApiGetWebhooksRequest { /** * ASC / DESC ordering (default DESC) * @type {'ASC' | 'DESC'} * @memberof WebhooksV2ApiGetWebhooks */ readonly order?: GetWebhooksOrderEnum; /** * Cursor of the required page * @type {string} * @memberof WebhooksV2ApiGetWebhooks */ readonly pageCursor?: string; /** * Maximum number of items in the page * @type {number} * @memberof WebhooksV2ApiGetWebhooks */ readonly pageSize?: number; } /** * Request parameters for resendFailedNotifications operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiResendFailedNotificationsRequest */ export interface WebhooksV2ApiResendFailedNotificationsRequest { /** * * @type {ResendFailedNotificationsRequest} * @memberof WebhooksV2ApiResendFailedNotifications */ readonly resendFailedNotificationsRequest: ResendFailedNotificationsRequest; /** * The ID of the webhook * @type {string} * @memberof WebhooksV2ApiResendFailedNotifications */ readonly webhookId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof WebhooksV2ApiResendFailedNotifications */ readonly idempotencyKey?: string; } /** * Request parameters for resendNotificationById operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiResendNotificationByIdRequest */ export interface WebhooksV2ApiResendNotificationByIdRequest { /** * The ID of the webhook * @type {string} * @memberof WebhooksV2ApiResendNotificationById */ readonly webhookId: string; /** * The ID of the notification * @type {string} * @memberof WebhooksV2ApiResendNotificationById */ readonly notificationId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof WebhooksV2ApiResendNotificationById */ readonly idempotencyKey?: string; } /** * Request parameters for resendNotificationsByQuery operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiResendNotificationsByQueryRequest */ export interface WebhooksV2ApiResendNotificationsByQueryRequest { /** * * @type {ResendByQueryRequest} * @memberof WebhooksV2ApiResendNotificationsByQuery */ readonly resendByQueryRequest: ResendByQueryRequest; /** * The ID of the webhook * @type {string} * @memberof WebhooksV2ApiResendNotificationsByQuery */ readonly webhookId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof WebhooksV2ApiResendNotificationsByQuery */ readonly idempotencyKey?: string; } /** * Request parameters for resendNotificationsByResourceId operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiResendNotificationsByResourceIdRequest */ export interface WebhooksV2ApiResendNotificationsByResourceIdRequest { /** * * @type {ResendNotificationsByResourceIdRequest} * @memberof WebhooksV2ApiResendNotificationsByResourceId */ readonly resendNotificationsByResourceIdRequest: ResendNotificationsByResourceIdRequest; /** * The ID of the webhook * @type {string} * @memberof WebhooksV2ApiResendNotificationsByResourceId */ readonly webhookId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof WebhooksV2ApiResendNotificationsByResourceId */ readonly idempotencyKey?: string; } /** * Request parameters for updateWebhook operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiUpdateWebhookRequest */ export interface WebhooksV2ApiUpdateWebhookRequest { /** * * @type {UpdateWebhookRequest} * @memberof WebhooksV2ApiUpdateWebhook */ readonly updateWebhookRequest: UpdateWebhookRequest; /** * The unique identifier of the webhook * @type {string} * @memberof WebhooksV2ApiUpdateWebhook */ readonly webhookId: string; } /** * Request parameters for updateWebhookMtlsConfig operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiUpdateWebhookMtlsConfigRequest */ export interface WebhooksV2ApiUpdateWebhookMtlsConfigRequest { /** * * @type {UpdateWebhookMtlsConfigRequest} * @memberof WebhooksV2ApiUpdateWebhookMtlsConfig */ readonly updateWebhookMtlsConfigRequest: UpdateWebhookMtlsConfigRequest; /** * The unique identifier of the mTLS configuration * @type {string} * @memberof WebhooksV2ApiUpdateWebhookMtlsConfig */ readonly webhookMtlsId: string; } /** * Request parameters for updateWebhookOauth operation in WebhooksV2Api. * @export * @interface WebhooksV2ApiUpdateWebhookOauthRequest */ export interface WebhooksV2ApiUpdateWebhookOauthRequest { /** * * @type {UpdateWebhookOauthRequest} * @memberof WebhooksV2ApiUpdateWebhookOauth */ readonly updateWebhookOauthRequest: UpdateWebhookOauthRequest; /** * The unique identifier of the OAuth credentials * @type {string} * @memberof WebhooksV2ApiUpdateWebhookOauth */ readonly webhookOauthId: string; } /** * WebhooksV2Api - object-oriented interface * @export * @class WebhooksV2Api * @extends {BaseAPI} */ export declare class WebhooksV2Api extends BaseAPI { /** * Creates a new webhook, which will be triggered on the specified events **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create a new webhook * @param {WebhooksV2ApiCreateWebhookRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ createWebhook(requestParameters: WebhooksV2ApiCreateWebhookRequest): Promise>; /** * Stores a certificate signed against the CSR from `GET /v1/webhooks_settings/mtls_csr` and returns its id, which is then set as `webhookMtlsId` on a webhook or on OAuth credentials. The private key the certificate was issued for is derived from the certificate, so it is never named by the caller. Re-uploading a certificate already stored returns the existing id rather than creating a second configuration, so several webhooks and OAuth credentials can share one certificate. A certificate that was not issued for a private key this workspace holds is rejected with a `400`. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create an mTLS configuration * @param {WebhooksV2ApiCreateWebhookMtlsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ createWebhookMtlsConfig(requestParameters: WebhooksV2ApiCreateWebhookMtlsConfigRequest): Promise>; /** * Creates a reusable OAuth client credential set. Attach it to a webhook by passing the returned id as that webhook\'s `webhookOauthId`. Several webhooks may share one credential set, so rotating its client secret covers all of them at once. The client secret is write-only and is never returned. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Create OAuth credentials * @param {WebhooksV2ApiCreateWebhookOauthRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ createWebhookOauth(requestParameters: WebhooksV2ApiCreateWebhookOauthRequest): Promise>; /** * Delete a webhook by its id Endpoint Permission: Owner, Admin, Non-Signing Admin. * @summary Delete webhook * @param {WebhooksV2ApiDeleteWebhookRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ deleteWebhook(requestParameters: WebhooksV2ApiDeleteWebhookRequest): Promise>; /** * Deletes an mTLS configuration. By default the delete is refused while the configuration is still in use: if any webhook or OAuth credentials reference it, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of what references it. This protects a shared configuration from being removed out from under the webhooks and token requests that depend on it. Pass `forceDelete=true` to delete anyway. That detaches everything referencing it — it clears `webhookMtlsId` on each webhook and OAuth credentials, it does **not** delete them — then deletes the configuration and returns the deleted resource together with `detachedWebhookIds` and `detachedWebhookOauthIds`. Detached webhooks keep delivering notifications, and detached OAuth credentials keep requesting tokens, but without a client certificate, so an endpoint that requires mTLS will reject them from that point on. When nothing references the configuration the delete succeeds either way, and both lists come back empty. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Delete an mTLS configuration * @param {WebhooksV2ApiDeleteWebhookMtlsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ deleteWebhookMtlsConfig(requestParameters: WebhooksV2ApiDeleteWebhookMtlsConfigRequest): Promise>; /** * Deletes an OAuth credential set. By default the delete is refused while the credentials are still in use: if any webhook references them, nothing is deleted and the request fails with `409 Conflict`, naming the reason and listing the ids of the referencing webhooks. This protects a shared credential set from being removed out from under the webhooks that depend on it, since several webhooks may reference the same one. Pass `forceDelete=true` to delete anyway. That detaches every referencing webhook — it clears each webhook\'s `webhookOauthId`, it does **not** delete the webhook — then deletes the credential set and returns the deleted resource together with `detachedWebhookIds`. The detached webhooks keep delivering notifications, but without an `Authorization` header, so their endpoints will see unauthenticated deliveries from that point on. When nothing references the credentials the delete succeeds either way, and `detachedWebhookIds` comes back empty. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Delete OAuth credentials * @param {WebhooksV2ApiDeleteWebhookOauthRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ deleteWebhookOauth(requestParameters: WebhooksV2ApiDeleteWebhookOauthRequest): Promise>; /** * Get webhook metrics by webhook id and metric name * @summary Get webhook metrics * @param {WebhooksV2ApiGetMetricsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getMetrics(requestParameters: WebhooksV2ApiGetMetricsRequest): Promise>; /** * Returns the Certificate Signing Request (CSR) PEM that customers use to generate their signed client certificate. The private key the CSR is built from is held by Fireblocks and is specific to this workspace. It is created on the first request for a given key type, and the same CSR is returned on subsequent requests for that type. Pass `keyAlgorithm` to choose RSA or ECDSA. A workspace may hold one key of each: the CSR returned is always the one for the type requested, so a certificate signed against it matches the key used at delivery time. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Get mTLS CSR * @param {WebhooksV2ApiGetMtlsCsrRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getMtlsCsr(requestParameters?: WebhooksV2ApiGetMtlsCsrRequest): Promise>; /** * Get notification by id * @summary Get notification by id * @param {WebhooksV2ApiGetNotificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getNotification(requestParameters: WebhooksV2ApiGetNotificationRequest): Promise>; /** * Get notification attempts by notification id * @summary Get notification attempts * @param {WebhooksV2ApiGetNotificationAttemptsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getNotificationAttempts(requestParameters: WebhooksV2ApiGetNotificationAttemptsRequest): Promise>; /** * Get all notifications by webhook id (paginated) * @summary Get all notifications by webhook id * @param {WebhooksV2ApiGetNotificationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getNotifications(requestParameters: WebhooksV2ApiGetNotificationsRequest): Promise>; /** * Get the status of a resend by query job * @summary Get resend by query job status * @param {WebhooksV2ApiGetResendByQueryJobStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getResendByQueryJobStatus(requestParameters: WebhooksV2ApiGetResendByQueryJobStatusRequest): Promise>; /** * Get the status of a resend job * @summary Get resend job status * @param {WebhooksV2ApiGetResendJobStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getResendJobStatus(requestParameters: WebhooksV2ApiGetResendJobStatusRequest): Promise>; /** * Retrieve a webhook by its id * @summary Get webhook by id * @param {WebhooksV2ApiGetWebhookRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getWebhook(requestParameters: WebhooksV2ApiGetWebhookRequest): Promise>; /** * Retrieve one stored mTLS configuration by its id. * @summary Get an mTLS configuration by id * @param {WebhooksV2ApiGetWebhookMtlsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getWebhookMtlsConfig(requestParameters: WebhooksV2ApiGetWebhookMtlsConfigRequest): Promise>; /** * Lists the workspace\'s mTLS configurations, newest first. Pass `ids` to ask about particular ones instead — useful for resolving the `webhookMtlsId` values on a set of webhooks in one call. * @summary List the uploaded mTLS configurations * @param {WebhooksV2ApiGetWebhookMtlsConfigsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getWebhookMtlsConfigs(requestParameters?: WebhooksV2ApiGetWebhookMtlsConfigsRequest): Promise>; /** * Retrieve an OAuth credential set by its id. The client secret is never returned. * @summary Get OAuth credentials by id * @param {WebhooksV2ApiGetWebhookOauthRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getWebhookOauth(requestParameters: WebhooksV2ApiGetWebhookOauthRequest): Promise>; /** * Lists every OAuth credential set for the workspace. Client secrets are never returned. * @summary Get all OAuth credentials * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getWebhookOauths(): Promise>; /** * Get all webhooks (paginated). * @summary Get all webhooks * @param {WebhooksV2ApiGetWebhooksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ getWebhooks(requestParameters?: WebhooksV2ApiGetWebhooksRequest): Promise>; /** * Resend all failed notifications for a webhook in the last 24 hours Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend failed notifications * @param {WebhooksV2ApiResendFailedNotificationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ resendFailedNotifications(requestParameters: WebhooksV2ApiResendFailedNotificationsRequest): Promise>; /** * Resend notification by ID Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notification by id * @param {WebhooksV2ApiResendNotificationByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ resendNotificationById(requestParameters: WebhooksV2ApiResendNotificationByIdRequest): Promise>; /** * Resend notifications matching the given query filters (statuses, events, time range, resource ID) Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notifications by query * @param {WebhooksV2ApiResendNotificationsByQueryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ resendNotificationsByQuery(requestParameters: WebhooksV2ApiResendNotificationsByQueryRequest): Promise>; /** * Resend notifications by resource Id Endpoint Permission: Owner, Admin, Non-Signing Admin, Editor, Signer. * @summary Resend notifications by resource Id * @param {WebhooksV2ApiResendNotificationsByResourceIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ resendNotificationsByResourceId(requestParameters: WebhooksV2ApiResendNotificationsByResourceIdRequest): Promise>; /** * Update a webhook by its id Endpoint Permission: Owner, Admin, Non-Signing Admin. * @summary Update webhook * @param {WebhooksV2ApiUpdateWebhookRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ updateWebhook(requestParameters: WebhooksV2ApiUpdateWebhookRequest): Promise>; /** * Renames a configuration, replaces its certificate, or both. Only the fields present in the request are changed; anything omitted is left as it is, and a request with neither field is rejected with a `400`. Replacing `signedCert` switches every webhook and OAuth credentials set using this configuration over to the new certificate in one write, and the private key it was issued for is re-derived from the certificate. A replacement that was not issued for a private key this workspace holds is rejected with a `400`. Sending `name: null` removes the label. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Update an mTLS configuration * @param {WebhooksV2ApiUpdateWebhookMtlsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ updateWebhookMtlsConfig(requestParameters: WebhooksV2ApiUpdateWebhookMtlsConfigRequest): Promise>; /** * Updates only the fields present in the request; anything omitted is left as it is. Sending `clientSecret` on its own rotates the secret for every webhook using these credentials. `customJwtClaims`, `customBodyParams` and `customHeaders` are all merged key by key rather than replaced, the same way a webhook\'s own `customHeaders` behaves: a key sent with a value is added or overwritten, a key sent with a `null` value is deleted, and a key you omit is left alone. Setting one of the three to `null` as a whole clears that map, which is the quick way to empty it without naming every key. There is no ambiguity between the two uses of `null` — one names an entry to delete, the other names the field. A claim cannot be set to JSON `null`, though, on this endpoint or on create, because `null` is spent on deletion. `webhookMtlsId` is a scalar rather than a map, so `null` there does remove it. **Endpoint Permissions:** Owner, Admin, Non-Signing Admin. * @summary Update OAuth credentials * @param {WebhooksV2ApiUpdateWebhookOauthRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksV2Api */ updateWebhookOauth(requestParameters: WebhooksV2ApiUpdateWebhookOauthRequest): Promise>; } /** * @export */ export declare const GetMetricsMetricNameEnum: { readonly LastActiveHourErrorRate: "LAST_ACTIVE_HOUR_ERROR_RATE"; }; export type GetMetricsMetricNameEnum = typeof GetMetricsMetricNameEnum[keyof typeof GetMetricsMetricNameEnum]; /** * @export */ export declare const GetMtlsCsrKeyAlgorithmEnum: { readonly Rsa: "RSA"; readonly Ecdsa: "ECDSA"; }; export type GetMtlsCsrKeyAlgorithmEnum = typeof GetMtlsCsrKeyAlgorithmEnum[keyof typeof GetMtlsCsrKeyAlgorithmEnum]; /** * @export */ export declare const GetNotificationsOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetNotificationsOrderEnum = typeof GetNotificationsOrderEnum[keyof typeof GetNotificationsOrderEnum]; /** * @export */ export declare const GetNotificationsSortByEnum: { readonly Id: "id"; readonly CreatedAt: "createdAt"; readonly UpdatedAt: "updatedAt"; readonly Status: "status"; readonly EventType: "eventType"; readonly ResourceId: "resourceId"; }; export type GetNotificationsSortByEnum = typeof GetNotificationsSortByEnum[keyof typeof GetNotificationsSortByEnum]; /** * @export */ export declare const GetWebhooksOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetWebhooksOrderEnum = typeof GetWebhooksOrderEnum[keyof typeof GetWebhooksOrderEnum];