@trycourier/courier 6.3.1 → 6.4.1

package/api/resources/profiles/client/Client.d.ts

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Profiles {
     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,9 +39,10 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.get("string")
+     *     await client.profiles.get("user_id")
      */
-    get(userId: string, requestOptions?: Profiles.RequestOptions): Promise<Courier.ProfileGetResponse>;
+    get(userId: string, requestOptions?: Profiles.RequestOptions): core.HttpResponsePromise<Courier.ProfileGetResponse>;
+    private __get;
     /**
      * Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.
      *
@@ -44,15 +53,16 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.create("string", {
+     *     await client.profiles.create("user_id", {
      *         profile: {
-     *             "string": {
+     *             "profile": {
      *                 "key": "value"
      *             }
      *         }
      *     })
      */
-    create(userId: string, request: Courier.MergeProfileRequest, requestOptions?: Profiles.IdempotentRequestOptions): Promise<Courier.MergeProfileResponse>;
+    create(userId: string, request: Courier.MergeProfileRequest, requestOptions?: Profiles.IdempotentRequestOptions): core.HttpResponsePromise<Courier.MergeProfileResponse>;
+    private __create;
     /**
      * When using `PUT`, be sure to include all the key-value pairs required by the recipient's profile.
      * Any key-value pairs that exist in the profile but fail to be included in the `PUT` request will be
@@ -66,28 +76,36 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.replace("string", {
+     *     await client.profiles.replace("user_id", {
      *         profile: {
-     *             "string": {
+     *             "profile": {
      *                 "key": "value"
      *             }
      *         }
      *     })
      */
-    replace(userId: string, request: Courier.ReplaceProfileRequest, requestOptions?: Profiles.RequestOptions): Promise<Courier.ReplaceProfileResponse>;
+    replace(userId: string, request: Courier.ReplaceProfileRequest, requestOptions?: Profiles.RequestOptions): core.HttpResponsePromise<Courier.ReplaceProfileResponse>;
+    private __replace;
     /**
      * @param {string} userId - A unique identifier representing the user associated with the requested profile.
-     * @param {Courier.UserProfilePatch[]} request
+     * @param {Courier.ProfileUpdateRequest} request
      * @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.profiles.mergeProfile("string", [{
-     *             op: "string",
-     *             path: "string",
-     *             value: "string"
-     *         }])
+     *     await client.profiles.mergeProfile("user_id", {
+     *         patch: [{
+     *                 op: "op",
+     *                 path: "path",
+     *                 value: "value"
+     *             }, {
+     *                 op: "op",
+     *                 path: "path",
+     *                 value: "value"
+     *             }]
+     *     })
      */
-    mergeProfile(userId: string, request: Courier.UserProfilePatch[], requestOptions?: Profiles.RequestOptions): Promise<void>;
+    mergeProfile(userId: string, request: Courier.ProfileUpdateRequest, requestOptions?: Profiles.RequestOptions): core.HttpResponsePromise<void>;
+    private __mergeProfile;
     /**
      * Deletes the specified user profile.
      *
@@ -97,9 +115,10 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.delete("string")
+     *     await client.profiles.delete("user_id")
      */
-    delete(userId: string, requestOptions?: Profiles.RequestOptions): Promise<void>;
+    delete(userId: string, requestOptions?: Profiles.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
     /**
      * Returns the subscribed lists for a specified user.
      *
@@ -110,11 +129,10 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.getListSubscriptions("string", {
-     *         cursor: "string"
-     *     })
+     *     await client.profiles.getListSubscriptions("user_id")
      */
-    getListSubscriptions(userId: string, request?: Courier.GetListSubscriptionsRequest, requestOptions?: Profiles.RequestOptions): Promise<Courier.GetListSubscriptionsResponse>;
+    getListSubscriptions(userId: string, request?: Courier.GetListSubscriptionsRequest, requestOptions?: Profiles.RequestOptions): core.HttpResponsePromise<Courier.GetListSubscriptionsResponse>;
+    private __getListSubscriptions;
     /**
      * Subscribes the given user to one or more lists. If the list does not exist, it will be created.
      *
@@ -125,17 +143,18 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.subscribeToLists("string", {
+     *     await client.profiles.subscribeToLists("user_id", {
      *         lists: [{
-     *                 listId: "string",
-     *                 preferences: {
-     *                     categories: {},
-     *                     notifications: {}
-     *                 }
+     *                 listId: "listId",
+     *                 preferences: undefined
+     *             }, {
+     *                 listId: "listId",
+     *                 preferences: undefined
      *             }]
      *     })
      */
-    subscribeToLists(userId: string, request: Courier.SubscribeToListsRequest, requestOptions?: Profiles.IdempotentRequestOptions): Promise<Courier.SubscribeToListsResponse>;
+    subscribeToLists(userId: string, request: Courier.SubscribeToListsRequest, requestOptions?: Profiles.IdempotentRequestOptions): core.HttpResponsePromise<Courier.SubscribeToListsResponse>;
+    private __subscribeToLists;
     /**
      * Removes all list subscriptions for given user.
      *
@@ -145,8 +164,9 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.deleteListSubscription("string")
+     *     await client.profiles.deleteListSubscription("user_id")
      */
-    deleteListSubscription(userId: string, requestOptions?: Profiles.RequestOptions): Promise<Courier.DeleteListSubscriptionResponse>;
+    deleteListSubscription(userId: string, requestOptions?: Profiles.RequestOptions): core.HttpResponsePromise<Courier.DeleteListSubscriptionResponse>;
+    private __deleteListSubscription;
     protected _getAuthorizationHeader(): Promise<string>;
 }