@getbrevo/brevo 5.0.3 → 6.0.1

package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const GetLpListRequestSort = {
+    Asc: "asc",
+    Desc: "desc",
+};

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

@@ -60,6 +60,8 @@ export declare namespace GetParameterSubscriptionInfoResponse {
             rewardId?: string | undefined;
             /** Timestamp when the reward was last updated. */
             updatedAt?: string | undefined;
+            /** Date from which the voucher becomes valid. */
+            validFrom?: string | undefined;
         }
     }
     type Tier = Tier.Item[];

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 | undefined;
-    /** List of unique member contact IDs. */
-    memberContactIds?: number[] | undefined;
     /** Unique identifier of the organization. */
     organizationId?: number | undefined;
     /** Unique identifier of the subscription owner. */
     ownerContactId?: number | undefined;
+    /** List of unique member contact IDs. */
+    memberContactIds?: number[] | undefined;
+    /** Timestamp when the subscription member was created. */
+    createdAt?: string | undefined;
     /** Timestamp when the subscription member was last updated. */
     updatedAt?: string | undefined;
 }

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

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

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

@@ -1,3 +1,4 @@
+export * from "./GetLpListRequestSort.mjs";
 export * from "./GetLpListRequestSortField.mjs";
 export * from "./GetLpListResponse.mjs";
 export * from "./GetParameterSubscriptionInfoResponse.mjs";

package/dist/esm/api/resources/program/types/index.mjs

@@ -1,3 +1,4 @@
+export * from "./GetLpListRequestSort.mjs";
 export * from "./GetLpListRequestSortField.mjs";
 export * from "./GetLpListResponse.mjs";
 export * from "./GetParameterSubscriptionInfoResponse.mjs";

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

