@randock/nameshift-api-client 0.0.535 → 0.0.536

package/.openapi-generator/FILES

@@ -40,6 +40,7 @@ src/apis/TasksApi.ts
 src/apis/TaxPublicApi.ts
 src/apis/UsersApi.ts
 src/apis/UsersPublicApi.ts
+src/apis/WebhooksApi.ts
 src/apis/index.ts
 src/index.ts
 src/models/AccountAliasDto.ts
@@ -254,6 +255,7 @@ src/models/CreateOrderInput.ts
 src/models/CreateSubscriptionBillingPeriodicityInput.ts
 src/models/CreateSubscriptionInput.ts
 src/models/CreateSubscriptionManualTransactionInput.ts
+src/models/CreateWebhookEndpointInput.ts
 src/models/CreatedApiKeyDto.ts
 src/models/CurrentPasswordInput.ts
 src/models/CursorBasedPageInfo.ts
@@ -679,6 +681,7 @@ src/models/UpdateTaskMuteStatusForBuyerInput.ts
 src/models/UpdateTaskMuteStatusInput.ts
 src/models/UpdateUserNewsletterSubscriptionInput.ts
 src/models/UpdateUserNotificationSettingsInput.ts
+src/models/UpdateWebhookEndpointInput.ts
 src/models/UserLoginAttemptDto.ts
 src/models/UserLoginAttemptMethod.ts
 src/models/UserLoginAttemptResult.ts
@@ -700,6 +703,23 @@ src/models/ValidationException.ts
 src/models/VerifyEmailOtpInput.ts
 src/models/VerifyLeadInput.ts
 src/models/VerifyPhoneOtpInput.ts
+src/models/WebhookAttemptTrigger.ts
+src/models/WebhookDeliveriesSummaryDto.ts
+src/models/WebhookDeliveryAttemptDto.ts
+src/models/WebhookDeliveryDto.ts
+src/models/WebhookDeliveryStatus.ts
+src/models/WebhookEndpointDto.ts
+src/models/WebhookEndpointHeaderDto.ts
+src/models/WebhookEndpointHeaderInput.ts
+src/models/WebhookEndpointHeadersDto.ts
+src/models/WebhookEndpointSecretDto.ts
+src/models/WebhookEndpointStatus.ts
+src/models/WebhookEventTypeDto.ts
+src/models/WebhookMessageDetailDto.ts
+src/models/WebhookMessageDto.ts
+src/models/WebhookMessagePageDto.ts
+src/models/WebhookMessagePageMetaDto.ts
+src/models/WebhookMessageStatus.ts
 src/models/WithSettingsInner.ts
 src/models/index.ts
 src/runtime.ts

package/README.md

@@ -1,4 +1,4 @@
-## @randock/nameshift-api-client@0.0.535
+## @randock/nameshift-api-client@0.0.536
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @randock/nameshift-api-client@0.0.535 --save
+npm install @randock/nameshift-api-client@0.0.536 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,4 +44,4 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
-1b3487fa006bfd8d98e0fcfac39492a48b106b38045a4c035d744ee29bfaf10f9f136bb1438fb1c7aa5459d1f82a259f
+f425fd61d0fcd03321b3696a88d73ab4b840add1991527221f49c5ac45e0162b1027178389c266bc6d48e54bf1e29997

package/dist/apis/WebhooksApi.d.ts

