pingram 1.0.37-alpha.1620 → 1.0.37-alpha.1622

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

@@ -29,7 +29,7 @@ export interface ListRequest {
 export interface LibraryApiInterface {
     /**
      *
-     * @summary Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+     * @summary Create an upload slot in the account library. contentType must be image/png, image/jpeg, image/gif, or image/webp. PUT the file to the returned uploadUrl with that Content-Type, then use the returned url in emails and the editor.
      * @param {string} useCase Library use-case
      * @param {CreateLibraryRequest} createLibraryRequest
      * @param {*} [options] Override http request option.
@@ -38,7 +38,7 @@ export interface LibraryApiInterface {
      */
     createRaw(requestParameters: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateLibraryResponse>>;
     /**
-     * Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+     * Create an upload slot in the account library. contentType must be image/png, image/jpeg, image/gif, or image/webp. PUT the file to the returned uploadUrl with that Content-Type, then use the returned url in emails and the editor.
      */
     create(useCase: string, createLibraryRequest: CreateLibraryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateLibraryResponse>;
     /**
@@ -62,11 +62,11 @@ export interface LibraryApiInterface {
  */
 export declare class LibraryApi extends runtime.BaseAPI implements LibraryApiInterface {
     /**
-     * Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+     * Create an upload slot in the account library. contentType must be image/png, image/jpeg, image/gif, or image/webp. PUT the file to the returned uploadUrl with that Content-Type, then use the returned url in emails and the editor.
      */
     createRaw(requestParameters: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateLibraryResponse>>;
     /**
-     * Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+     * Create an upload slot in the account library. contentType must be image/png, image/jpeg, image/gif, or image/webp. PUT the file to the returned uploadUrl with that Content-Type, then use the returned url in emails and the editor.
      */
     create(useCase: string, createLibraryRequest: CreateLibraryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateLibraryResponse>;
     /**

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

@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
  */
 class LibraryApi extends runtime.BaseAPI {
     /**
-     * Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+     * Create an upload slot in the account library. contentType must be image/png, image/jpeg, image/gif, or image/webp. PUT the file to the returned uploadUrl with that Content-Type, then use the returned url in emails and the editor.
      */
     async createRaw(requestParameters, initOverrides) {
         if (requestParameters['useCase'] == null) {
@@ -106,7 +106,7 @@ class LibraryApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateLibraryResponseFromJSON)(jsonValue));
     }
     /**
-     * Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+     * Create an upload slot in the account library. contentType must be image/png, image/jpeg, image/gif, or image/webp. PUT the file to the returned uploadUrl with that Content-Type, then use the returned url in emails and the editor.
      */
     async create(useCase, createLibraryRequest, initOverrides) {
         const response = await this.createRaw({ useCase: useCase, createLibraryRequest: createLibraryRequest }, initOverrides);

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

@@ -30,7 +30,7 @@ export interface UpdateWebhookRequest {
 export interface WebhooksApiInterface {
     /**
      *
-     * @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.
+     * @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 a public HTTPS URL and should return 2xx.
      * @param {WebhookEndpointUpsertRequest} webhookEndpointUpsertRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -38,7 +38,7 @@ export interface WebhooksApiInterface {
      */
     createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
     /**
-     * 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.
+     * 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 a public HTTPS URL and should return 2xx.
      */
     createWebhook(webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
     /**
@@ -68,7 +68,7 @@ export interface WebhooksApiInterface {
     listWebhooks(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointsResponse>;
     /**
      *
-     * @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.
+     * @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 a public HTTPS URL.
      * @param {string} endpointId Id of the webhook endpoint, from list or create.
      * @param {WebhookEndpointUpsertRequest} webhookEndpointUpsertRequest
      * @param {*} [options] Override http request option.
@@ -77,7 +77,7 @@ export interface WebhooksApiInterface {
      */
     updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
     /**
-     * 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.
+     * 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 a public HTTPS URL.
      */
     updateWebhook(endpointId: string, webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
 }
@@ -86,11 +86,11 @@ export interface WebhooksApiInterface {
  */
 export declare class WebhooksApi extends runtime.BaseAPI implements WebhooksApiInterface {
     /**
-     * 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.
+     * 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 a public HTTPS URL and should return 2xx.
      */
     createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
     /**
-     * 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.
+     * 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 a public HTTPS URL and should return 2xx.
      */
     createWebhook(webhookEndpointUpsertRequest: WebhookEndpointUpsertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpoint>;
     /**
@@ -110,11 +110,11 @@ export declare class WebhooksApi extends runtime.BaseAPI implements WebhooksApiI
      */
     listWebhooks(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEndpointsResponse>;
     /**
-     * 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.
+     * 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 a public HTTPS URL.
      */
     updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEndpoint>>;
     /**
-     * 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.
+     * 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 a public HTTPS URL.
      */
     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 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.
+     * 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 a public HTTPS URL and should return 2xx.
      */
     async createWebhookRaw(requestParameters, initOverrides) {
         if (requestParameters['webhookEndpointUpsertRequest'] == null) {
@@ -102,7 +102,7 @@ class WebhooksApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WebhookEndpointFromJSON)(jsonValue));
     }
     /**
-     * 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.
+     * 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 a public HTTPS URL and should return 2xx.
      */
     async createWebhook(webhookEndpointUpsertRequest, initOverrides) {
         const response = await this.createWebhookRaw({ webhookEndpointUpsertRequest: webhookEndpointUpsertRequest }, initOverrides);
@@ -212,7 +212,7 @@ class WebhooksApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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.
+     * 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 a public HTTPS URL.
      */
     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));
     }
     /**
-     * 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.
+     * 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 a public HTTPS URL.
      */
     async updateWebhook(endpointId, webhookEndpointUpsertRequest, initOverrides) {
         const response = await this.updateWebhookRaw({

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

@@ -22,7 +22,7 @@ export interface CreateLibraryRequest {
      */
     filename: string;
     /**
-     * MIME type of the file that will be uploaded to the returned URL.
+     * Image MIME type. One of image/png, image/jpeg, image/gif, or image/webp.
      * @type {string}
      * @memberof CreateLibraryRequest
      */

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

@@ -16,7 +16,7 @@
  */
 export interface WebhookEndpointUpsertRequest {
     /**
-     * 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.
+     * Public HTTPS URL that accepts POST with a JSON event body. Return 2xx to acknowledge. Private, loopback, and link-local addresses are rejected. Requests include X-Pingram-Id, X-Pingram-Signature (v1 HMAC-SHA256), and X-Pingram-Timestamp.
      * @type {string}
      * @memberof WebhookEndpointUpsertRequest
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pingram",
-  "version": "1.0.37-alpha.1620",
+  "version": "1.0.37-alpha.1622",
   "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",