@voucherify/sdk 2.7.4 → 2.8.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @voucherify/sdk
 
+## 2.8.1
+
+### Patch Changes
+
+- [`a9ba013`](https://github.com/voucherifyio/voucherify-js-sdk/commit/a9ba013062c560a3a663b1f219f2dcb7ae9a8a7e) [#280](https://github.com/voucherifyio/voucherify-js-sdk/pull/280) Thanks [@p-zielinski](https://github.com/p-zielinski)! - TS fixes (VouchersListTransactionsRequestQuery, LoyaltiesListCardTransactionsRequestQuery, ProductCollectionsCreateRequestBody) - backwards compatible
+
+## 2.8.0
+
+### Minor Changes
+
+- [`2ddd6ec`](https://github.com/voucherifyio/voucherify-js-sdk/commit/2ddd6ec688f3dbc35b301e05f0fa5f6d20bdc410) [#277](https://github.com/voucherifyio/voucherify-js-sdk/pull/277) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Added support for `v1/customers/{customerId}/activity` (method `listActivity`) and fix type `ValidationValidateStackableResponse`
+
 ## 2.7.4
 
 ### Patch Changes

package/README.md

@@ -729,13 +729,19 @@ You can optionally define scrolling cursor based on customer creation date using
 
 Keep in mind this operation may drain your API call limits fairly quickly - each api call fetches 100 customers. So if you have 100.000 customers, you will use 1000 API calls.
 
-#### [Update Customer's Consents](https://docs.voucherify.io/reference/update-customers-consents)
+#### Update Customer's Consents - Deprecated
 
 ```javascript
 client.customers.updateConsents(customer, consents)
 ```
 
-#### [List Customers Activities](https://docs.voucherify.io/reference/get-customer-activities)
+#### [List Customer's Activity](https://docs.voucherify.io/reference/list-customer-activity)
+
+```javascript
+client.customers.listActivity(customerIdOrSourceId, params)
+```
+
+#### List Customers Activities - Deprecated - use listActivity
 
 ```javascript
 client.customers.listActivities(customerId)
@@ -768,15 +774,11 @@ client.customers.listRedeemables(id, params)
 
 ---
 
-### Consents
+### Consents - Deprecated
 
 Methods are provided within `client.consents.*` namespace.
 
-- [Get Consents](#get-consents)
-
-You can [update Customer's consents](#update-customers-consents) in `client.customer.*` namespace.
-
-#### [Get Consents](https://docs.voucherify.io/reference/get-consents)
+#### Get Consents - Deprecated
 
 ```javascript
 client.consents.list()

package/dist/Consents.d.ts

@@ -4,7 +4,7 @@ export declare class Consents {
     private client;
     constructor(client: RequestController);
     /**
-     * @see https://docs.voucherify.io/reference/get-consents
+     * @deprecated This method is deprecated. We’re removing this method in next major version.
      */
     list(): Promise<T.ConsentsListResponse>;
 }

package/dist/Customers.d.ts

@@ -49,11 +49,15 @@ declare class Customers {
      */
     deletePermanently(customerId: string): Promise<T.CustomersDeletePermanentlyResponseBody>;
     /**
-     * @see https://docs.voucherify.io/reference/update-customers-consents
+     * @see https://docs.voucherify.io/reference/list-customer-activity
+     */
+    listActivity(customerIdOrSourceId: string, params?: T.CustomerActivityListQueryParams): Promise<T.CustomerActivityListResponse>;
+    /**
+     * @deprecated This method is deprecated. We’re removing this method in next major version.
      */
     updateConsents(idOrSourceId: string, consents: T.CustomersUpdateConsentsBody): Promise<undefined>;
     /**
-     * @see https://docs.voucherify.io/reference/get-customer-activities
+     * @deprecated This method is deprecated in favor of the `listActivity` method. We’re removing this method in next major version.
      */
     listActivities(customerId: string, params?: T.CustomerActivitiesListQueryParams): Promise<T.CustomerActivitiesListResponse>;
     /**

package/dist/types/Customers.d.ts

@@ -97,6 +97,24 @@ export interface CustomersCommonListResponse {
     customers: CustomerObject[];
     has_more?: boolean;
 }
+export interface CustomerActivityListQueryParams {
+    limit?: number;
+    order?: 'created_at' | '-created_at';
+    starting_after_id?: string;
+    campaign_type?: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+    campaign_id?: string;
+    category?: 'ACTION' | 'EFFECT';
+    type?: string;
+    start_date?: string;
+    end_date?: string;
+}
+export interface CustomerActivityListResponse {
+    object: 'list';
+    data_ref: 'data';
+    data: Record<string, unknown>[];
+    has_more: boolean;
+    more_starting_after?: string;
+}
 export interface CustomerActivitiesListQueryParams {
     limit?: number;
     order?: 'created_at' | '-created_at';

package/dist/types/Loyalties.d.ts

@@ -551,6 +551,11 @@ export interface LoyaltiesGetPointsExpirationResponseBody {
 }
 export interface LoyaltiesListCardTransactionsRequestQuery {
     limit?: number;
+    starting_after_id?: string;
+    order?: 'id' | '-id';
+    /**
+     * @deprecated Use starting_after_id
+     */
     page?: number;
 }
 export interface LoyaltiesListCardTransactionsResponseBody {
@@ -558,6 +563,7 @@ export interface LoyaltiesListCardTransactionsResponseBody {
     data_ref: 'data';
     data: LoyaltyCardTransaction[];
     has_more: boolean;
+    more_starting_after?: string;
 }
 export declare type LoyaltiesExportCardTransactionsRequestBody = VouchersExportTransactionsRequestBody;
 export interface LoyaltiesAddOrRemoveCardBalanceRequestBody {
@@ -648,12 +654,6 @@ export interface LoyaltiesListCardTransactionsRequestQuery {
     limit?: number;
     page?: number;
 }
-export interface LoyaltiesListCardTransactionsResponseBody {
-    object: 'list';
-    data_ref: 'data';
-    data: LoyaltyCardTransaction[];
-    has_more: boolean;
-}
 export declare type LoyaltiesExportCardTransactionsResponseBody = VouchersExportTransactionsResponseBody;
 export interface LoyaltiesAddOrRemoveCardBalanceRequestBody {
     points: number;

package/dist/types/ProductCollections.d.ts

@@ -57,12 +57,13 @@ export interface DynamicProductCollectionBase {
     filter?: Filter;
 }
 export declare type ProductCollection = ProductCollectionBase & ProductCollectionIdentity & ProductCollectionSaved;
-export declare type Filter = {
-    junction: Junction;
-} & Partial<Record<AllowedFiltersKeys, {
+export declare type Filter = Partial<Record<string, Junction | {
     conditions: Partial<Record<FiltersCondition, unknown>>;
 }>>;
 export declare type Junction = 'and' | 'AND' | 'or' | 'OR';
+/**
+ * @deprecated
+ */
 export declare type AllowedFiltersKeys = 'id' | 'name' | 'attributes' | 'source_id' | 'price' | 'image_url' | 'product_id' | 'skus' | 'created_at' | 'updated_at' | 'object' | `metadata.${string}`;
 export declare type FiltersCondition = '$in' | '$not_in' | '$is' | '$is_days_ago' | '$is_days_in_future' | '$is_not' | '$has_value' | '$is_unknown' | '$contains' | '$not_contain' | '$starts_with' | '$ends_with' | '$more_than' | '$less_than' | '$more_than_ago' | '$less_than_ago' | '$more_than_future' | '$less_than_future' | '$more_than_equal' | '$less_than_equal' | '$after' | '$before' | '$count' | '$count_less' | '$count_more';
 export declare type ProductCollectionsCreateRequestBody = WithRequiredProperty<StaticProductCollectionBase, 'name' | 'type'> | Required<DynamicProductCollectionBase>;

package/dist/types/Validations.d.ts

@@ -79,8 +79,8 @@ export interface ValidationValidateStackableResponse {
     session?: ValidationSessionResponse;
     order?: OrdersCreateResponse;
     redeemables?: StackableRedeemableResponse[];
-    skipped_redeemables?: StackableRedeemableSkippedResponse;
-    inapplicable_redeemables?: StackableRedeemableInapplicableResponse;
+    skipped_redeemables?: StackableRedeemableSkippedResponse[];
+    inapplicable_redeemables?: StackableRedeemableInapplicableResponse[];
     stacking_rules: ValidationsStackingRules;
 }
 export declare type ValidationsStackingRules = {

package/dist/types/Vouchers.d.ts

@@ -318,6 +318,11 @@ export declare type VoucherTransaction = GiftCardTransaction | LoyaltyCardTransa
 export declare type VoucherTransactionsExportFields = 'id' | 'campaign_id' | 'voucher_id' | 'type' | 'source_id' | 'reason' | 'source' | 'balance' | 'amount' | 'related_transaction_id' | 'created_at' | 'details';
 export interface VouchersListTransactionsRequestQuery {
     limit?: number;
+    starting_after_id?: string;
+    order?: 'id' | '-id';
+    /**
+     * @deprecated Use starting_after_id
+     */
     page?: number;
 }
 export interface VouchersListTransactionsResponseBody {
@@ -325,6 +330,7 @@ export interface VouchersListTransactionsResponseBody {
     data_ref: 'data';
     data: VoucherTransaction[];
     has_more: boolean;
+    more_starting_after?: string;
 }
 export interface VouchersExportTransactionsRequestBody {
     parameters?: {

package/dist/voucherifysdk.esm.js

@@ -942,7 +942,15 @@ class Customers {
     return this.client.post(`/customers/${encode(customerId)}/permanent-deletion`, {});
   }
   /**
-   * @see https://docs.voucherify.io/reference/update-customers-consents
+   * @see https://docs.voucherify.io/reference/list-customer-activity
+   */
+
+
+  listActivity(customerIdOrSourceId, params) {
+    return this.client.get(`/customers/${encode(customerIdOrSourceId)}/activity`, params);
+  }
+  /**
+   * @deprecated This method is deprecated. We’re removing this method in next major version.
    */
 
 
@@ -950,7 +958,7 @@ class Customers {
     return this.client.put(`/customers/${encode(idOrSourceId)}/consents`, consents);
   }
   /**
-   * @see https://docs.voucherify.io/reference/get-customer-activities
+   * @deprecated This method is deprecated in favor of the `listActivity` method. We’re removing this method in next major version.
    */
 
 
@@ -990,7 +998,7 @@ class Consents {
     this.client = client;
   }
   /**
-   * @see https://docs.voucherify.io/reference/get-consents
+   * @deprecated This method is deprecated. We’re removing this method in next major version.
    */
 
 
@@ -1952,7 +1960,7 @@ function VoucherifyServerSide(options) {
   let headers = {
     'X-App-Id': options.applicationId,
     'X-App-Token': options.secretKey,
-    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.7.4"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.8.1"}`,
     'Content-Type': 'application/json'
   };
 
@@ -2218,7 +2226,7 @@ function VoucherifyClientSide(options) {
   let headers = {
     'X-Client-Application-Id': options.clientApplicationId,
     'X-Client-Token': options.clientSecretKey,
-    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.7.4"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.8.1"}`
   };
 
   if (environment().startsWith('Node')) {