pingram 1.0.34-alpha.1565 → 1.0.34-alpha.1567

package/dist/generated/src/apis/WebhooksApi.d.ts

@@ -30,7 +30,7 @@ export interface UpdateWebhookRequest {
 export interface WebhooksApiInterface {
     /**
      *
-     * @summary Create a webhook.
+     * @summary Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be http or https and should return 2xx.
      * @param {WebhookEndpointUpsertRequest} webhookEndpointUpsertRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -38,38 +38,38 @@ export interface WebhooksApiInterface {
      */
     createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
     /**
-     * Create a webhook.
+     * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be http or https and should return 2xx.
      */
     createWebhook(webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
     /**
      *
-     * @summary Delete a webhook.
-     * @param {string} endpointId Webhook endpoint id
+     * @summary Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.
+     * @param {string} endpointId Id of the webhook endpoint, from list or create.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WebhooksApiInterface
      */
     deleteWebhookRaw(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Delete a webhook.
+     * Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.
      */
     deleteWebhook(endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      *
-     * @summary List webhooks for the current account.
+     * @summary List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WebhooksApiInterface
      */
     listWebhooksRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpointsResponse>>;
     /**
-     * List webhooks for the current account.
+     * List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.
      */
     listWebhooks(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointsResponse>;
     /**
      *
-     * @summary Update a webhook. The signing secret is preserved.
-     * @param {string} endpointId Webhook endpoint id
+     * @summary Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be http or https.
+     * @param {string} endpointId Id of the webhook endpoint, from list or create.
      * @param {WebhookEndpointUpsertRequest} webhookEndpointUpsertRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -77,7 +77,7 @@ export interface WebhooksApiInterface {
      */
     updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
     /**
-     * Update a webhook. The signing secret is preserved.
+     * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be http or https.
      */
     updateWebhook(endpointId: string, webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
 }
@@ -86,35 +86,35 @@ export interface WebhooksApiInterface {
  */
 export declare class WebhooksApi extends runtime.BaseAPI implements WebhooksApiInterface {
     /**
-     * Create a webhook.
+     * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be http or https and should return 2xx.
      */
     createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
     /**
-     * Create a webhook.
+     * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be http or https and should return 2xx.
      */
     createWebhook(webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
     /**
-     * Delete a webhook.
+     * Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.
      */
     deleteWebhookRaw(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
     /**
-     * Delete a webhook.
+     * Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.
      */
     deleteWebhook(endpointId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
-     * List webhooks for the current account.
+     * List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.
      */
     listWebhooksRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpointsResponse>>;
     /**
-     * List webhooks for the current account.
+     * List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.
      */
     listWebhooks(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointsResponse>;
     /**
-     * Update a webhook. The signing secret is preserved.
+     * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be http or https.
      */
     updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
     /**
-     * Update a webhook. The signing secret is preserved.
+     * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be http or https.
      */
     updateWebhook(endpointId: string, webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
 }

package/dist/generated/src/apis/WebhooksApi.js

@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
  */
 class WebhooksApi extends runtime.BaseAPI {
     /**
-     * Create a webhook.
+     * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be http or https and should return 2xx.
      */
     async createWebhookRaw(requestParameters, initOverrides) {
         if (requestParameters['webhookEndpointUpsertRequest'] == null) {
@@ -102,14 +102,14 @@ class WebhooksApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookEndpointFromJSON)(jsonValue));
     }
     /**
-     * Create a webhook.
+     * Create a webhook endpoint. Pingram POSTs signed JSON to the URL when one of the subscribed events happens. The response includes id and a signing secret starting with pingram_whsecret_. Save it and verify the X-Pingram-Signature header. Updates keep this secret. At most 10 endpoints per account. The URL must be http or https and should return 2xx.
      */
     async createWebhook(webhookEndpointUpsertRequest, initOverrides) {
         const response = await this.createWebhookRaw({ webhookEndpointUpsertRequest: webhookEndpointUpsertRequest }, initOverrides);
         return await response.value();
     }
     /**
-     * Delete a webhook.
+     * Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.
      */
     async deleteWebhookRaw(requestParameters, initOverrides) {
         if (requestParameters['endpointId'] == null) {
@@ -156,13 +156,13 @@ class WebhooksApi extends runtime.BaseAPI {
         return new runtime.VoidApiResponse(response);
     }
     /**
-     * Delete a webhook.
+     * Delete one webhook endpoint by id from list or create. That URL stops receiving its events. Other endpoints on the account are left as they are.
      */
     async deleteWebhook(endpointId, initOverrides) {
         await this.deleteWebhookRaw({ endpointId: endpointId }, initOverrides);
     }
     /**
-     * List webhooks for the current account.
+     * List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.
      */
     async listWebhooksRaw(initOverrides) {
         const queryParameters = {};
@@ -205,14 +205,14 @@ class WebhooksApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookEndpointsResponseFromJSON)(jsonValue));
     }
     /**
-     * List webhooks for the current account.
+     * List webhook endpoints on the current account, including each id, URL, subscribed events, and signing secret. Use the id with update or delete.
      */
     async listWebhooks(initOverrides) {
         const response = await this.listWebhooksRaw(initOverrides);
         return await response.value();
     }
     /**
-     * Update a webhook. The signing secret is preserved.
+     * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be http or https.
      */
     async updateWebhookRaw(requestParameters, initOverrides) {
         if (requestParameters['endpointId'] == null) {
@@ -264,7 +264,7 @@ class WebhooksApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookEndpointFromJSON)(jsonValue));
     }
     /**
-     * Update a webhook. The signing secret is preserved.
+     * Replace one webhook endpoint\'s URL and its full event subscription. endpointId comes from list or create. The signing secret stays the same. events is the complete set; omitting an event unsubscribes it. The URL must be http or https.
      */
     async updateWebhook(endpointId, webhookEndpointUpsertRequest, initOverrides) {
         const response = await this.updateWebhookRaw({

package/dist/generated/src/models/WebhookEndpoint.d.ts

@@ -22,19 +22,19 @@ export interface WebhookEndpoint {
      */
     id: string;
     /**
-     * Destination URL that receives webhook event payloads.
+     * Destination URL that receives signed JSON event payloads.
      * @type {string}
      * @memberof WebhookEndpoint
      */
     webhook: string;
     /**
-     * List of subscribed event types for this endpoint.
+     * Subscribed event types for this endpoint.
      * @type {Array<string>}
      * @memberof WebhookEndpoint
      */
     events: Array<WebhookEndpointEventsEnum>;
     /**
-     * HMAC secret for verifying webhook signatures. Use this with your X-Pingram-Signature verification.
+     * HMAC secret for verifying X-Pingram-Signature. Returned on create and list; updates keep the same secret. Format: pingram_whsecret_...
      * @type {string}
      * @memberof WebhookEndpoint
      */

package/dist/generated/src/models/WebhookEndpointUpsertRequest.d.ts

@@ -16,13 +16,13 @@
  */
 export interface WebhookEndpointUpsertRequest {
     /**
-     * Destination URL that receives webhook event payloads. Must be a valid http(s) URL.
+     * Public http or https URL that accepts POST with a JSON event body. Return 2xx to acknowledge. Requests include X-Pingram-Id, X-Pingram-Signature (v1 HMAC-SHA256), and X-Pingram-Timestamp.
      * @type {string}
      * @memberof WebhookEndpointUpsertRequest
      */
     webhook: string;
     /**
-     * List of event types that should be forwarded to the webhook URL.
+     * Full set of event types to deliver to this URL. Omitting an event on update unsubscribes it. Inbound SMS to the free shared number only works when that person has already received a text from this number. Inbound SMS to a dedicated number works normally.
      * @type {Array<string>}
      * @memberof WebhookEndpointUpsertRequest
      */

package/dist/generated/src/models/WebhookEndpointsResponseEndpointsInner.d.ts

@@ -22,19 +22,19 @@ export interface WebhookEndpointsResponseEndpointsInner {
      */
     id: string;
     /**
-     * Destination URL that receives webhook event payloads.
+     * Destination URL that receives signed JSON event payloads.
      * @type {string}
      * @memberof WebhookEndpointsResponseEndpointsInner
      */
     webhook: string;
     /**
-     * List of subscribed event types for this endpoint.
+     * Subscribed event types for this endpoint.
      * @type {Array<string>}
      * @memberof WebhookEndpointsResponseEndpointsInner
      */
     events: Array<WebhookEndpointsResponseEndpointsInnerEventsEnum>;
     /**
-     * HMAC secret for verifying webhook signatures. Use this with your X-Pingram-Signature verification.
+     * HMAC secret for verifying X-Pingram-Signature. Returned on create and list; updates keep the same secret. Format: pingram_whsecret_...
      * @type {string}
      * @memberof WebhookEndpointsResponseEndpointsInner
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pingram",
-  "version": "1.0.34-alpha.1565",
+  "version": "1.0.34-alpha.1567",
   "description": "Official Node.js SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more",
   "main": "dist/index.js",
   "module": "dist/index.js",