@@ -0,0 +1,186 @@
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateWebhookEndpointInput, UpdateWebhookEndpointInput, WebhookDeliveryStatus, WebhookEndpointDto, WebhookEndpointHeadersDto, WebhookEndpointSecretDto, WebhookEventTypeDto, WebhookMessageDetailDto, WebhookMessagePageDto } from '../models/index';
+export interface WebhooksApiCreateWebhookEndpointRequest {
+    createWebhookEndpointInput: CreateWebhookEndpointInput;
+}
+export interface WebhooksApiDeleteWebhookEndpointRequest {
+    endpointId: string;
+}
+export interface WebhooksApiGetWebhookEndpointRequest {
+    endpointId: string;
+}
+export interface WebhooksApiGetWebhookEndpointHeadersRequest {
+    endpointId: string;
+}
+export interface WebhooksApiGetWebhookEndpointSecretRequest {
+    endpointId: string;
+}
+export interface WebhooksApiGetWebhookMessageRequest {
+    messageId: string;
+}
+export interface WebhooksApiGetWebhookMessagesRequest {
+    page?: number;
+    limit?: number;
+    endpointId?: string;
+    eventType?: string;
+    deliveryStatus?: WebhookDeliveryStatus;
+}
+export interface WebhooksApiRetryWebhookDeliveryRequest {
+    deliveryId: string;
+}
+export interface WebhooksApiRotateWebhookEndpointSecretRequest {
+    endpointId: string;
+}
+export interface WebhooksApiSendWebhookEndpointTestRequest {
+    endpointId: string;
+}
+export interface WebhooksApiUpdateWebhookEndpointRequest {
+    endpointId: string;
+    updateWebhookEndpointInput: UpdateWebhookEndpointInput;
+}
+/**
+ *
+ */
+export declare class WebhooksApi extends runtime.BaseAPI {
+    /**
+     * Adds a URL that starts receiving the chosen event types, signed with a secret of its own.
+     * Create a webhook endpoint
+     */
+    createWebhookEndpointRaw(requestParameters: WebhooksApiCreateWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Adds a URL that starts receiving the chosen event types, signed with a secret of its own.
+     * Create a webhook endpoint
+     */
+    createWebhookEndpoint(requestParameters: WebhooksApiCreateWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Removes an endpoint. Nothing is sent to it anymore, retries included.
+     * Delete a webhook endpoint
+     */
+    deleteWebhookEndpointRaw(requestParameters: WebhooksApiDeleteWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes an endpoint. Nothing is sent to it anymore, retries included.
+     * Delete a webhook endpoint
+     */
+    deleteWebhookEndpoint(requestParameters: WebhooksApiDeleteWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns one of the URLs the events of the account are sent to.
+     * Get a webhook endpoint
+     */
+    getWebhookEndpointRaw(requestParameters: WebhooksApiGetWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpointDto>>;
+    /**
+     * Returns one of the URLs the events of the account are sent to.
+     * Get a webhook endpoint
+     */
+    getWebhookEndpoint(requestParameters: WebhooksApiGetWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointDto>;
+    /**
+     * Returns the custom headers sent with each event to the endpoint, values included, to edit them.
+     * Get the custom headers of a webhook endpoint
+     */
+    getWebhookEndpointHeadersRaw(requestParameters: WebhooksApiGetWebhookEndpointHeadersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpointHeadersDto>>;
+    /**
+     * Returns the custom headers sent with each event to the endpoint, values included, to edit them.
+     * Get the custom headers of a webhook endpoint
+     */
+    getWebhookEndpointHeaders(requestParameters: WebhooksApiGetWebhookEndpointHeadersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointHeadersDto>;
+    /**
+     * Returns the secret the events sent to the endpoint are signed with, to verify their signature.
+     * Get the signing secret of a webhook endpoint
+     */
+    getWebhookEndpointSecretRaw(requestParameters: WebhooksApiGetWebhookEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpointSecretDto>>;
+    /**
+     * Returns the secret the events sent to the endpoint are signed with, to verify their signature.
+     * Get the signing secret of a webhook endpoint
+     */
+    getWebhookEndpointSecret(requestParameters: WebhooksApiGetWebhookEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointSecretDto>;
+    /**
+     * Lists the URLs the events of the account are sent to.
+     * List webhook endpoints
+     */
+    getWebhookEndpointsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WebhookEndpointDto>>>;
+    /**
+     * Lists the URLs the events of the account are sent to.
+     * List webhook endpoints
+     */
+    getWebhookEndpoints(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WebhookEndpointDto>>;
+    /**
+     * Lists the event types an endpoint can receive, with an example of the data each one carries.
+     * List webhook event types
+     */
+    getWebhookEventTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WebhookEventTypeDto>>>;
+    /**
+     * Lists the event types an endpoint can receive, with an example of the data each one carries.
+     * List webhook event types
+     */
+    getWebhookEventTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WebhookEventTypeDto>>;
+    /**
+     * Returns an event with the data it carried and each attempt to deliver it.
+     * Get a webhook event
+     */
+    getWebhookMessageRaw(requestParameters: WebhooksApiGetWebhookMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookMessageDetailDto>>;
+    /**
+     * Returns an event with the data it carried and each attempt to deliver it.
+     * Get a webhook event
+     */
+    getWebhookMessage(requestParameters: WebhooksApiGetWebhookMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookMessageDetailDto>;
+    /**
+     * Lists the events sent to the endpoints of the account, the newest first.
+     * List webhook events
+     */
+    getWebhookMessagesRaw(requestParameters: WebhooksApiGetWebhookMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookMessagePageDto>>;
+    /**
+     * Lists the events sent to the endpoints of the account, the newest first.
+     * List webhook events
+     */
+    getWebhookMessages(requestParameters?: WebhooksApiGetWebhookMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookMessagePageDto>;
+    /**
+     * Tries once more to deliver an event to an endpoint.
+     * Retry a webhook delivery
+     */
+    retryWebhookDeliveryRaw(requestParameters: WebhooksApiRetryWebhookDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Tries once more to deliver an event to an endpoint.
+     * Retry a webhook delivery
+     */
+    retryWebhookDelivery(requestParameters: WebhooksApiRetryWebhookDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Gives the endpoint a new signing secret. Events are signed with the previous one too for 24 hours, to switch over without losing any.
+     * Rotate the signing secret of a webhook endpoint
+     */
+    rotateWebhookEndpointSecretRaw(requestParameters: WebhooksApiRotateWebhookEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Gives the endpoint a new signing secret. Events are signed with the previous one too for 24 hours, to switch over without losing any.
+     * Rotate the signing secret of a webhook endpoint
+     */
+    rotateWebhookEndpointSecret(requestParameters: WebhooksApiRotateWebhookEndpointSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Sends a webhook.test event to the endpoint, even when it is disabled. It shows in the event log like any other.
+     * Send a test event to a webhook endpoint
+     */
+    sendWebhookEndpointTestRaw(requestParameters: WebhooksApiSendWebhookEndpointTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Sends a webhook.test event to the endpoint, even when it is disabled. It shows in the event log like any other.
+     * Send a test event to a webhook endpoint
+     */
+    sendWebhookEndpointTest(requestParameters: WebhooksApiSendWebhookEndpointTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Changes the URL, description, event types, custom headers, timeout, attempts or enabled state of an endpoint. What is left out stays as it is.
+     * Update a webhook endpoint
+     */
+    updateWebhookEndpointRaw(requestParameters: WebhooksApiUpdateWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Changes the URL, description, event types, custom headers, timeout, attempts or enabled state of an endpoint. What is left out stays as it is.
+     * Update a webhook endpoint
+     */
+    updateWebhookEndpoint(requestParameters: WebhooksApiUpdateWebhookEndpointRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}