@trycourier/courier 6.3.1 → 6.4.1

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Lists {
     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;
@@ -31,12 +39,10 @@ export declare class Lists {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.lists.list({
-     *         cursor: "string",
-     *         pattern: "string"
-     *     })
+     *     await client.lists.list()
      */
-    list(request?: Courier.GetAllListsRequest, requestOptions?: Lists.RequestOptions): Promise<Courier.ListGetAllResponse>;
+    list(request?: Courier.GetAllListsRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<Courier.ListGetAllResponse>;
+    private __list;
     /**
      * Returns a list based on the list ID provided.
      *
@@ -46,9 +52,10 @@ export declare class Lists {
      * @throws {@link Courier.NotFoundError}
      *
      * @example
-     *     await courier.lists.get("string")
+     *     await client.lists.get("list_id")
      */
-    get(listId: string, requestOptions?: Lists.RequestOptions): Promise<Courier.List>;
+    get(listId: string, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<Courier.List>;
+    private __get;
     /**
      * Create or replace an existing list with the supplied values.
      *
@@ -57,15 +64,13 @@ export declare class Lists {
      * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.lists.update("string", {
-     *         name: "string",
-     *         preferences: {
-     *             categories: {},
-     *             notifications: {}
-     *         }
+     *     await client.lists.update("list_id", {
+     *         name: "name",
+     *         preferences: undefined
      *     })
      */
-    update(listId: string, request: Courier.ListPutParams, requestOptions?: Lists.RequestOptions): Promise<Courier.List>;
+    update(listId: string, request: Courier.ListPutParams, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<Courier.List>;
+    private __update;
     /**
      * Delete a list by list ID.
      *
@@ -73,9 +78,10 @@ export declare class Lists {
      * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.lists.delete("string")
+     *     await client.lists.delete("list_id")
      */
-    delete(listId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
+    delete(listId: string, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
     /**
      * Restore a previously deleted list.
      *
@@ -83,9 +89,10 @@ export declare class Lists {
      * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.lists.restore("string")
+     *     await client.lists.restore("list_id")
      */
-    restore(listId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
+    restore(listId: string, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
+    private __restore;
     /**
      * Get the list's subscriptions.
      *
@@ -96,11 +103,10 @@ export declare class Lists {
      * @throws {@link Courier.NotFoundError}
      *
      * @example
-     *     await courier.lists.getSubscribers("string", {
-     *         cursor: "string"
-     *     })
+     *     await client.lists.getSubscribers("list_id")
      */
-    getSubscribers(listId: string, request?: Courier.GetSubscriptionForListRequest, requestOptions?: Lists.RequestOptions): Promise<Courier.ListGetSubscriptionsResponse>;
+    getSubscribers(listId: string, request?: Courier.GetSubscriptionForListRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<Courier.ListGetSubscriptionsResponse>;
+    private __getSubscribers;
     /**
      * Subscribes the users to the list, overwriting existing subscriptions. If the list does not exist, it will be automatically created.
      *
@@ -111,17 +117,18 @@ export declare class Lists {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.lists.updateSubscribers("string", {
+     *     await client.lists.updateSubscribers("list_id", {
      *         recipients: [{
-     *                 recipientId: "string",
-     *                 preferences: {
-     *                     categories: {},
-     *                     notifications: {}
-     *                 }
+     *                 recipientId: "recipientId",
+     *                 preferences: undefined
+     *             }, {
+     *                 recipientId: "recipientId",
+     *                 preferences: undefined
      *             }]
      *     })
      */
-    updateSubscribers(listId: string, request: Courier.SubscribeUsersToListRequest, requestOptions?: Lists.RequestOptions): Promise<void>;
+    updateSubscribers(listId: string, request: Courier.SubscribeUsersToListRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
+    private __updateSubscribers;
     /**
      * Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.
      *
@@ -132,17 +139,18 @@ export declare class Lists {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.lists.addSubscribers("string", {
+     *     await client.lists.addSubscribers("list_id", {
      *         recipients: [{
-     *                 recipientId: "string",
-     *                 preferences: {
-     *                     categories: {},
-     *                     notifications: {}
-     *                 }
+     *                 recipientId: "recipientId",
+     *                 preferences: undefined
+     *             }, {
+     *                 recipientId: "recipientId",
+     *                 preferences: undefined
      *             }]
      *     })
      */
-    addSubscribers(listId: string, request: Courier.AddSubscribersToList, requestOptions?: Lists.IdempotentRequestOptions): Promise<void>;
+    addSubscribers(listId: string, request: Courier.AddSubscribersToList, requestOptions?: Lists.IdempotentRequestOptions): core.HttpResponsePromise<void>;
+    private __addSubscribers;
     /**
      * Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
      *
@@ -152,14 +160,12 @@ export declare class Lists {
      * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.lists.subscribe("string", "string", {
-     *         preferences: {
-     *             categories: {},
-     *             notifications: {}
-     *         }
+     *     await client.lists.subscribe("list_id", "user_id", {
+     *         preferences: undefined
      *     })
      */
-    subscribe(listId: string, userId: string, request?: Courier.SubscribeUserToListRequest, requestOptions?: Lists.RequestOptions): Promise<void>;
+    subscribe(listId: string, userId: string, request?: Courier.SubscribeUserToListRequest, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
+    private __subscribe;
     /**
      * Delete a subscription to a list by list ID and user ID.
      *
@@ -170,8 +176,9 @@ export declare class Lists {
      * @throws {@link Courier.NotFoundError}
      *
      * @example
-     *     await courier.lists.unsubscribe("string", "string")
+     *     await client.lists.unsubscribe("list_id", "user_id")
      */
-    unsubscribe(listId: string, userId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
+    unsubscribe(listId: string, userId: string, requestOptions?: Lists.RequestOptions): core.HttpResponsePromise<void>;
+    private __unsubscribe;
     protected _getAuthorizationHeader(): Promise<string>;
 }