@@ -61,7 +61,7 @@ export class RewardClient {
                 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/offer/programs/${core.url.encodePathParam(pid)}/code-pools/${core.url.encodePathParam(cpid)}/codes-count`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -131,7 +131,11 @@ export class RewardClient {
                 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/offer/programs/${core.url.encodePathParam(pid)}/offers`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 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,
@@ -200,7 +204,7 @@ export class RewardClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -266,7 +270,7 @@ export class RewardClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -337,7 +341,7 @@ export class RewardClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -412,7 +416,7 @@ export class RewardClient {
                 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/offer/programs/${core.url.encodePathParam(pid)}/rewards/redeem/${core.url.encodePathParam(tid)}/complete`),
                 method: "POST",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -481,7 +485,11 @@ export class RewardClient {
                 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/offer/programs/${core.url.encodePathParam(pid)}/rewards/revoke`),
                 method: "DELETE",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 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,
@@ -540,7 +548,7 @@ export class RewardClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -612,7 +620,11 @@ export class RewardClient {
                 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/offer/programs/${core.url.encodePathParam(pid)}/rewards/${core.url.encodePathParam(rid)}`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 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,
@@ -690,7 +702,11 @@ export class RewardClient {
                 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/offer/programs/${core.url.encodePathParam(pid)}/vouchers`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 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,

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

@@ -22,4 +22,6 @@ export interface CreateVoucherRequest {
     rewardId: string;
     /** Value of the selected reward config */
     value?: number;
+    /** Date from which the voucher becomes valid. Accepts RFC 3339 or DD/MM/YYYY HH:MM AM/PM format. Converted to UTC using the organization's timezone. */
+    validFrom?: string;
 }

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

@@ -23,6 +23,8 @@ export interface RedeemVoucherRequest {
     rewardId?: string;
     /** Time to live in seconds for the redemption request */
     ttl?: number;
+    /** Whether the redemption should be automatically completed */
+    autoComplete?: boolean;
 }
 export declare namespace RedeemVoucherRequest {
     interface Order {

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 | undefined;
     /** Unique identifier for the reward */
     id?: string | undefined;
-    /** Id of the loyalty program to which the current reward belongs to */
+    /** Loyalty program to which the reward belongs */
     loyaltyProgramId?: string | undefined;
     /** Name of the reward */
     name?: string | undefined;
-    /** Public description for the reward */
+    /** Public description of the reward */
     publicDescription?: string | undefined;
-    /** Public Image for the reward */
+    /** Public image URL of the reward */
     publicImage?: string | undefined;
-    /** Public name for the reward */
+    /** Public name of the reward */
     publicName?: string | undefined;
-    /** Timestamp for when this reward was last updated. */
+    /** Timestamp when the reward was created */
+    createdAt?: string | undefined;
+    /** Timestamp when the reward was last updated */
     updatedAt?: string | undefined;
 }

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

@@ -21,4 +21,6 @@ export interface CreateVoucherResponse {
     updatedAt?: string | undefined;
     /** Value of the selected reward config */
     value?: number | undefined;
+    /** Date from which the voucher becomes valid */
+    validFrom?: string | undefined;
 }

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

@@ -34,6 +34,8 @@ export declare namespace GetLoyaltyOfferProgramsPidVouchersResponse {
             updatedAt?: string | undefined;
             /** Value of the selected reward config */
             value?: number | undefined;
+            /** Date from which the voucher becomes valid */
+            validFrom?: string | undefined;
         }
     }
 }

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

@@ -78,7 +78,11 @@ export class SendersClient {
                 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, "senders"),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 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,
@@ -174,7 +178,7 @@ export class SendersClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: request,
                 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,
@@ -236,7 +240,7 @@ export class SendersClient {
                 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, "senders/ips"),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -341,7 +345,7 @@ export class SendersClient {
                 method: "PUT",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -405,7 +409,7 @@ export class SendersClient {
                 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, `senders/${core.url.encodePathParam(senderId)}`),
                 method: "DELETE",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -470,7 +474,7 @@ export class SendersClient {
                 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, `senders/${core.url.encodePathParam(senderId)}/ips`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -542,7 +546,7 @@ export class SendersClient {
                 method: "PUT",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,

package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts

@@ -9,12 +9,12 @@ export declare namespace GetIpsResponse {
     type Ips = Ips.Item[];
     namespace Ips {
         interface Item {
+            /** ID of the dedicated IP */
+            id: number;
             /** Status of the IP (true=active, false=inactive) */
             active: boolean;
             /** Domain associated to the IP */
             domain: string;
-            /** ID of the dedicated IP */
-            id: number;
             /** Dedicated IP address */
             ip: string;
         }

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

@@ -11,6 +11,8 @@ export declare class SmsCampaignsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<SmsCampaignsClient.Options>;
     constructor(options: SmsCampaignsClient.Options);
     /**
+     * Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.
+     *
      * @param {Brevo.GetSmsCampaignsRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -22,6 +24,8 @@ export declare class SmsCampaignsClient {
     getSmsCampaigns(request?: Brevo.GetSmsCampaignsRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmsCampaignsResponse>;
     private __getSmsCampaigns;
     /**
+     * Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment. If a scheduledAt date is provided, listIds in recipients become mandatory; accounts under validation are limited to 4 total campaigns and campaigns with more than 10 recipients will be saved as draft.
+     *
      * @param {Brevo.CreateSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -37,6 +41,8 @@ export declare class SmsCampaignsClient {
     createSmsCampaign(request: Brevo.CreateSmsCampaignRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateSmsCampaignResponse>;
     private __createSmsCampaign;
     /**
+     * Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.
+     *
      * @param {Brevo.GetSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -51,6 +57,8 @@ export declare class SmsCampaignsClient {
     getSmsCampaign(request: Brevo.GetSmsCampaignRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmsCampaignResponse>;
     private __getSmsCampaign;
     /**
+     * Update an existing SMS campaign''s properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update. The campaign must exist and must be of type SMS; if a scheduledAt is provided, valid recipients must be present either in the request or already configured on the campaign.
+     *
      * @param {Brevo.UpdateSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -65,6 +73,8 @@ export declare class SmsCampaignsClient {
     updateSmsCampaign(request: Brevo.UpdateSmsCampaignRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __updateSmsCampaign;
     /**
+     * Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.
+     *
      * @param {Brevo.DeleteSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -96,6 +106,8 @@ export declare class SmsCampaignsClient {
     requestSmsRecipientExport(request: Brevo.RequestSmsRecipientExportRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.RequestSmsRecipientExportResponse>;
     private __requestSmsRecipientExport;
     /**
+     * Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account''s SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned. The campaign must have valid recipients and content already configured.
+     *
      * @param {Brevo.SendSmsCampaignNowRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -133,6 +145,8 @@ export declare class SmsCampaignsClient {
     sendSmsReport(request: Brevo.SendSmsReportRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __sendSmsReport;
     /**
+     * Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).
+     *
      * @param {Brevo.SendTestSmsRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -147,6 +161,8 @@ export declare class SmsCampaignsClient {
     sendTestSms(request: Brevo.SendTestSmsRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __sendTestSms;
     /**
+     * Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.
+     *
      * @param {Brevo.UpdateSmsCampaignStatusRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *

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

@@ -31,6 +31,8 @@ export class SmsCampaignsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
+     * Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.
+     *
      * @param {Brevo.GetSmsCampaignsRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -60,7 +62,11 @@ export class SmsCampaignsClient {
                 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, "smsCampaigns"),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 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,
@@ -86,6 +92,8 @@ export class SmsCampaignsClient {
         });
     }
     /**
+     * Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment. If a scheduledAt date is provided, listIds in recipients become mandatory; accounts under validation are limited to 4 total campaigns and campaigns with more than 10 recipients will be saved as draft.
+     *
      * @param {Brevo.CreateSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -111,7 +119,7 @@ export class SmsCampaignsClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: request,
                 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,
@@ -139,6 +147,8 @@ export class SmsCampaignsClient {
         });
     }
     /**
+     * Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.
+     *
      * @param {Brevo.GetSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -163,7 +173,7 @@ export class SmsCampaignsClient {
                 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, `smsCampaigns/${core.url.encodePathParam(campaignId)}`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -191,6 +201,8 @@ export class SmsCampaignsClient {
         });
     }
     /**
+     * Update an existing SMS campaign''s properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update. The campaign must exist and must be of type SMS; if a scheduledAt is provided, valid recipients must be present either in the request or already configured on the campaign.
+     *
      * @param {Brevo.UpdateSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -216,7 +228,7 @@ export class SmsCampaignsClient {
                 method: "PUT",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -246,6 +258,8 @@ export class SmsCampaignsClient {
         });
     }
     /**
+     * Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.
+     *
      * @param {Brevo.DeleteSmsCampaignRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -270,7 +284,7 @@ export class SmsCampaignsClient {
                 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, `smsCampaigns/${core.url.encodePathParam(campaignId)}`),
                 method: "DELETE",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -326,7 +340,7 @@ export class SmsCampaignsClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -359,6 +373,8 @@ export class SmsCampaignsClient {
         });
     }
     /**
+     * Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account''s SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned. The campaign must have valid recipients and content already configured.
+     *
      * @param {Brevo.SendSmsCampaignNowRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -384,7 +400,7 @@ export class SmsCampaignsClient {
                 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, `smsCampaigns/${core.url.encodePathParam(campaignId)}/sendNow`),
                 method: "POST",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 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,
@@ -447,7 +463,7 @@ export class SmsCampaignsClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -477,6 +493,8 @@ export class SmsCampaignsClient {
         });
     }
     /**
+     * Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).
+     *
      * @param {Brevo.SendTestSmsRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -502,7 +520,7 @@ export class SmsCampaignsClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,
@@ -532,6 +550,8 @@ export class SmsCampaignsClient {
         });
     }
     /**
+     * Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.
+     *
      * @param {Brevo.UpdateSmsCampaignStatusRequest} request
      * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -558,7 +578,7 @@ export class SmsCampaignsClient {
                 method: "PUT",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
                 requestType: "json",
                 body: _body,
                 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,

package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts

@@ -6,11 +6,11 @@ import type * as Brevo from "../../../../index.mjs";
 export interface GetSmsCampaignsRequest {
     /** Status of campaign. */
     status?: Brevo.GetSmsCampaignsRequestStatus;
-    /** **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) */
+    /** **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `startDate` must not be in the future. */
     startDate?: string;
-    /** **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) */
+    /** **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `endDate` must not be in the future. */
     endDate?: string;
-    /** Number limitation for the result returned */
+    /** Number of documents per page */
     limit?: number;
     /** Beginning point in the list to retrieve from. */
     offset?: number;