pingram 1.0.37-alpha.1614 → 1.0.37-alpha.1616

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetLogsResponse, LogQueryPostBody, LogsGetResponse, LogsQueryResponse, LogsQueryResultResponse, LogsRetentionResponse, LogsTailResponse } from '../models/index';
+import type { GetLogsResponse, LogQueryPostBody, LogsGetResponse, LogsQueryResponse, LogsQueryResultResponse, LogsRetentionResponse, LogsTailResponse, MessageResponse } from '../models/index';
 export interface GetLogsRequest {
     limit?: number;
     cursor?: string;
@@ -21,6 +21,9 @@ export interface GetLogsByTrackingIdsRequest {
 export interface GetLogsQueryResultRequest {
     queryId: string;
 }
+export interface RetryInboundRequest {
+    trackingId: string;
+}
 export interface StartLogsQueryRequest {
     logQueryPostBody: LogQueryPostBody;
 }
@@ -83,6 +86,19 @@ export interface LogsApiInterface {
      * Get results from a log query started with Start Log Query. Poll until status is Complete.
      */
     getLogsQueryResult(queryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LogsQueryResultResponse>;
+    /**
+     *
+     * @summary Resend the EMAIL_INBOUND webhook for one inbound email. Uses the original tracking ID and does not count another email. Refused when the message is older than 30 days.
+     * @param {string} trackingId Tracking ID of the inbound email
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LogsApiInterface
+     */
+    retryInboundRaw(requestParameters: RetryInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
+    /**
+     * Resend the EMAIL_INBOUND webhook for one inbound email. Uses the original tracking ID and does not count another email. Refused when the message is older than 30 days.
+     */
+    retryInbound(trackingId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
     /**
      *
      * @summary Start an asynchronous log search over a date range. Returns a `queryId`; poll with Get Log Query Results until status is Complete.
@@ -145,6 +161,14 @@ export declare class LogsApi extends runtime.BaseAPI implements LogsApiInterface
      * Get results from a log query started with Start Log Query. Poll until status is Complete.
      */
     getLogsQueryResult(queryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LogsQueryResultResponse>;
+    /**
+     * Resend the EMAIL_INBOUND webhook for one inbound email. Uses the original tracking ID and does not count another email. Refused when the message is older than 30 days.
+     */
+    retryInboundRaw(requestParameters: RetryInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
+    /**
+     * Resend the EMAIL_INBOUND webhook for one inbound email. Uses the original tracking ID and does not count another email. Refused when the message is older than 30 days.
+     */
+    retryInbound(trackingId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
     /**
      * Start an asynchronous log search over a date range. Returns a `queryId`; poll with Get Log Query Results until status is Complete.
      */

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

@@ -267,6 +267,60 @@ class LogsApi extends runtime.BaseAPI {
         const response = await this.getLogsQueryResultRaw({ queryId: queryId }, initOverrides);
         return await response.value();
     }
+    /**
+     * Resend the EMAIL_INBOUND webhook for one inbound email. Uses the original tracking ID and does not count another email. Refused when the message is older than 30 days.
+     */
+    async retryInboundRaw(requestParameters, initOverrides) {
+        if (requestParameters['trackingId'] == null) {
+            throw new runtime.RequiredError('trackingId', 'Required parameter "trackingId" was null or undefined when calling retryInbound().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token('apiKey', []);
+            if (tokenString) {
+                headerParameters['Authorization'] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        let urlPath = `/logs/retry/{trackingId}`;
+        urlPath = urlPath.replace(`{${'trackingId'}}`, encodeURIComponent(String(requestParameters['trackingId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MessageResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Resend the EMAIL_INBOUND webhook for one inbound email. Uses the original tracking ID and does not count another email. Refused when the message is older than 30 days.
+     */
+    async retryInbound(trackingId, initOverrides) {
+        const response = await this.retryInboundRaw({ trackingId: trackingId }, initOverrides);
+        return await response.value();
+    }
     /**
      * Start an asynchronous log search over a date range. Returns a `queryId`; poll with Get Log Query Results until status is Complete.
      */

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

@@ -30,7 +30,7 @@ export type { CreateAPIKeyRequest, RevokeAPIKeyRequest, KeysApiInterface } from
 export { KeysApi } from './KeysApi';
 export type { CreateRequest as LibraryApi_CreateRequest, ListRequest as LibraryApi_ListRequest, LibraryApiInterface } from './LibraryApi';
 export { LibraryApi } from './LibraryApi';
-export type { GetLogsRequest, GetLogsByTrackingIdsRequest, GetLogsQueryResultRequest, StartLogsQueryRequest, LogsApiInterface } from './LogsApi';
+export type { GetLogsRequest, GetLogsByTrackingIdsRequest, GetLogsQueryResultRequest, RetryInboundRequest, StartLogsQueryRequest, LogsApiInterface } from './LogsApi';
 export { LogsApi } from './LogsApi';
 export type { GetAutoJoinRequest, InviteMemberRequest, ListMembersRequest, RemoveMemberRequest, SetAutoJoinRequest, UpdateRequest as MembersApi_UpdateRequest, MembersApiInterface } from './MembersApi';
 export { MembersApi } from './MembersApi';

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

@@ -42,7 +42,7 @@ export interface GetLogsResponseMessagesInner {
      */
     epochMs: number;
     /**
-     *
+     * Address that received the mail. Same value as `matched.email` on the EMAIL_INBOUND webhook, including when that address was only in Cc or Bcc.
      * @type {string}
      * @memberof GetLogsResponseMessagesInner
      */
@@ -66,19 +66,19 @@ export interface GetLogsResponseMessagesInner {
      */
     subject?: string;
     /**
-     *
+     * Original To header addresses. Not the address that received the mail.
      * @type {Array<string>}
      * @memberof GetLogsResponseMessagesInner
      */
     to?: Array<string>;
     /**
-     *
+     * Original Cc header addresses.
      * @type {Array<string>}
      * @memberof GetLogsResponseMessagesInner
      */
     cc?: Array<string>;
     /**
-     *
+     * Bcc header addresses still on the delivered message. Usually omitted, because the Bcc header is removed before delivery.
      * @type {Array<string>}
      * @memberof GetLogsResponseMessagesInner
      */

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

@@ -16,29 +16,43 @@
  */
 export interface GetLogsResponseMessagesInnerAttachmentsInner {
     /**
-     *
+     * Original filename from the message.
      * @type {string}
      * @memberof GetLogsResponseMessagesInnerAttachmentsInner
      */
     filename: string;
     /**
-     *
+     * MIME type of the file.
      * @type {string}
      * @memberof GetLogsResponseMessagesInnerAttachmentsInner
      */
     contentType: string;
     /**
-     *
+     * Size in bytes. This response does not include the file bytes.
      * @type {number}
      * @memberof GetLogsResponseMessagesInnerAttachmentsInner
      */
     size: number;
     /**
-     *
+     * Content-ID with angle brackets removed, so it matches `cid:` references in `bodyHtml`. Omitted when the part has no Content-ID.
      * @type {string}
      * @memberof GetLogsResponseMessagesInnerAttachmentsInner
      */
     contentId?: string;
+    /**
+     * `inline` when the HTML body references this file; `attachment` when it is a separate file. Omitted when the message does not say which.
+     * @type {string}
+     * @memberof GetLogsResponseMessagesInnerAttachmentsInner
+     */
+    contentDisposition?: GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum;
+}
+/**
+ * @export
+ * @enum {string}
+ */
+export declare enum GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum {
+    INLINE = "inline",
+    ATTACHMENT = "attachment"
 }
 /**
  * Check if a given object implements the GetLogsResponseMessagesInnerAttachmentsInner interface.

package/dist/generated/src/models/GetLogsResponseMessagesInnerAttachmentsInner.js

@@ -13,11 +13,21 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum = void 0;
 exports.instanceOfGetLogsResponseMessagesInnerAttachmentsInner = instanceOfGetLogsResponseMessagesInnerAttachmentsInner;
 exports.GetLogsResponseMessagesInnerAttachmentsInnerFromJSON = GetLogsResponseMessagesInnerAttachmentsInnerFromJSON;
 exports.GetLogsResponseMessagesInnerAttachmentsInnerFromJSONTyped = GetLogsResponseMessagesInnerAttachmentsInnerFromJSONTyped;
 exports.GetLogsResponseMessagesInnerAttachmentsInnerToJSON = GetLogsResponseMessagesInnerAttachmentsInnerToJSON;
 exports.GetLogsResponseMessagesInnerAttachmentsInnerToJSONTyped = GetLogsResponseMessagesInnerAttachmentsInnerToJSONTyped;
+/**
+ * @export
+ * @enum {string}
+ */
+var GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum;
+(function (GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum) {
+    GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum["INLINE"] = "inline";
+    GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum["ATTACHMENT"] = "attachment";
+})(GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum || (exports.GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum = GetLogsResponseMessagesInnerAttachmentsInnerContentDispositionEnum = {}));
 /**
  * Check if a given object implements the GetLogsResponseMessagesInnerAttachmentsInner interface.
  */
@@ -41,7 +51,10 @@ function GetLogsResponseMessagesInnerAttachmentsInnerFromJSONTyped(json, ignoreD
         filename: json['filename'],
         contentType: json['contentType'],
         size: json['size'],
-        contentId: json['contentId'] == null ? undefined : json['contentId']
+        contentId: json['contentId'] == null ? undefined : json['contentId'],
+        contentDisposition: json['contentDisposition'] == null
+            ? undefined
+            : json['contentDisposition']
     };
 }
 function GetLogsResponseMessagesInnerAttachmentsInnerToJSON(json) {
@@ -55,6 +68,7 @@ function GetLogsResponseMessagesInnerAttachmentsInnerToJSONTyped(value, ignoreDi
         filename: value['filename'],
         contentType: value['contentType'],
         size: value['size'],
-        contentId: value['contentId']
+        contentId: value['contentId'],
+        contentDisposition: value['contentDisposition']
     };
 }

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

@@ -334,115 +334,139 @@ export interface LogsGetResponseLogsInner {
      */
     email_clicked_webhook_res?: string;
     /**
-     *
+     * When the message was accepted, ISO 8601. Log order and the 30-day resend window use this time.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_at?: string;
     /**
-     *
+     * Sender email address.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_from?: string;
     /**
-     *
+     * Sender display name, when the From header includes one.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_from_name?: string;
     /**
-     *
+     * Comma-separated To header addresses. This is the header, not necessarily the Pingram inbox.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_to?: string;
     /**
-     *
+     * Comma-separated CC header addresses.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_cc?: string;
     /**
-     *
+     * Comma-separated BCC header addresses. Often empty because that header is stripped before delivery.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_bcc?: string;
     /**
-     *
+     * Reply-To header address.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_reply_to?: string;
     /**
-     *
+     * Address that received the mail. Same value as `matched.email` on the EMAIL_INBOUND webhook, including when that address was only in Cc or Bcc.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_inbox?: string;
     /**
-     *
+     * Display name of `email_inbound_inbox` when the headers include one. Same value as `matched.name`. Omitted when that address has no display name.
+     * @type {string}
+     * @memberof LogsGetResponseLogsInner
+     */
+    email_inbound_to_name?: string;
+    /**
+     * Sender Date header, ISO 8601. Omitted when that header is missing or invalid.
+     * @type {string}
+     * @memberof LogsGetResponseLogsInner
+     */
+    email_inbound_sent_at?: string;
+    /**
+     * Key used to resend this inbound email for 30 days.
+     * @type {string}
+     * @memberof LogsGetResponseLogsInner
+     */
+    email_inbound_retry_key?: string;
+    /**
+     * User id from the original notification when this mail is a reply to one.
+     * @type {string}
+     * @memberof LogsGetResponseLogsInner
+     */
+    email_inbound_user_id?: string;
+    /**
+     * Subject line.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_subject?: string;
     /**
-     *
+     * Plain-text body.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_body_text?: string;
     /**
-     *
+     * HTML body. Inline images use `cid:` values that match attachment content IDs on the webhook payload.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_body_html?: string;
     /**
-     *
+     * True when the message includes at least one attachment.
      * @type {boolean}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_has_attachments?: boolean;
     /**
-     *
+     * Number of attachments. File bytes are not stored on this log.
      * @type {number}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_attachment_count?: number;
     /**
-     *
+     * Message-ID header. Use it to thread later replies.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_message_id?: string;
     /**
-     *
+     * In-Reply-To header: the Message-ID this mail replies to.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_in_reply_to?: string;
     /**
-     *
+     * References header: the chain of Message-IDs in the thread.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_references?: string;
     /**
-     *
+     * True when an EMAIL_INBOUND webhook endpoint returned a 2xx response.
      * @type {boolean}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_webhook_delivered?: boolean;
     /**
-     *
+     * JSON delivery result for each EMAIL_INBOUND endpoint.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */
     email_inbound_webhook_res?: string;
     /**
-     *
+     * How the inbox was matched: `reply` for a reply to a sent notification, `builtin` for a Pingram inbox, or `custom` for a custom domain.
      * @type {string}
      * @memberof LogsGetResponseLogsInner
      */

package/dist/generated/src/models/LogsGetResponseLogsInner.js

@@ -537,6 +537,18 @@ function LogsGetResponseLogsInnerFromJSONTyped(json, ignoreDiscriminator) {
         email_inbound_inbox: json['email_inbound_inbox'] == null
             ? undefined
             : json['email_inbound_inbox'],
+        email_inbound_to_name: json['email_inbound_to_name'] == null
+            ? undefined
+            : json['email_inbound_to_name'],
+        email_inbound_sent_at: json['email_inbound_sent_at'] == null
+            ? undefined
+            : json['email_inbound_sent_at'],
+        email_inbound_retry_key: json['email_inbound_retry_key'] == null
+            ? undefined
+            : json['email_inbound_retry_key'],
+        email_inbound_user_id: json['email_inbound_user_id'] == null
+            ? undefined
+            : json['email_inbound_user_id'],
         email_inbound_subject: json['email_inbound_subject'] == null
             ? undefined
             : json['email_inbound_subject'],
@@ -845,6 +857,10 @@ function LogsGetResponseLogsInnerToJSONTyped(value, ignoreDiscriminator = false)
         email_inbound_bcc: value['email_inbound_bcc'],
         email_inbound_reply_to: value['email_inbound_reply_to'],
         email_inbound_inbox: value['email_inbound_inbox'],
+        email_inbound_to_name: value['email_inbound_to_name'],
+        email_inbound_sent_at: value['email_inbound_sent_at'],
+        email_inbound_retry_key: value['email_inbound_retry_key'],
+        email_inbound_user_id: value['email_inbound_user_id'],
         email_inbound_subject: value['email_inbound_subject'],
         email_inbound_body_text: value['email_inbound_body_text'],
         email_inbound_body_html: value['email_inbound_body_html'],

package/package.json

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