@getbrevo/brevo 4.0.1 → 5.0.1

package/dist/esm/api/resources/program/client/Client.d.mts

@@ -145,6 +145,27 @@ export declare class ProgramClient {
      */
     getParameterSubscriptionInfo(request: Brevo.GetParameterSubscriptionInfoRequest, requestOptions?: ProgramClient.RequestOptions): core.HttpResponsePromise<Brevo.GetParameterSubscriptionInfoResponse>;
     private __getParameterSubscriptionInfo;
+    /**
+     * Delete subscription for a contact
+     *
+     * @param {Brevo.DeleteContactSubscriptionRequest} request
+     * @param {ProgramClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.UnauthorizedError}
+     * @throws {@link Brevo.ForbiddenError}
+     * @throws {@link Brevo.NotFoundError}
+     * @throws {@link Brevo.UnprocessableEntityError}
+     * @throws {@link Brevo.InternalServerError}
+     *
+     * @example
+     *     await client.program.deleteContactSubscription({
+     *         pid: "pid",
+     *         cid: 1
+     *     })
+     */
+    deleteContactSubscription(request: Brevo.DeleteContactSubscriptionRequest, requestOptions?: ProgramClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteContactSubscription;
     /**
      * Publishes loyalty program
      *

package/dist/esm/api/resources/program/client/Client.mjs

@@ -501,6 +501,73 @@ export class ProgramClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/loyalty/config/programs/{pid}/account-info");
         });
     }
+    /**
+     * Delete subscription for a contact
+     *
+     * @param {Brevo.DeleteContactSubscriptionRequest} request
+     * @param {ProgramClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Brevo.BadRequestError}
+     * @throws {@link Brevo.UnauthorizedError}
+     * @throws {@link Brevo.ForbiddenError}
+     * @throws {@link Brevo.NotFoundError}
+     * @throws {@link Brevo.UnprocessableEntityError}
+     * @throws {@link Brevo.InternalServerError}
+     *
+     * @example
+     *     await client.program.deleteContactSubscription({
+     *         pid: "pid",
+     *         cid: 1
+     *     })
+     */
+    deleteContactSubscription(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteContactSubscription(request, requestOptions));
+    }
+    __deleteContactSubscription(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { pid, cid } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/config/programs/${core.url.encodePathParam(pid)}/contact/${core.url.encodePathParam(cid)}`),
+                method: "DELETE",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Brevo.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Brevo.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Brevo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Brevo.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.BrevoError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/loyalty/config/programs/{pid}/contact/{cid}");
+        });
+    }
     /**
      * Publishes loyalty program
      *

package/dist/esm/api/resources/program/client/requests/DeleteContactSubscriptionRequest.d.mts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         pid: "pid",
+ *         cid: 1
+ *     }
+ */
+export interface DeleteContactSubscriptionRequest {
+    /** Loyalty Program ID. A unique identifier for the loyalty program. */
+    pid: string;
+    /** Contact ID. */
+    cid: number;
+}

package/dist/esm/api/resources/program/client/requests/DeleteContactSubscriptionRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/program/client/requests/index.d.mts

@@ -1,5 +1,6 @@
 export type { CreateNewLpRequest } from "./CreateNewLpRequest.mjs";
 export type { DeleteContactMembersRequest } from "./DeleteContactMembersRequest.mjs";
+export type { DeleteContactSubscriptionRequest } from "./DeleteContactSubscriptionRequest.mjs";
 export type { DeleteLoyaltyProgramRequest } from "./DeleteLoyaltyProgramRequest.mjs";
 export type { GetLoyaltyProgramInfoRequest } from "./GetLoyaltyProgramInfoRequest.mjs";
 export type { GetLpListRequest } from "./GetLpListRequest.mjs";

package/dist/esm/api/resources/program/exports.d.mts

@@ -0,0 +1,2 @@
+export { ProgramClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/program/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { ProgramClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/program/types/GetLpListResponse.d.mts

@@ -1,5 +1,5 @@
 import type * as Brevo from "../../../index.mjs";
 export interface GetLpListResponse {
     /** Loyalty Program list */
-    items?: Brevo.LoyaltyProgram[];
+    items?: Brevo.LoyaltyProgram[] | undefined;
 }

package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts

@@ -1,30 +1,30 @@
 export interface GetParameterSubscriptionInfoResponse {
     /** Balance details for the subscription. */
-    balance?: GetParameterSubscriptionInfoResponse.Balance;
+    balance?: GetParameterSubscriptionInfoResponse.Balance | undefined;
     /** List of members associated with the subscription. */
-    members?: GetParameterSubscriptionInfoResponse.Members.Item[];
+    members?: GetParameterSubscriptionInfoResponse.Members.Item[] | undefined;
     /** List of rewards associated with the subscription. */
-    reward?: GetParameterSubscriptionInfoResponse.Reward.Item[];
+    reward?: GetParameterSubscriptionInfoResponse.Reward.Item[] | undefined;
     /** List of tier assignments for the subscription. */
-    tier?: GetParameterSubscriptionInfoResponse.Tier.Item[];
+    tier?: GetParameterSubscriptionInfoResponse.Tier.Item[] | undefined;
 }
 export declare namespace GetParameterSubscriptionInfoResponse {
     interface Balance {
         /** List of balance details associated with the contact. */
-        balances?: Balance.Balances.Item[];
+        balances?: Balance.Balances.Item[] | undefined;
         /** Unique identifier of the contact. */
-        contactId?: number;
+        contactId?: number | undefined;
         /** Unique identifier of the loyalty program. */
-        loyaltyProgramId?: string;
+        loyaltyProgramId?: string | undefined;
     }
     namespace Balance {
         type Balances = Balances.Item[];
         namespace Balances {
             interface Item {
                 /** Unique identifier for the balance definition). */
-                balanceDefinitionId?: string;
+                balanceDefinitionId?: string | undefined;
                 /** The amount of the balance. */
-                value?: number;
+                value?: number | undefined;
             }
         }
     }
@@ -32,53 +32,53 @@ export declare namespace GetParameterSubscriptionInfoResponse {
     namespace Members {
         interface Item {
             /** Timestamp when the member was created. */
-            createdAt?: string;
+            createdAt?: string | undefined;
             /** Unique identifier of the member. */
-            memberContactId?: number;
+            memberContactId?: number | undefined;
             /** Timestamp when the member was last updated. */
-            updatedAt?: string;
+            updatedAt?: string | undefined;
         }
     }
     type Reward = Reward.Item[];
     namespace Reward {
         interface Item {
             /** Reward code assigned to the contact. */
-            code?: string;
+            code?: string | undefined;
             /** Unique identifier of the contact. */
-            contactId?: number;
+            contactId?: number | undefined;
             /** Timestamp when the reward was created. */
-            createdAt?: string;
+            createdAt?: string | undefined;
             /** Expiration date of the reward. */
-            expirationDate?: string;
+            expirationDate?: string | undefined;
             /** Unique identifier of the reward. */
-            id?: string;
+            id?: string | undefined;
             /** Unique identifier of the loyalty program. */
-            loyaltyProgramId?: string;
+            loyaltyProgramId?: string | undefined;
             /** Additional metadata related to the reward. */
-            meta?: Record<string, unknown>;
+            meta?: Record<string, unknown> | undefined;
             /** Unique identifier of the reward definition. */
-            rewardId?: string;
+            rewardId?: string | undefined;
             /** Timestamp when the reward was last updated. */
-            updatedAt?: string;
+            updatedAt?: string | undefined;
         }
     }
     type Tier = Tier.Item[];
     namespace Tier {
         interface Item {
             /** Unique identifier of the contact. */
-            contactId?: number;
+            contactId?: number | undefined;
             /** Timestamp when the tier was assigned. */
-            createdAt?: string;
+            createdAt?: string | undefined;
             /** Unique identifier of the group associated with the tier. */
-            groupId?: string;
+            groupId?: string | undefined;
             /** Unique identifier of the loyalty program. */
-            loyaltyProgramId?: string;
+            loyaltyProgramId?: string | undefined;
             /** Additional metadata related to the tier. */
-            meta?: Record<string, unknown>;
+            meta?: Record<string, unknown> | undefined;
             /** Unique identifier of the tier. */
-            tierId?: string;
+            tierId?: string | undefined;
             /** Timestamp when the tier was last updated */
-            updatedAt?: string;
+            updatedAt?: string | undefined;
         }
     }
 }

package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts

@@ -1,12 +1,12 @@
 export interface SubscribeMemberToASubscriptionResponse {
     /** Timestamp when the subscription member was created. */
-    createdAt?: string;
+    createdAt?: string | undefined;
     /** List of unique member contact IDs. */
-    memberContactIds?: number[];
+    memberContactIds?: number[] | undefined;
     /** Unique identifier of the organization. */
-    organizationId?: number;
+    organizationId?: number | undefined;
     /** Unique identifier of the subscription owner. */
-    ownerContactId?: number;
+    ownerContactId?: number | undefined;
     /** Timestamp when the subscription member was last updated. */
-    updatedAt?: string;
+    updatedAt?: string | undefined;
 }

package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts

@@ -1,16 +1,16 @@
 export interface SubscribeToLoyaltyProgramResponse {
     /** Unique identifier of the contact. */
-    contactId?: number;
+    contactId?: number | undefined;
     /** Timestamp when the subscription was created. */
-    createdAt?: string;
+    createdAt?: string | undefined;
     /** Unique identifier of the loyalty program. */
-    loyaltyProgramId?: string;
+    loyaltyProgramId?: string | undefined;
     /** Unique identifier of the subscription. */
-    loyaltySubscriptionId?: string;
+    loyaltySubscriptionId?: string | undefined;
     /** Unique identifier of the organization. */
-    organizationId?: number;
+    organizationId?: number | undefined;
     /** Timestamp when the subscription was last updated. */
-    updatedAt?: string;
+    updatedAt?: string | undefined;
     /** Version number of the subscription. */
-    versionId?: number;
+    versionId?: number | undefined;
 }

package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts

@@ -27,66 +27,66 @@ export interface RedeemVoucherRequest {
 export declare namespace RedeemVoucherRequest {
     interface Order {
         /** Total amount of the order */
-        amount?: number;
+        amount?: number | undefined;
         /** Billing information for the order */
-        billing?: Order.Billing;
+        billing?: Order.Billing | undefined;
         /** Unique identifier for the contact */
-        contact_id?: number;
+        contact_id?: number | undefined;
         /** List of coupon codes applied to the order */
-        coupons?: string[];
+        coupons?: string[] | undefined;
         /** Timestamp when the order was created */
-        createdAt?: string;
+        createdAt?: string | undefined;
         /** Email address associated with the order */
-        email?: string;
+        email?: string | undefined;
         /** Unique identifier for the order */
-        id?: string;
+        id?: string | undefined;
         /** Additional identifiers for the order */
-        identifiers?: Order.Identifiers;
+        identifiers?: Order.Identifiers | undefined;
         /** List of products in the order */
-        products?: Order.Products.Item[];
+        products?: Order.Products.Item[] | undefined;
         /** Current status of the order */
-        status?: string;
+        status?: string | undefined;
         /** Identifier for the store where the order was placed */
-        storeId?: string;
+        storeId?: string | undefined;
         /** Timestamp when the order was last updated */
-        updatedAt?: string;
+        updatedAt?: string | undefined;
     }
     namespace Order {
         interface Billing {
             /** Address of the user */
-            address?: string;
+            address?: string | undefined;
             /** City of the user */
-            city?: string;
+            city?: string | undefined;
             /** Country code of the user */
-            countryCode?: string;
+            countryCode?: string | undefined;
             /** Payment method opted by the user */
-            paymentMethod?: string;
+            paymentMethod?: string | undefined;
             /** Phone number of the user */
-            phone?: number;
+            phone?: number | undefined;
             /** Postal Code of user's location */
-            postCode?: number;
+            postCode?: number | undefined;
             /** Region where user resides */
-            region?: string;
+            region?: string | undefined;
         }
         interface Identifiers {
             /** External identifier for the order */
-            ext_id?: string;
+            ext_id?: string | undefined;
             /** Identifier for the loyalty subscription */
-            loyalty_subscription_id?: string;
+            loyalty_subscription_id?: string | undefined;
         }
         type Products = Products.Item[];
         namespace Products {
             interface Item {
                 /** List of categories the product belongs to */
-                category?: string[];
+                category?: string[] | undefined;
                 /** Price of the product */
-                price?: number;
+                price?: number | undefined;
                 /** Unique identifier for the product */
-                productId?: string;
+                productId?: string | undefined;
                 /** Quantity of the product */
-                quantity?: number;
+                quantity?: number | undefined;
                 /** Identifier for the product variant */
-                variantId?: string;
+                variantId?: string | undefined;
             }
         }
     }

package/dist/esm/api/resources/reward/exports.d.mts

@@ -0,0 +1,2 @@
+export { RewardClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/reward/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { RewardClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts

@@ -1,18 +1,18 @@
 export interface CreateRewardResponse {
     /** Timestamp when the reward was created */
-    createdAt?: string;
+    createdAt?: string | undefined;
     /** Unique identifier for the reward */
-    id?: string;
+    id?: string | undefined;
     /** Id of the loyalty program to which the current reward belongs to */
-    loyaltyProgramId?: string;
+    loyaltyProgramId?: string | undefined;
     /** Name of the reward */
-    name?: string;
+    name?: string | undefined;
     /** Public description for the reward */
-    publicDescription?: string;
+    publicDescription?: string | undefined;
     /** Public Image for the reward */
-    publicImage?: string;
+    publicImage?: string | undefined;
     /** Public name for the reward */
-    publicName?: string;
+    publicName?: string | undefined;
     /** Timestamp for when this reward was last updated. */
-    updatedAt?: string;
+    updatedAt?: string | undefined;
 }

package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts

@@ -1,24 +1,24 @@
 export interface CreateVoucherResponse {
     /** Generated code */
-    code?: string;
+    code?: string | undefined;
     /** Timestamp for when this reward was consumed */
-    consumedAt?: string;
+    consumedAt?: string | undefined;
     /** Id of the contact that attributed the reward */
-    contactId?: number;
+    contactId?: number | undefined;
     /** Timestamp for when this reward was created */
-    createdAt?: string;
+    createdAt?: string | undefined;
     /** Expiration date of the reward */
-    expirationDate?: string;
+    expirationDate?: string | undefined;
     /** Unique identifier */
-    id?: string;
+    id?: string | undefined;
     /** Loyalty Program Id to which attributed reward belongs */
-    loyaltyProgramId?: string;
+    loyaltyProgramId?: string | undefined;
     /** Additional data to define the reward */
-    meta?: Record<string, unknown>;
+    meta?: Record<string, unknown> | undefined;
     /** Unique identifier for the reward */
-    rewardId?: string;
+    rewardId?: string | undefined;
     /** Timestamp for when this reward was updated */
-    updatedAt?: string;
+    updatedAt?: string | undefined;
     /** Value of the selected reward config */
-    value?: number;
+    value?: number | undefined;
 }

package/dist/esm/api/resources/reward/types/GetCodeCountResponse.d.mts

@@ -1,4 +1,4 @@
 export interface GetCodeCountResponse {
     /** Number of codes */
-    count?: number;
+    count?: number | undefined;
 }

package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidOffersResponse.d.mts

@@ -1,31 +1,31 @@
 export interface GetLoyaltyOfferProgramsPidOffersResponse {
     /** Items for the current reward */
-    items?: GetLoyaltyOfferProgramsPidOffersResponse.Items.Item[];
+    items?: GetLoyaltyOfferProgramsPidOffersResponse.Items.Item[] | undefined;
     /** Count of the associated parameter in current reward */
-    totalCount?: number;
+    totalCount?: number | undefined;
 }
 export declare namespace GetLoyaltyOfferProgramsPidOffersResponse {
     type Items = Items.Item[];
     namespace Items {
         interface Item {
             /** Timestamp for when this reward was created */
-            createdAt?: string;
+            createdAt?: string | undefined;
             /** Timestamp for when this reward attribution ended */
-            endDate?: string;
+            endDate?: string | undefined;
             /** Unique identifier for the reward */
-            id?: string;
+            id?: string | undefined;
             /** Loyalty Program to which current reward is associated */
-            loyaltyProgramId?: string;
+            loyaltyProgramId?: string | undefined;
             /** Name of the reward */
-            name?: string;
+            name?: string | undefined;
             /** Public image of the reward */
-            publicImage?: string;
+            publicImage?: string | undefined;
             /** Timestamp for when this reward attribution started */
-            startDate?: string;
+            startDate?: string | undefined;
             /** State of the reward */
-            state?: string;
+            state?: string | undefined;
             /** Timestamp for when this reward attribution was updated */
-            updatedAt?: string;
+            updatedAt?: string | undefined;
         }
     }
 }