@voucherify/sdk 2.5.0 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,116 @@
 # @voucherify/sdk
 
+## 2.7.0
+
+### Minor Changes
+
+- [`32fa44a`](https://github.com/voucherifyio/voucherify-js-sdk/commit/32fa44ab17b21bda9daf953eaf4969d528c2d707) [#255](https://github.com/voucherifyio/voucherify-js-sdk/pull/255) Thanks [@awilczek](https://github.com/awilczek)! - Update axios to 1.6.5 in SDK package
+
+* [`8df2fed`](https://github.com/voucherifyio/voucherify-js-sdk/commit/8df2fed2b4319f681d0ff17b9bb15e6bbf80dd7c) [#254](https://github.com/voucherifyio/voucherify-js-sdk/pull/254) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Add support for few endpoints of Loyalties API.
+  - Added support for new endpoints: `POST /v1/qualifications`, `POST /client/v1/qualifications` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
+  - New exported types/interfaces: `InapplicableTo`, `Referrer`, `ReferrerWithSummaryLoyaltyReferrals`, `Customer`, `CustomerWithSummaryLoyaltyReferrals`, `CustomerSummary`, `CustomerSummaryRedemptions`, `CustomerSummaryOrders`, `CustomerLoyalty`, `CustomerReferrals`, `Discount`, `DiscountAmount_`, `DiscountUnit_`, `DiscountUnitBase_`, `DiscountUnitMultiple_`, `DiscountPercent_`, `DiscountFixed_`, `Order`, `OrderItem`, `OrderCalculated`, `OrderRedemptions`, `OrderItemCalculated`, `QualificationsCheckEligibilityRequestBody`, `QualificationsCheckEligibilityResponseBody`, `QualificationsFiltersFields`, `QualificationsFiltersCondition`, `QualificationsFieldConditions`, `QualificationsRedeemablesResponse`, `QualificationsStackingRulesResponse`, `QualificationsRedeemable`, `QualificationsRedeemableBase`, `RedeemableSingleResultResponse`, `ValidationRulesAssignmentsList`,
+  - Added optional properties to `ApplicableTo`: `product_id`, `product_source_id`, `quantity_limit`, `aggregated_quantity_limit`, `amount_limit`, `aggregated_amount_limit`, `order_item_indices`
+  - Added required property: `data_ref: 'data'` to `ApplicableToResultList` // NOTE: as this type is only used in responses, this is not a breaking change.
+  - Added optional properties to `CustomerRequest`: `birthday` and `birthdate`
+
+## 2.6.0
+
+### Minor Changes
+
+- [`8a3bead`](https://github.com/voucherifyio/voucherify-js-sdk/commit/8a3bead11809f676778d53dddd0ef49f6f17358d) [#252](https://github.com/voucherifyio/voucherify-js-sdk/pull/252) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Added support for new endpoints and adding missing types in Rewards API.
+
+  Added support for new endpoints:
+
+  - `/loyalties/{campaignId}/rewards/{assignmentId}`,
+  - `/loyalties/{campaignId}/tiers/{tierId}/rewards`,
+  - `/rewards/{rewardId}/assignments/{assignmentId}` (example available in readme.md)
+
+  New exported types/interfaces in `Loyalties.ts`:
+  Domain types:
+
+  - LoyaltyTierRewardItemParameters,
+  - LoyaltyTierRewardItemCampaignParameters,
+  - LoyaltyTierRewardItemCoinParameters,
+  - LoyaltyTierRewardItemMaterialParameters,
+  - LoyaltyTierRewardItemCampaignDiscountCoupons,
+  - LoyaltyTierRewardItemCampaignGiftVouchersAndLoyaltyProgram
+
+  0-level types:
+
+  - LoyaltiesGetRewardAssignmentResponseBody,
+  - LoyaltiesListLoyaltyTierRewardsResponseBody
+
+  New exported types/interfaces in `Rewards.ts`:
+  Domain types:
+
+  - RewardAssignment (old `RewardsAssignmentObject`),
+  - RewardsAssignmentCampaignOrMaterialReward,
+  - RewardsAssignmentCoinReward
+  -
+
+  0-level types:
+
+  - RewardsListAssignmentsRequestQuery (old `RewardsListAssignmentsParams`),
+  - RewardsListAssignmentsResponseBody (old `RewardsListAssignmentsResponse`),
+  - RewardsCreateAssignmentRequestBody (old `RewardsCreateAssignment`),
+  - RewardsCreateAssignmentCoinRewardRequestBody,
+  - RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody,
+  - RewardsCreateAssignmentResponseBody (old `RewardsCreateAssignmentResponse`),
+  - RewardsUpdateAssignmentRequestBody (old `RewardsUpdateAssignment`),
+  - RewardsUpdateAssignmentResponseBody (old `RewardsUpdateAssignmentResponse`)
+  - RewardsGetAssignmentResponseBody (brand new)
+
+  ***
+
+  Added support for following endpoints:
+
+  - GET /vouchers/{code}/transactions (client.vouchers.listTransactions(code, query))
+  - POST /vouchers/{code}/transactions/export (client.vouchers.exportTransactions(code, body))
+  - GET /validation-rules-assignments (client.client.validationRules.listRulesAssignments(validationRuleId))
+
+  **New exported types/interfaces**
+  Domain types:
+
+  - GiftCardTransaction
+  - GiftCardTransactionBase
+    GiftCardTransactionDetails
+  - GiftCardTransactionRedemptionDetails
+  - GiftCardTransactionRefundDetails
+  - GiftCardTransactionAdditionDetails
+  - GiftCardTransactionRemovalDetails
+  - VoucherTransaction
+  - VoucherTransactionsExportFields
+  - ValidationRulesAssignment
+
+  0-level types:
+
+  - VouchersListTransactionsRequestQuery
+  - VouchersListTransactionsResponseBody
+  - VouchersExportTransactionsRequestBody
+  - VouchersExportTransactionsResponseBody
+  - ValidationRulesListRulesAssignmentsRequestQuery
+  - ValidationRulesListRulesAssignmentsResponseBody
+
+  **Other changes**
+
+  - Use `VouchersExportTransactionsRequestBody` as `LoyaltiesExportCardTransactionsRequestBody` (these types are identical, both related to the export of loyalty card transactions)
+  - Use `VouchersExportTransactionsResponseBody` as `LoyaltiesExportCardTransactionsResponseBody` (these types are identical, both related to the export of loyalty card transactions)
+
+  ***
+
+  New exported types/interfaces in `Categories.ts`:
+
+  - CategoriesListRequestQuery
+
+  Added support for query parameters(CategoriesListRequestQuery) in `/categories` (categories.list method)
+
+  ***
+
+  Add support for few endpoints of Loyalties API:
+
+  - Added support for new endpoints: `GET /promotions/{campaignId}/stacks`, `GET /promotions/{campaignId}/stacks`, `GET PUT DELETE /promotions/{campaignId}/stacks/{stackId}`, `GET /promotions/stacks` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
+  - New exported types/interfaces: `PromotionsStacksListInCampaignResponseBody`, `PromotionsStacksListResponseBody`, `PromotionsStacksListRequestQuery`, `PromotionsStacksGetResponseBody`, `PromotionsStacksUpdateRequestBody`, `PromotionsStacksUpdateResponseBody`, `PromotionsStacksCreateInCampaignRequestBody`, `PromotionsStacksCreateInCampaignResponseBody`, `PromotionStackBase`, `PromotionStack`
+
 ## 2.5.0
 
 ### Minor Changes

package/README.md

@@ -155,6 +155,8 @@ Methods are provided within `client.vouchers.*` namespace.
 - [Update Vouchers in bulk](#update-vouchers-in-bulk)
 - [Release Validation Session](#release-validation-session)
 - [Import Vouchers using CSV](#import-vouchers-using-csv)
+- [List Voucher Transactions](#list-voucher-transactions)
+- [Export Voucher Transactions](#export-voucher-transactions)
 
 #### [Create Voucher](https://docs.voucherify.io/reference/create-voucher)
 
@@ -244,6 +246,18 @@ client.vouchers.releaseValidationSession(code, sessionKey)
 client.vouchers.importCSV(filePath)
 ```
 
+#### [List Voucher Transactions](https://docs.voucherify.io/reference/list-voucher-transactions)
+
+```javascript
+client.vouchers.listTransactions(code, query)
+```
+
+#### [Export Voucher Transactions](https://docs.voucherify.io/reference/export-voucher-transactions)
+
+```javascript
+client.vouchers.exportTransactions(code, body)
+```
+
 ---
 
 ### Campaigns
@@ -436,6 +450,20 @@ client.categories.list()
 
 ---
 
+### Qualifications
+
+Methods are provided within `client.qualifications.*` or `client.promotions.*` namespace.
+
+- [Check Eligibility](#Check-Eligibility)
+
+#### [Check Eligibility](https://docs.voucherify.io/reference/check-eligibility)
+
+```javascript
+client.qualifications.checkEligibility(body)
+```
+
+---
+
 ### Validations
 
 Methods are provided within `client.validations.*` or `client.promotions.*` namespace.
@@ -950,6 +978,7 @@ Methods are provided within `client.rewards.*` namespace.
 - [Update Reward](#update-reward)
 - [Delete Reward](#delete-reward)
 - [List Rewards](#list-rewards)
+- [Get Assignment](#get-reward-assignment)
 - [Create Reward Assignment](#create-reward-assignment)
 - [Update Reward Assignment](#update-reward-assignment)
 - [Delete Reward Assignment](#delete-reward-assignment)
@@ -988,13 +1017,19 @@ client.rewards.list()
 client.rewards.list(params)
 ```
 
+#### [Get Reward Assignment](https://docs.voucherify.io/reference/get-reward-assignment)
+
+```javascript
+client.rewards.getAssignment(rewardId, assignment)
+```
+
 #### [Create Reward Assignment](https://docs.voucherify.io/reference/create-reward-assignment)
 
 ```javascript
 client.rewards.createAssignment(rewardId, assignment)
 ```
 
-Check [reward assignment object](https://docs.voucherify.io/reference/the-reward-assignment-object).
+Check [reward assignment object](https://docs.voucherify.io/reference/reward-assignment-object).
 
 #### [Update Reward Assignment](https://docs.voucherify.io/reference/update-reward-assignment)
 
@@ -1029,6 +1064,7 @@ Methods are provided within `client.loyalties.*` namespace.
 - [Create Loyalty Program Reward Assignment](#create-loyalty-program-reward-assignment)
 - [Update Loyalty Program Reward Assignment](#update-loyalty-program-reward-assignment)
 - [Delete Loyalty Program Reward Assignment](#delete-loyalty-program-reward-assignment)
+- [Get Loyalty Program Reward Assignment](#get-loyalty-program-reward-assignment)
 - [List Loyalty Program Reward Assignments](#list-loyalty-program-reward-assignments)
 - [Create Loyalty Program Earning Rules](#create-loyalty-program-earning-rules)
 - [Update Loyalty Program Earning Rule](#update-loyalty-program-earning-rule)
@@ -1046,6 +1082,7 @@ Methods are provided within `client.loyalties.*` namespace.
 - [Transfer Loyalty Points](#transfer-loyalty-points)
 - [Get Loyalty Points Expiration](#get-loyalty-points-expiration)
 - [Redeem Loyalty Card](#redeem-loyalty-card)
+- [List Loyalty Tier Rewards](#list-loyalty-tier-rewards)
 - [List Loyalty Card Transactions](#list-loyalty-card-transactions)
 - [[Export Loyalty Card Transactions](#export-loyalty-card-transactions)
 - [Get Reward Assignment](#get-reward-assignment)
@@ -1105,6 +1142,13 @@ client.loyalties.updateRewardAssignment(campaignId, assignment)
 client.loyalties.deleteRewardAssignment(campaignId, assignmentId)
 ```
 
+#### [Get Loyalty Program Reward Assignment](https://docs.voucherify.io/reference/get-reward-assignment-2)
+
+```javascript
+client.loyalties.getRewardAssignment(campaignId, assignmentId)
+```
+
+
 #### [List Loyalty Program Reward Assignments](https://docs.voucherify.io/reference/list-reward-assignments-1)
 
 ```javascript
@@ -1245,6 +1289,12 @@ client.loyalties.redeemReward(campaignId, memberId, params)
 
 When redeeming reward with type `COIN` you need to provide additional `order` object in the `params`
 
+#### [List Loyalty Tier Rewards](https://docs.voucherify.io/reference/list-loyalty-tier-rewards)
+
+```javascript
+client.loyalties.listLoyaltyTierRewards(campaignId, tierId)
+```
+
 ---
 
 #### [List Loyalty Card Transactions](https://docs.voucherify.io/reference/list-loyalty-card-transactions)
@@ -1372,7 +1422,8 @@ Methods are provided within `client.validationRules.*` namespace.
 - [Create Rule Assignment](#create-validation-rule-assignment)
 - [Delete Rule Assignment](#delete-validation-rule-assignment)
 - [List Rules](#list-validation-rules)
-- [List Rule Assignments](#list-validation-rule-assignments)
+- [List Validation Rule Assignments](#list-validation-rule-assignments)
+- [List Validation Rules Assignments](#list-validation-rules-assignments)
 
 #### [Create Validation Rule](https://docs.voucherify.io/reference/create-validation-rules)
 
@@ -1426,6 +1477,13 @@ client.validationRules.listAssignments(validationRuleId)
 client.validationRules.listAssignments(validationRuleId, params)
 ```
 
+#### [List Validation Rules Assignments](https://docs.voucherify.io/reference/list-validation-rules-assignments)
+
+```javascript
+client.validationRules.listRulesAssignments(validationRuleId)
+client.validationRules.listRulesAssignments(validationRuleId, params)
+```
+
 ---
 
 ### Events
@@ -1562,6 +1620,7 @@ Methods are provided within `client.*` namespace.
 - [List consents](#list-consents)
 - [Update consents](#update-consents)
 - [Track custom events](#track-custom-events)
+- [Qualifications](#Qualifications)
 
 #### Set Identity
 
@@ -1634,6 +1693,12 @@ client.updateConsents(idOrSourceId, consents)
 client.track(eventName, metadata, customer)
 ```
 
+#### [Qualifications](https://docs.voucherify.io/reference/check-eligibility-client-side)
+
+```javascript
+client.qualifications(body)
+```
+
 # <a name="snippet"></a>🏎 Marketer-ready Voucherify snippet
 
 Go [here](./examples/sdk/with-html) for more HTML-based examples

package/dist/Categories.d.ts

@@ -6,7 +6,7 @@ export declare class Categories {
     /**
      * @see https://docs.voucherify.io/reference/list-categories
      */
-    list(): Promise<T.ListCategories>;
+    list(params?: T.CategoriesListRequestQuery): Promise<T.ListCategories>;
     /**
      * @see https://docs.voucherify.io/reference/create-category
      */

package/dist/ClientSide.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/ClientSide';
+import * as TQ from './types/Qualifications';
 import type { RequestController } from './RequestController';
 export declare class ClientSide {
     private client;
@@ -45,4 +46,8 @@ export declare class ClientSide {
      * @see https://docs.voucherify.io/reference/redeem-stackable-discounts-client-side
      */
     redeemStackable(params: T.ClientSideRedemptionsRedeemStackableParams): Promise<import("./types").RedemptionsRedeemStackableResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/check-eligibility
+     */
+    qualifications(body: TQ.QualificationsCheckEligibilityRequestBody): Promise<TQ.QualificationsCheckEligibilityResponseBody>;
 }

package/dist/Loyalties.d.ts

@@ -39,6 +39,10 @@ export declare class Loyalties {
      * @see https://docs.voucherify.io/reference/delete-reward-assignment-1
      */
     deleteRewardAssignment(campaignId: string, assignmentId: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-reward-assignment-2
+     */
+    getRewardAssignment(campaignId: string, assignmentId: string): Promise<import("./types").RewardAssignment>;
     /**
      * @see https://docs.voucherify.io/reference/list-earning-rules
      */
@@ -110,6 +114,10 @@ export declare class Loyalties {
      * @see https://docs.voucherify.io/reference/redeem-loyalty-card
      */
     redeemReward(campaignId: string, memberId: string, params: T.LoyaltiesRedeemRewardParams): Promise<T.LoyaltiesRedeemRewardResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-loyalty-tier-rewards
+     */
+    listLoyaltyTierRewards(campaignId: string, tierId: string): Promise<T.LoyaltiesListLoyaltyTierRewardsResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
      * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
@@ -119,11 +127,7 @@ export declare class Loyalties {
      * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
      * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
      */
-    exportCardTransactions(memberId: string, campaignId: string | null, params?: T.LoyaltiesExportCardTransactionsRequestBody): Promise<T.LoyaltiesExportCardTransactionsResponseBody>;
-    /**
-     * @see https://docs.voucherify.io/reference/get-reward-assignment-1
-     */
-    getRewardAssignment(campaignId: string, assignmentId: string): Promise<import("./types").RewardAssignment>;
+    exportCardTransactions(memberId: string, campaignId: string | null, params?: T.LoyaltiesExportCardTransactionsRequestBody): Promise<import("./types").VouchersExportTransactionsResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/get-reward-details
      */

package/dist/Promotions.d.ts

@@ -1,10 +1,12 @@
 import * as T from './types/Promotions';
 import type { RequestController } from './RequestController';
 import type { PromotionTiers } from './PromotionTiers';
+import { PromotionsStacks } from './PromotionsStacks';
 export declare class Promotions {
     private client;
     tiers: PromotionTiers;
-    constructor(client: RequestController, tiers: PromotionTiers);
+    stack: PromotionsStacks;
+    constructor(client: RequestController, tiers: PromotionTiers, stack: PromotionsStacks);
     /**
      * @see https://docs.voucherify.io/reference/create-promotion-campaign
      */

package/dist/PromotionsStacks.d.ts

@@ -0,0 +1,30 @@
+import * as T from './types/PromotionsStacks';
+import type { RequestController } from './RequestController';
+export declare class PromotionsStacks {
+    private client;
+    constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+     */
+    listInCampaign(campaignId: string): Promise<T.PromotionsStacksListInCampaignResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+     */
+    createInCampaign(campaignId: string, body: T.PromotionsStacksCreateInCampaignRequestBody): Promise<T.PromotionsStacksCreateInCampaignResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-promotion-stack
+     */
+    delete(campaignId: string, stackId: string): Promise<{}>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-promotion-stack
+     */
+    get(campaignId: string, stackId: string): Promise<T.PromotionStack>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-promotion-stack
+     */
+    update(campaignId: string, stackId: string, body: T.PromotionsStacksUpdateRequestBody): Promise<T.PromotionsStacksUpdateResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+     */
+    list(params?: T.PromotionsStacksListRequestQuery): Promise<T.PromotionsStacksListResponseBody>;
+}

package/dist/Qualifications.d.ts

@@ -0,0 +1,10 @@
+import * as T from './types/Qualifications';
+import type { RequestController } from './RequestController';
+export declare class Qualifications {
+    private client;
+    constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/check-eligibility
+     */
+    checkEligibility(body: T.QualificationsCheckEligibilityRequestBody): Promise<T.QualificationsCheckEligibilityResponseBody>;
+}

package/dist/Rewards.d.ts

@@ -23,17 +23,21 @@ export declare class Rewards {
      * @see https://docs.voucherify.io/reference/delete-reward
      */
     delete(rewardId: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-reward-assignment
+     */
+    getAssignment(rewardId: string, assignmentId: string): Promise<T.RewardAssignment>;
     /**
      * @see https://docs.voucherify.io/reference/list-reward-assignments
      */
-    listAssignments(rewardId: string, params?: T.RewardsListAssignmentsParams): Promise<T.RewardsListAssignmentsResponse>;
+    listAssignments(rewardId: string, params?: T.RewardsListAssignmentsRequestQuery): Promise<T.RewardsListAssignmentsResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/create-reward-assignment
      */
-    createAssignment(rewardId: string, assignment: T.RewardsCreateAssignment): Promise<T.RewardsAssignmentObject>;
+    createAssignment(rewardId: string, assignment: T.RewardsCreateAssignmentRequestBody): Promise<T.RewardAssignment>;
     /**
      * @see https://docs.voucherify.io/reference/update-reward-assignment
      */
-    updateAssignment(rewardId: string, assignment: T.RewardsUpdateAssignment): Promise<T.RewardsAssignmentObject>;
+    updateAssignment(rewardId: string, assignment: T.RewardsUpdateAssignmentRequestBody): Promise<T.RewardAssignment>;
     deleteAssignment(rewardId: string, assignmentId: string): Promise<unknown>;
 }

package/dist/ValidationRules.d.ts

@@ -32,6 +32,10 @@ export declare class ValidationRules {
      * @see https://docs.voucherify.io/reference/list-validation-rules
      */
     list(params?: T.ValidationRulesListParams): Promise<T.ValidationRulesListResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-validation-rules-assignments
+     */
+    listRulesAssignments(params?: T.ValidationRulesListRulesAssignmentsRequestQuery): Promise<T.ValidationRulesListRulesAssignmentsResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/list-validation-rule-assignments
      */

package/dist/VoucherifyServerSide.d.ts

@@ -18,6 +18,7 @@ import { ApiLimitsHandler } from './ApiLimitsHandler';
 import { MetadataSchemas } from './MetadataSchemas';
 import { Categories } from './Categories';
 import { ProductCollections } from './ProductCollections';
+import { Qualifications } from './Qualifications';
 export interface VoucherifyServerSideOptions {
     /**
      * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -118,6 +119,7 @@ export declare function VoucherifyServerSide(options: VoucherifyServerSideOption
     orders: Orders;
     products: Products;
     productCollections: ProductCollections;
+    qualifications: Qualifications;
     rewards: Rewards;
     loyalties: Loyalties;
     segments: Segments;

package/dist/Vouchers.d.ts

@@ -66,5 +66,13 @@ export declare class Vouchers {
      * @see https://docs.voucherify.io/reference/import-vouchers-using-csv
      */
     importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-voucher-transactions
+     */
+    listTransactions(code: string, params?: T.VouchersListTransactionsRequestQuery): Promise<T.VouchersListTransactionsResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/export-voucher-transactions
+     */
+    exportTransactions(code: string, body: T.VouchersExportTransactionsRequestBody): Promise<T.VouchersExportTransactionsResponseBody>;
 }
 export {};

package/dist/index.d.ts

@@ -22,3 +22,4 @@ export type { ValidationRules } from './ValidationRules';
 export type { Validations } from './Validations';
 export type { VoucherifyError } from './VoucherifyError';
 export type { Vouchers } from './Vouchers';
+export type { Qualifications } from './Qualifications';

package/dist/types/ApplicableTo.d.ts

@@ -3,13 +3,28 @@ export interface ApplicableTo {
     object: 'product' | 'sku' | 'products_collection';
     id: string;
     source_id?: string;
+    product_id?: string;
+    product_source_id?: string;
     strict: boolean;
     price?: number;
     price_formula?: number;
     effect: ApplicableToEffect;
+    quantity_limit?: number;
+    aggregated_quantity_limit?: number;
+    amount_limit?: number;
+    aggregated_amount_limit?: number;
+    order_item_indices?: number[];
 }
 export interface ApplicableToResultList {
     object: 'list';
     total: number;
     data: ApplicableTo[];
+    data_ref: 'data';
 }
+export declare type InapplicableToResultList = {
+    data: InapplicableTo[];
+    total: number;
+    object: 'list';
+    data_ref: string;
+};
+export declare type InapplicableTo = ApplicableTo;

package/dist/types/Categories.d.ts

@@ -3,6 +3,7 @@ export interface ListCategories {
     data_ref: 'data';
     data: CategoryObject[];
     total: number;
+    has_more: boolean;
 }
 export declare type CategoryObject = ResponseCreateCategory & {
     updated_at?: string;
@@ -30,3 +31,7 @@ export declare type Category = {
     updated_at?: string;
     object: 'category';
 };
+export declare type CategoriesListRequestQuery = {
+    limit?: number;
+    starting_after_id?: number;
+};

package/dist/types/Customers.d.ts

@@ -65,9 +65,11 @@ export interface CustomerRequest {
     id?: string;
     source_id?: string;
     name?: string;
-    email?: string;
-    metadata?: Record<string, any>;
     description?: string;
+    email?: string;
+    phone?: string;
+    birthday?: string;
+    birthdate?: string;
     address?: {
         city?: string;
         state?: string;
@@ -76,7 +78,7 @@ export interface CustomerRequest {
         country?: string;
         postal_code?: string;
     };
-    phone?: string;
+    metadata?: Record<string, any>;
 }
 export interface CustomersCommonListRequest {
     limit?: number;
@@ -142,6 +144,89 @@ declare type CustomerAddress = {
         postal_code?: string | null;
     } | null;
 };
+export declare type Referrer = CustomerRequest;
+export declare type Customer = CustomerRequest;
+export declare type ReferrerWithSummaryLoyaltyReferrals = CustomerWithSummaryLoyaltyReferrals;
+export declare type CustomerId = {
+    id: string;
+    object: 'customer';
+};
+export declare type ReferrerId = CustomerId;
+export declare type CustomerWithSummaryLoyaltyReferrals = {
+    id?: string;
+    source_id?: string;
+    name?: string;
+    description?: string;
+    email?: string;
+    phone?: string;
+    birthday?: string;
+    birthdate?: string;
+    address: {
+        city?: string;
+        state?: string;
+        line_1?: string;
+        line_2?: string;
+        country?: string;
+        postal_code?: string;
+    } | null;
+    metadata?: Record<string, any>;
+    summary: CustomerSummary;
+    loyalty: CustomerLoyalty;
+    referrals: CustomerReferrals;
+    system_metadata: Record<string, unknown>;
+    created_at: string;
+    updated_at?: string;
+    assets?: {
+        cockpit_url?: string;
+    };
+    object: 'customer';
+};
+export declare type CustomerSummary = {
+    redemptions: CustomerSummaryRedemptions;
+    orders: CustomerSummaryOrders;
+};
+export declare type CustomerSummaryRedemptions = {
+    total_redeemed: number;
+    total_failed: number;
+    total_succeeded: number;
+    total_rolled_back: number;
+    total_rollback_failed: number;
+    total_rollback_succeeded: number;
+    gift: {
+        redeemed_amount: number;
+        amount_to_go: number;
+    };
+    loyalty_card: {
+        redeemed_points: number;
+        points_to_go: number;
+    };
+};
+export declare type CustomerSummaryOrders = {
+    total_amount: number;
+    total_count: number;
+    average_amount: number;
+    last_order_amount: number;
+    last_order_date: string;
+};
+export declare type CustomerLoyalty = {
+    points: number;
+    referred_customers: number;
+    campaigns: Record<string, {
+        points: number;
+        loyalty_tier: string;
+        referred_customers: number;
+    }>;
+};
+export declare type CustomerReferrals = {
+    total: number;
+    campaigns: {
+        campaign_id: string;
+        referrer_id: string;
+        related_object_id: string;
+        related_object_type: string;
+        date: string;
+    }[];
+};
 export declare type CustomersUpdateInBulkRequestBody = (CustomerBase & CustomerAddress & {
     source_id: string | null;
 })[];