@trycourier/courier 6.3.1 → 6.4.1

package/dist/api/resources/lists/client/requests/AddSubscribersToList.d.ts

@@ -6,11 +6,11 @@ import * as Courier from "../../../../index";
  * @example
  *     {
  *         recipients: [{
- *                 recipientId: "string",
- *                 preferences: {
- *                     categories: {},
- *                     notifications: {}
- *                 }
+ *                 recipientId: "recipientId",
+ *                 preferences: undefined
+ *             }, {
+ *                 recipientId: "recipientId",
+ *                 preferences: undefined
  *             }]
  *     }
  */

package/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts

@@ -3,10 +3,7 @@
  */
 /**
  * @example
- *     {
- *         cursor: "string",
- *         pattern: "string"
- *     }
+ *     {}
  */
 export interface GetAllListsRequest {
     /**

package/dist/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts

@@ -3,9 +3,7 @@
  */
 /**
  * @example
- *     {
- *         cursor: "string"
- *     }
+ *     {}
  */
 export interface GetSubscriptionForListRequest {
     /**

package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts

@@ -5,10 +5,7 @@ import * as Courier from "../../../../index";
 /**
  * @example
  *     {
- *         preferences: {
- *             categories: {},
- *             notifications: {}
- *         }
+ *         preferences: undefined
  *     }
  */
 export interface SubscribeUserToListRequest {

package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts

@@ -6,11 +6,11 @@ import * as Courier from "../../../../index";
  * @example
  *     {
  *         recipients: [{
- *                 recipientId: "string",
- *                 preferences: {
- *                     categories: {},
- *                     notifications: {}
- *                 }
+ *                 recipientId: "recipientId",
+ *                 preferences: undefined
+ *             }, {
+ *                 recipientId: "recipientId",
+ *                 preferences: undefined
  *             }]
  *     }
  */

package/dist/api/resources/messages/client/Client.d.ts

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Messages {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         authorizationToken?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
@@ -29,24 +37,10 @@ export declare class Messages {
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.list({
-     *         archived: true,
-     *         cursor: "string",
-     *         event: "string",
-     *         list: "string",
-     *         messageId: "string",
-     *         notification: "string",
-     *         provider: "string",
-     *         recipient: "string",
-     *         status: "string",
-     *         tag: "string",
-     *         tags: "string",
-     *         tenant_id: "string",
-     *         enqueued_after: "string",
-     *         traceId: "string"
-     *     })
+     *     await client.messages.list()
      */
-    list(request?: Courier.ListMessagesRequest, requestOptions?: Messages.RequestOptions): Promise<Courier.ListMessagesResponse>;
+    list(request?: Courier.ListMessagesRequest, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Courier.ListMessagesResponse>;
+    private __list;
     /**
      * Fetch the status of a message you've previously sent.
      *
@@ -57,9 +51,10 @@ export declare class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.get("string")
+     *     await client.messages.get("message_id")
      */
-    get(messageId: string, requestOptions?: Messages.RequestOptions): Promise<Courier.MessageDetails>;
+    get(messageId: string, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Courier.MessageDetailsExtended>;
+    private __get;
     /**
      * Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either `200` status code for a successful cancellation or `409` status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).
      *
@@ -67,9 +62,10 @@ export declare class Messages {
      * @param {Messages.IdempotentRequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.cancel("string")
+     *     await client.messages.cancel("message_id")
      */
-    cancel(messageId: string, requestOptions?: Messages.IdempotentRequestOptions): Promise<Courier.MessageDetails>;
+    cancel(messageId: string, requestOptions?: Messages.IdempotentRequestOptions): core.HttpResponsePromise<Courier.MessageDetails>;
+    private __cancel;
     /**
      * Fetch the array of events of a message you've previously sent.
      *
@@ -81,11 +77,10 @@ export declare class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.getHistory("string", {
-     *         type: "string"
-     *     })
+     *     await client.messages.getHistory("message_id")
      */
-    getHistory(messageId: string, request?: Courier.GetMessageHistoryRequest, requestOptions?: Messages.RequestOptions): Promise<Courier.MessageHistoryResponse>;
+    getHistory(messageId: string, request?: Courier.GetMessageHistoryRequest, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Courier.MessageHistoryResponse>;
+    private __getHistory;
     /**
      * @param {string} messageId - A unique identifier associated with the message you wish to retrieve (results from a send).
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
@@ -94,16 +89,18 @@ export declare class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.getContent("string")
+     *     await client.messages.getContent("message_id")
      */
-    getContent(messageId: string, requestOptions?: Messages.RequestOptions): Promise<Courier.RenderOutputResponse>;
+    getContent(messageId: string, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Courier.RenderOutputResponse>;
+    private __getContent;
     /**
      * @param {string} requestId - A unique identifier representing the request ID
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.archive("string")
+     *     await client.messages.archive("request_id")
      */
-    archive(requestId: string, requestOptions?: Messages.RequestOptions): Promise<void>;
+    archive(requestId: string, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<void>;
+    private __archive;
     protected _getAuthorizationHeader(): Promise<string>;
 }