@voucherify/sdk 2.2.6 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,58 @@
 # @voucherify/sdk
 
+## 2.4.0
+
+### Minor Changes
+
+- [`b11ce2c`](https://github.com/voucherifyio/voucherify-js-sdk/commit/b11ce2c6410c7441bd48fbbf33377b98c77af072) [#241](https://github.com/voucherifyio/voucherify-js-sdk/pull/241) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Add support for 3 missing endpoints in loyalties api. Corrected a typo in one of loyalties api method.
+  - Added support for new endpoints: `GET /loyalties/{campaignId}/earning-rules/{earningRuleId}`, `POST /loyalties/{campaignId}/earning-rules/{earningRuleId}/enable` and `POST /loyalties/{campaignId}/earning-rules/{earningRuleId}/disable` [(examples available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
+  - New exported types/interfaces: `LoyaltiesGetEarningRuleResponseBody`, `LoyaltiesEnableEarningRulesResponseBody`, `LoyaltiesDisableEarningRulesResponseBody`, `EarningRuleEvent`, `EarningRuleBase`, `EarningRuleFixed`, `EarningRuleProportionalOrder`, `EarningRuleProportionalOrderAmount`, `EarningRuleProportionalOrderTotalAmount`, `EarningRuleProportionalOrderMetadata`, `EarningRuleProportionalOrderItems`, `EarningRuleProportionalOrderItemsQuantity`, `EarningRuleProportionalOrderItemsAmount`, `EarningRuleProportionalOrderItemsSubtotalAmount`, `EarningRuleProportionalCustomerMetadata`, `EarningRuleProportionalCustomEvent`, `EarningRuleProportional`
+  - Added optional parameter `calculation_type` to `LoyaltyProportional`
+
+* [`5bb69da`](https://github.com/voucherifyio/voucherify-js-sdk/commit/5bb69daf95c1e16c48eb5070149b88f11bfe1a30) [#229](https://github.com/voucherifyio/voucherify-js-sdk/pull/229) Thanks [@marcin-slezak](https://github.com/marcin-slezak)! - Add missing methods covering Customers API.
+  - Added support for new endpoints:
+    - `POST /customers/{customerId}/permanent-deletion`,
+    - `POST /customers/bulk/async`,
+    - `POST /customers/metadata/async` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
+  - New domain types:
+    - `CustomerBase`
+    - `CustomerAddress`
+  - New exported types/interfaces:
+    - `CustomersUpdateInBulkRequestBody`,
+    - `CustomersUpdateMetadataInBulkRequestBody`,
+    - `CustomersDeletePermanentlyResponseBody`
+
+## 2.3.0
+
+### Minor Changes
+
+- [`644aa84`](https://github.com/voucherifyio/voucherify-js-sdk/commit/644aa8479843b8625192aa295eb07aa19ba651d7) [#227](https://github.com/voucherifyio/voucherify-js-sdk/pull/227) Thanks [@marcin-slezak](https://github.com/marcin-slezak)! - Added support for missing CSV import endpoints ([(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)):
+  - `POST /skus/importCSV`
+  - `POST /products/importCSV`
+  - `POST /vouchers/importCSV`
+  - `POST /customers/importCSV`
+  - `POST /campaigns/campaignId/importCSV`
+  - Added form-data `4.0.0` to SDK package
+
+* [`7720e31`](https://github.com/voucherifyio/voucherify-js-sdk/commit/7720e31baea0db19a7543ae12661fab77176e5ff) [#228](https://github.com/voucherifyio/voucherify-js-sdk/pull/228) Thanks [@marcin-slezak](https://github.com/marcin-slezak)! - Add missing methods covering Categories and Campaigns API.
+  - Added support for new endpoints [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md):
+    - `POST /campaigns/campaignId/enable`,
+    - `POST /campaigns/campaignId/disable`,
+    - `GET, POST DELETE /categories`,
+    - `GET PUT /categories/id`.
+  - New exported types/interfaces in `Categories.ts`:
+    - `ListCategories`,
+    - `CategoryObject`,
+    - `CreateCategory`,
+    - `ResponseCreateCategory`,
+    - `ResponseUpdateCategory`,
+    - `UpdateCategoryRequest`.
+
+- [`52e7f5e`](https://github.com/voucherifyio/voucherify-js-sdk/commit/52e7f5e8d4ea6be4ba1b9d0550cba3ec3d893672) [#221](https://github.com/voucherifyio/voucherify-js-sdk/pull/221) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Implementing the following changes:
+  - Update axios from `0.21.4` to `0.27.2` in SDK package
+  - Added dotenv `16.3.1` to SDK package dev dependencies.
+  - Added frame for integration tests [(more info available in README.md, section "🧪 SDK Tests")](..%2F..%2FREADME.md)
+
 ## 2.2.6
 
 ### Patch Changes

package/README.md

@@ -130,7 +130,7 @@ const client = VoucherifyServerSide({
 	apiUrl: 'https://<region>.api.voucherify.io', // optional
 	apiVersion: 'v2018-08-01', // optional
 	channel: 'e-commerce', // optional
-	customHeaders: { "MY_CUSTOM_HEADER": "my_value" } // optional
+	customHeaders: { "MY_CUSTOM_HEADER": "my_value" }, // optional
 	timeoutMs: 10000 // optional
 })
 ```
@@ -154,6 +154,7 @@ Methods are provided within `client.vouchers.*` namespace.
 - [Update Vouchers Metadata in bulk](#update-vouchers-metadata-in-bulk)
 - [Update Vouchers in bulk](#update-vouchers-in-bulk)
 - [Release Validation Session](#release-validation-session)
+- [Import Vouchers using CSV](#import-vouchers-using-csv)
 
 #### [Create Voucher](https://docs.voucherify.io/reference/create-voucher)
 
@@ -237,6 +238,12 @@ client.vouchers.bulkUpdate(vouchers)
 client.vouchers.releaseValidationSession(code, sessionKey)
 ```
 
+#### [Import Vouchers using CSV](https://docs.voucherify.io/reference/import-vouchers-using-csv)
+
+```javascript
+client.vouchers.importCSV(filePath)
+```
+
 ---
 
 ### Campaigns
@@ -249,7 +256,10 @@ Methods are provided within `client.campaigns.*` namespace.
 - [Add Voucher to Campaign](#add-voucher-to-campaign)
 - [Import Vouchers to Campaign](#import-vouchers-to-campaign)
 - [List Campaigns](#list-campaigns)
+- [Import Vouchers using CSV](#import-vouchers-using-csv)
 - [Examine Campaigns Qualification](#examine-campaigns-qualification)
+- [Enable campaign](#enable-campaign)
+- [Disable campaign](#disable-campaign)
 
 #### [Create Campaign](https://docs.voucherify.io/reference/create-campaign)
 
@@ -307,13 +317,30 @@ client.campaigns.list()
 client.campaigns.list(params)
 ```
 
+#### [Import Vouchers to Campaign by CSV](https://docs.voucherify.io/reference/import-vouchers-to-campaign-using-csv)
+
+```javascript
+client.campaigns.importVouchersCSV(campaignId, filePath)
+```
+
+#### [Enable campaign](https://docs.voucherify.io/reference/enable-campaign)
+
+```javascript
+client.campaigns.enable(campaignId)
+```
+
+#### [Disable campaign](https://docs.voucherify.io/reference/disable-campaign)
+
+```javascript
+client.campaigns.disable(campaignId)
+```
+
 #### [Examine Campaigns Qualification](https://docs.voucherify.io/reference/create-qualification-request)
 
 ```javascript
 client.campaigns.qualifications.examine(body)
 client.campaigns.qualifications.examine(body, params)
 ```
-
 ---
 
 ### Distributions
@@ -359,6 +386,46 @@ client.distributions.publications.list(params)
 client.distributions.publications.create(params)
 ```
 
+### Categories
+
+Methods are provided within `client.categories.*` namespace.
+
+- [Create Category](#create-category)
+- [Update Category](#update-category)
+- [Get Category](#get-category)
+- [Delete Category](#delete-category)
+- [List Categories](#list-categories)
+
+#### [Create Category](https://docs.voucherify.io/reference/create-category)
+
+```javascript
+client.categories.create(params)
+```
+
+#### [Update Category](https://docs.voucherify.io/reference/update-category)
+
+```javascript
+client.categories.update(categoryId, params)
+```
+
+#### [Get Category](https://docs.voucherify.io/reference/get-category)
+
+```javascript
+client.categories.get(categoryId)
+```
+
+#### [Delete Category](https://docs.voucherify.io/reference/delete-category)
+
+```javascript
+client.categories.delete(categoryId)
+```
+
+#### [List Categories](https://docs.voucherify.io/reference/list-categories)
+
+```javascript
+client.categories.list()
+```
+
 ---
 
 ### Validations
@@ -507,7 +574,7 @@ Check [promotion's tier object](https://docs.voucherify.io/reference/the-promoti
 
 ```javascript
 client.promotions.tiers.listAll()
-client.promotions.tiers.listAll(params})
+client.promotions.tiers.listAll(params)
 ```
 
 #### [Add Promotion Tier to Campaign](https://docs.voucherify.io/reference/add-promotion-tier-to-campaign)
@@ -544,9 +611,13 @@ Methods are provided within `client.customers.*` namespace.
 - [Get Customer](#get-customer)
 - [Update Customer](#update-customer)
 - [Delete Customer](#delete-customer)
+- [Delete Customer Permanently](#delete-customer-permanently)
 - [List Customers](#list-customers)
 - [Update Customer's Consents](#update-customers-consents)
 - [List Customer's Activities](#list-customers-activities)
+- [Update Customers in bulk](#update-customers-in-bulk)
+- [Update Customers' Metadata in bulk](#update-customers-metadata-in-bulk)
+- [Import and Update Customers using CSV](#import-and-update-customers-using-csv)
 
 #### [Create Customer](https://docs.voucherify.io/reference/create-customer)
 
@@ -576,6 +647,12 @@ client.customers.update(customer)
 client.customers.delete(customerId)
 ```
 
+#### [Delete Customer Permanently](https://docs.voucherify.io/reference/delete-customer-permanently)
+
+```javascript
+client.customers.deletePermanently(customerId)
+```
+
 #### [List Customers](https://docs.voucherify.io/reference/list-customers)
 
 ```javascript
@@ -628,6 +705,24 @@ client.customers.listActivities(customerId)
 client.customers.listActivities(customerId, params)
 ```
 
+#### [Import and Update Customers using CSV](https://docs.voucherify.io/reference/import-customers-using-csv)
+
+```javascript
+client.customers.importCSV(filePath)
+```
+
+#### [Update Customers in bulk](https://docs.voucherify.io/reference/update-customers-in-bulk)
+
+```javascript
+client.customers.updateInBulk(customers)
+```
+
+#### [Update Customers' Metadata in bulk](https://docs.voucherify.io/reference/update-customers-metadata-in-bulk)
+
+```javascript
+client.customers.updateMetadataInBulk(sourceIdsAndMetadata)
+```
+
 ---
 
 ### Consents
@@ -707,6 +802,8 @@ Methods are provided within `client.products.*` namespace.
 - [Update SKU](#update-sku)
 - [Delete SKU](#delete-sku)
 - [List all product SKUs](#list-all-product-skus)
+- [Import SKUs using CSV](#import-skus-using-csv)
+- [Import Products using CSV](#import-products-using-csv)
 
 #### [Create Product](https://docs.voucherify.io/reference/create-product)
 
@@ -781,6 +878,18 @@ client.products.deleteSku(productId, skuId, { force: true })
 client.products.listSkus(productId)
 ```
 
+#### [Import SKUs using CSV](https://docs.voucherify.io/reference/import-skus-using-csv)
+
+```javascript
+client.products.importSkusCSV(filePath)
+```
+
+#### [Import Products using CSV](https://docs.voucherify.io/reference/import-products-using-csv)
+
+```javascript
+client.products.importCSV(filePath)
+```
+
 ---
 
 ### Rewards
@@ -875,6 +984,9 @@ Methods are provided within `client.loyalties.*` namespace.
 - [Create Loyalty Program Earning Rules](#create-loyalty-program-earning-rules)
 - [Update Loyalty Program Earning Rule](#update-loyalty-program-earning-rule)
 - [Delete Loyalty Program Earning Rule](#delete-loyalty-program-earning-rule)
+- [Get Loyalty Program Earning Rule](#get-loyalty-program-earning-rule)
+- [Enable Loyalty Program Earning Rule](#enable-loyalty-program-earning-rule)
+- [Disable Loyalty Program Earning Rule](#disable-loyalty-program-earning-rule)
 - [List Loyalty Program Earning Rules](#list-loyalty-program-earning-rules)
 - [Create Loyalty Program Member](#create-loyalty-program-member)
 - [Get Loyalty Program Member](#get-loyalty-program-member)
@@ -957,6 +1069,24 @@ client.loyalties.updateEarningRule(campaignId, earningRule)
 client.loyalties.deleteEarningRule(campaignId, earningRuleId)
 ```
 
+#### [Get Loyalty Program Earning Rule](https://docs.voucherify.io/reference/get-earning-rule)
+
+```javascript
+client.loyalties.getEarningRule(campaignId, earningRuleId)
+```
+
+#### [Enable Loyalty Program Earning Rule](https://docs.voucherify.io/reference/enable-earning-rule)
+
+```javascript
+client.loyalties.enableEarningRule(campaignId, earningRuleId)
+```
+
+#### [Disable Loyalty Program Earning Rule](https://docs.voucherify.io/reference/disable-earning-rule)
+
+```javascript
+client.loyalties.disableEarningRule(campaignId, earningRuleId)
+```
+
 #### [List Loyalty Program Earning Rules](https://docs.voucherify.io/reference/list-earning-rules)
 
 ```javascript

package/dist/Campaigns.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Campaigns';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 declare class CampaignsQualifications {
     private client;
@@ -41,5 +42,17 @@ export declare class Campaigns {
      * @see https://docs.voucherify.io/reference/list-campaigns
      */
     list(params?: T.CampaignsListParams): Promise<T.CampaignsListResponse>;
+    /**
+     * @see https://api.voucherify.io/v1/campaigns/{campaignId}/importCSV
+     */
+    importVouchersCSV(campaignId: string, filePath: string): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/enable-campaign
+     */
+    enable(campaignId: string): Promise<{}>;
+    /**
+     * @see https://docs.voucherify.io/reference/disable-campaign
+     */
+    disable(campaignId: string): Promise<{}>;
 }
 export {};

package/dist/Categories.d.ts

@@ -0,0 +1,26 @@
+import * as T from './types/Categories';
+import type { RequestController } from './RequestController';
+export declare class Categories {
+    private client;
+    constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/list-categories
+     */
+    list(): Promise<T.ListCategories>;
+    /**
+     * @see https://docs.voucherify.io/reference/create-category
+     */
+    create(createCategory: T.CreateCategory): Promise<T.ResponseCreateCategory>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-category
+     */
+    get(categoryId: string): Promise<T.CategoryObject>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-category
+     */
+    delete(categoryId: string): Promise<{}>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-category
+     */
+    update(categoryId: string, updateCategory: T.UpdateCategoryRequest): Promise<T.ResponseUpdateCategory>;
+}

package/dist/Customers.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Customers';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 declare class Customers {
     private client;
@@ -31,10 +32,22 @@ declare class Customers {
      * @see https://docs.voucherify.io/reference/update-customer
      */
     update(customer: T.CustomersUpdateParams): Promise<T.CustomersCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-customers-in-bulk
+     */
+    updateInBulk(customers: T.CustomersUpdateInBulkRequestBody): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-customers-metadata-in-bulk
+     */
+    updateMetadataInBulk(sourceIdsAndMetadata: T.CustomersUpdateMetadataInBulkRequestBody): Promise<AAT.AsyncActionCreateResponse>;
     /**
      * @see https://docs.voucherify.io/reference/delete-customer
      */
     delete(customerId: string): Promise<undefined>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-customer-permanently
+     */
+    deletePermanently(customerId: string): Promise<T.CustomersDeletePermanentlyResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/update-customers-consents
      */
@@ -43,5 +56,9 @@ declare class Customers {
      * @see https://docs.voucherify.io/reference/get-customer-activities
      */
     listActivities(customerId: string, params?: T.CustomerActivitiesListQueryParams): Promise<T.CustomerActivitiesListResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-customers-using-csv
+     */
+    importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
 }
 export { Customers };

package/dist/Loyalties.d.ts

@@ -55,6 +55,18 @@ export declare class Loyalties {
      * @see https://docs.voucherify.io/reference/delete-earning-rule
      */
     deleteEarningRule(campaignId: string, earningRuleId: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-earning-rule
+     */
+    getEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesGetEarningRuleResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/enable-earning-rule
+     */
+    enableEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesEnableEarningRulesResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/disable-earning-rule
+     */
+    disableEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesDisableEarningRulesResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/list-members
      */

package/dist/Products.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Products';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 export declare class Products {
     private client;
@@ -51,4 +52,12 @@ export declare class Products {
      * @see https://docs.voucherify.io/reference/list-skus
      */
     listSkus(productId: string): Promise<T.ProductsListSkus>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-skus-using-csv
+     */
+    importSkusCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-products-using-csv
+     */
+    importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
 }

package/dist/VoucherifyServerSide.d.ts

@@ -16,6 +16,7 @@ import { ValidationRules } from './ValidationRules';
 import { Segments } from './Segments';
 import { ApiLimitsHandler } from './ApiLimitsHandler';
 import { MetadataSchemas } from './MetadataSchemas';
+import { Categories } from './Categories';
 export interface VoucherifyServerSideOptions {
     /**
      * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -106,6 +107,7 @@ export interface VoucherifyServerSideOptions {
 export declare function VoucherifyServerSide(options: VoucherifyServerSideOptions): {
     vouchers: Vouchers;
     campaigns: Campaigns;
+    categories: Categories;
     distributions: Distributions;
     validations: Validations;
     redemptions: Redemptions;

package/dist/Vouchers.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Vouchers';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 import type { Balance } from './Balance';
 declare class VouchersQualification {
@@ -61,5 +62,9 @@ export declare class Vouchers {
      * @see https://docs.voucherify.io/reference/release-validation-session
      */
     releaseValidationSession(code: string, sessionKey: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-vouchers-using-csv
+     */
+    importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
 }
 export {};

package/dist/types/Categories.d.ts

@@ -0,0 +1,24 @@
+export interface ListCategories {
+    object: 'list';
+    data_ref: 'data';
+    data: CategoryObject[];
+    total: number;
+}
+export declare type CategoryObject = ResponseCreateCategory & {
+    updated_at?: string;
+};
+export interface CreateCategory {
+    name: string;
+    hierarchy: number;
+}
+export interface ResponseCreateCategory {
+    id: string;
+    name: string;
+    hierarchy: number;
+    created_at: string;
+    object: 'category';
+}
+export declare type ResponseUpdateCategory = ResponseCreateCategory & {
+    updated_at: string;
+};
+export declare type UpdateCategoryRequest = CreateCategory;

package/dist/types/Customers.d.ts

@@ -124,4 +124,46 @@ declare type IdOrSourceId = {
 export declare type CustomersUpdateParams = CustomerRequest & IdOrSourceId;
 export declare type CustomersUpdateResponse = CustomerObject | CustomerUnconfirmed;
 export declare type CustomersUpdateConsentsBody = Record<string, boolean>;
+declare type CustomerBase = {
+    name?: string | null;
+    description?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    birthdate?: string | null;
+    metadata?: Record<string, unknown> | null;
+};
+declare type CustomerAddress = {
+    address?: {
+        city?: string | null;
+        state?: string | null;
+        line_1?: string | null;
+        line_2?: string | null;
+        country?: string | null;
+        postal_code?: string | null;
+    } | null;
+};
+export declare type CustomersUpdateInBulkRequestBody = (CustomerBase & CustomerAddress & {
+    source_id: string | null;
+})[];
+export interface CustomersUpdateMetadataInBulkRequestBody {
+    source_ids: string[];
+    metadata: Record<string, unknown>;
+}
+export interface CustomersDeletePermanentlyResponseBody {
+    id: string;
+    created_at: string;
+    related_object_id: string;
+    related_object: 'customer';
+    status: 'DONE';
+    data_json: {
+        events: number;
+        customer_events: number;
+        daily_events: number;
+        segments: number;
+        orders: number;
+        order_events: number;
+        customer: 1;
+    };
+    object: 'pernament_deletion';
+}
 export {};

package/dist/types/Loyalties.d.ts

@@ -154,6 +154,7 @@ export interface LoyaltyFixed {
 }
 export interface LoyaltyProportional {
     type: 'PROPORTIONAL';
+    calculation_type?: 'ORDER_AMOUNT' | 'ORDER_TOTAL_AMOUNT' | 'ORDER_METADATA' | 'ORDER_ITEMS_QUANTITY' | 'ORDER_ITEMS_AMOUNT' | 'ORDER_ITEMS_SUBTOTAL_AMOUNT' | 'CUSTOMER_METADATA' | 'CUSTOM_EVENT_METADATA';
     order?: {
         amount: {
             every: number;
@@ -464,4 +465,144 @@ export interface LoyaltyPointsTransfer {
     code: string;
     points: number;
 }
+export declare type LoyaltiesGetEarningRuleResponseBody = EarningRuleBase & {
+    validation_rule_id: string | null;
+    updated_at: string | null;
+    active: boolean;
+};
+export declare type LoyaltiesEnableEarningRulesResponseBody = EarningRuleBase & {
+    updated_at: string | null;
+    active: true;
+};
+export declare type LoyaltiesDisableEarningRulesResponseBody = EarningRuleBase & {
+    updated_at: string | null;
+    active: false;
+};
+export interface EarningRuleBase {
+    id: string;
+    created_at: string;
+    loyalty: EarningRuleFixed | EarningRuleProportional;
+    event?: EarningRuleEvent;
+    custom_event?: {
+        schema_id: string;
+    };
+    segment?: {
+        id: string;
+    };
+    source: {
+        banner?: string;
+        object_id: string;
+        object_type: 'campaign';
+    };
+    loyalty_tier?: {
+        id: string;
+    };
+    object: 'earning_rule';
+    automation_id: string;
+    start_date?: string;
+    expiration_date?: string;
+    validity_timeframe?: {
+        duration: string;
+        interval: string;
+    };
+    validity_day_of_week?: number[];
+    metadata: Record<string, unknown>;
+}
+export declare type EarningRuleEvent = 'order.paid' | 'customer.segment.entered' | 'custom_event' | 'customer.loyalty.tier.upgraded' | 'customer.loyalty.tier.downgraded' | 'customer.loyalty.tier.prolonged' | 'customer.loyalty.tier.joined' | 'customer.loyalty.tier.left';
+export interface EarningRuleFixed {
+    type: 'FIXED';
+    points: number;
+}
+export declare type EarningRuleProportionalOrder = EarningRuleProportionalOrderAmount | EarningRuleProportionalOrderTotalAmount | EarningRuleProportionalOrderMetadata;
+export interface EarningRuleProportionalOrderAmount {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_AMOUNT';
+    order: {
+        amount: {
+            every: number;
+            points: number;
+        };
+    };
+}
+export interface EarningRuleProportionalOrderTotalAmount {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_TOTAL_AMOUNT';
+    order: {
+        total_amount: {
+            every: number;
+            points: number;
+        };
+    };
+}
+export interface EarningRuleProportionalOrderMetadata {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_METADATA';
+    order: {
+        metadata: {
+            every: number;
+            points: number;
+            property: string;
+        };
+    };
+}
+export declare type EarningRuleProportional = EarningRuleProportionalOrder | EarningRuleProportionalOrderItems | EarningRuleProportionalCustomerMetadata | EarningRuleProportionalCustomEvent;
+export declare type EarningRuleProportionalOrderItems = EarningRuleProportionalOrderItemsQuantity | EarningRuleProportionalOrderItemsAmount | EarningRuleProportionalOrderItemsSubtotalAmount;
+export interface EarningRuleProportionalOrderItemsQuantity {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_ITEMS_QUANTITY';
+    order_items: {
+        quantity: {
+            every: number;
+            points: number;
+            object: `products_collection` | `product` | `sku`;
+            id: string;
+        };
+    };
+}
+export interface EarningRuleProportionalOrderItemsAmount {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_ITEMS_AMOUNT';
+    order_items: {
+        amount: {
+            every: number;
+            points: number;
+            object: `products_collection` | `product` | `sku`;
+            id: string;
+        };
+    };
+}
+export interface EarningRuleProportionalOrderItemsSubtotalAmount {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_ITEMS_SUBTOTAL_AMOUNT';
+    order_items: {
+        subtotal_amount: {
+            every: number;
+            points: number;
+            object: `products_collection` | `product` | `sku`;
+            id: string;
+        };
+    };
+}
+export interface EarningRuleProportionalCustomerMetadata {
+    type: 'PROPORTIONAL';
+    calculation_type: 'CUSTOMER_METADATA';
+    customer: {
+        metadata: {
+            every: number;
+            points: number;
+            property: string;
+        };
+    };
+}
+export interface EarningRuleProportionalCustomEvent {
+    type: 'PROPORTIONAL';
+    calculation_type: 'CUSTOM_EVENT_METADATA';
+    custom_event: {
+        metadata: {
+            every: number;
+            points: number;
+            property: string;
+        };
+    };
+}
 export {};