@voucherify/sdk 1.2.0 → 2.0.1

package/dist/VoucherifyClientSide.d.ts

@@ -14,7 +14,7 @@ export interface VoucherifyClientSideOptions {
      */
     apiUrl?: string;
     /**
-     * [Log-in](http://app.voucherify.io/?utm_source=github&utm_medium=sdk&utm_campaign=acq#/login) to Voucherify web interface and obtain your `Client-side Keys` from [Configuration](https://app.voucherify.io/?utm_source=github&utm_medium=sdk&utm_campaign=acq#/app/configuration):
+     * [Log-in](https://app.voucherify.io/#/login) to Voucherify web interface and obtain your `Client-side Keys` from [Configuration](https://app.voucherify.io/#/app/core/projects/current/general):
      *
      * ```javascript
      * const client = VoucherifyClientSide({
@@ -25,7 +25,7 @@ export interface VoucherifyClientSideOptions {
      */
     clientApplicationId: string;
     /**
-     * [Log-in](http://app.voucherify.io/?utm_source=github&utm_medium=sdk&utm_campaign=acq#/login) to Voucherify web interface and obtain your `Client-side Keys` from [Configuration](https://app.voucherify.io/?utm_source=github&utm_medium=sdk&utm_campaign=acq#/app/configuration):
+     * [Log-in](https://app.voucherify.io/#/login) to Voucherify web interface and obtain your `Client-side Keys` from [Configuration](https://app.voucherify.io/#/app/core/projects/current/general):
      *
      * ```javascript
      * const client = VoucherifyClientSide({

package/dist/VoucherifyServerSide.d.ts

@@ -28,7 +28,7 @@ export interface VoucherifyServerSideOptions {
      */
     apiUrl?: string;
     /**
-     * [Log-in](http://app.voucherify.io/?utm_source=github&utm_medium=sdk&utm_campaign=acq#/login) to Voucherify web interface and obtain your `Application Keys` from [Configuration](https://app.voucherify.io/?utm_source=github&utm_medium=sdk&utm_campaign=acq#/app/configuration):
+     * [Log-in](https://app.voucherify.io/#/login) to Voucherify web interface and obtain your `Application Keys` from [Configuration](https://app.voucherify.io/#/app/core/projects/current/general):
      *
      * ```javascript
      * const voucherify = VoucherifyServerSide({
@@ -39,7 +39,7 @@ export interface VoucherifyServerSideOptions {
      */
     applicationId: string;
     /**
-     * [Log-in](http://app.voucherify.io/?utm_source=github&utm_medium=sdk&utm_campaign=acq#/login) to Voucherify web interface and obtain your `Application Keys` from [Configuration](https://app.voucherify.io/?utm_source=github&utm_medium=sdk&utm_campaign=acq#/app/configuration):
+     * [Log-in](https://app.voucherify.io/#/login) to Voucherify web interface and obtain your `Application Keys` from [Configuration](https://app.voucherify.io/#/app/core/projects/current/general):
      *
      * ```javascript
      * const voucherify = VoucherifyServerSide({
@@ -50,7 +50,7 @@ export interface VoucherifyServerSideOptions {
      */
     secretKey: string;
     /**
-     * Optionally, you can add `apiVersion` to the client options if you want to use a [specific API version](http://docs.voucherify.io/docs/api-version-upgrades?utm_source=github&utm_medium=sdk&utm_campaign=acq).
+     * Optionally, you can add `apiVersion` to the client options if you want to use a [specific API version](https://docs.voucherify.io/docs/api-version-upgrades).
      *
      * ```javascript
      * const voucherify = VoucherifyServerSide({

package/dist/Vouchers.d.ts

@@ -7,7 +7,8 @@ declare class VouchersQualification {
     /**
      * The method can be used for sending a request to display all vouchers qualified to the given customer and context (e.g., order, loyalty reward). A checking logic won't run among coupons from bulk unique codes campaigns. For campaigns with multiple unique codes, you should run a dedicated function for searching for qualified campaigns.
      * As a sample use case, you can imagine a requirement of displaying below cart the coupons eligible to a customer. The customer can take and apply the proposed voucher.
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#push-qualification-request
+     *
+     * @see https://docs.voucherify.io/reference/push-qualification-request
      */
     examine(body: T.VouchersQualificationExamineBody, params?: T.VouchersQualificationExamineParams): Promise<T.VouchersQualificationExamineResponse>;
 }
@@ -17,47 +18,47 @@ export declare class Vouchers {
     qualifications: VouchersQualification;
     constructor(client: RequestController, balance: Balance);
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-voucher
+     * @see https://docs.voucherify.io/reference/create-voucher
      */
     create(voucher: T.VouchersCreate): Promise<Pick<T.VouchersResponse, "object" | "type" | "discount" | "gift" | "category" | "additional_info" | "start_date" | "expiration_date" | "metadata" | "id" | "code" | "campaign" | "loyalty_card" | "validity_timeframe" | "validity_day_of_week" | "publish" | "redemption" | "active" | "assets" | "is_referral_code" | "referrer_id" | "holder_id" | "updated_at">>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#vouchers-get
+     * @see https://docs.voucherify.io/reference/vouchers-get
      */
     get(code: string): Promise<T.VouchersResponse>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#update-voucher
+     * @see https://docs.voucherify.io/reference/update-voucher
      */
     update(voucher: T.VouchersUpdate): Promise<T.VouchersResponse>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#delete-voucher
+     * @see https://docs.voucherify.io/reference/delete-voucher
      */
     delete(code: string, params?: T.VouchersDeleteParams): Promise<unknown>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#list-vouchers
+     * @see https://docs.voucherify.io/reference/list-vouchers
      */
     list(params?: T.VouchersListParams): Promise<T.VouchersListResponse>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#enable-voucher
+     * @see https://docs.voucherify.io/reference/enable-voucher
      */
     enable(code: string): Promise<T.VouchersResponse>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#disable-voucher
+     * @see https://docs.voucherify.io/reference/disable-voucher
      */
     disable(code: string): Promise<T.VouchersResponse>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#import-vouchers-1
+     * @see https://docs.voucherify.io/reference/import-vouchers-1
      */
-    import(vouchers: T.VouchersImport[]): Promise<unknown>;
+    import(vouchers: T.VouchersImport[]): Promise<T.VouchersImportResponse>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#update-vouchers-metadata-in-bulk
+     * @see https://docs.voucherify.io/reference/aaupdate-vouchers-metadata-in-bulk
      */
     bulkUpdateMetadata(params: T.VouchersBulkUpdateMetadata): Promise<T.VouchersBulkUpdateMetadataResponse>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#update-vouchers-in-bulk
+     * @see https://docs.voucherify.io/reference/aa-update-vouchers-in-bulk
      */
     bulkUpdate(vouchers: T.VouchersBulkUpdate): Promise<T.VouchersBulkUpdateResponse>;
     /**
-     * @see https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#release-validation-session
+     * @see https://docs.voucherify.io/reference/release-validation-session
      */
     releaseValidationSession(code: string, sessionKey: string): Promise<unknown>;
 }

package/dist/helpers.d.ts

@@ -8,7 +8,6 @@ export declare function isFunction(value: any): value is Function;
 export declare function exists<T extends any>(value: T): value is NonNullable<T>;
 export declare function environment(): string;
 export declare function assert(condition: any, message?: string): asserts condition;
-export declare function toQueryParams(obj: Record<string, unknown>): Record<string, string>;
 /**
  * Return an object containing all properties of `obj` excluding the ones in `keys` array
  * e.g:

package/dist/types/Campaigns.d.ts

@@ -111,6 +111,9 @@ export interface CampaignsListResponse {
     data_ref: 'campaigns';
     campaigns: CampaignResponse[];
 }
+export declare type CampaignsVouchersImportResponse = {
+    async_action_id: string;
+};
 export declare type CampaignsCreateCampaignResponse = CampaignResponse;
 export declare type CampaignsUpdateCampaignResponse = CampaignResponse;
 export declare type CampaignsGetCampaignResponse = CampaignResponse;

package/dist/types/Products.d.ts

@@ -34,18 +34,17 @@ export declare type ProductsUpdate = {
     metadata?: Record<string, any>;
 };
 export declare type ProductsUpdateResponse = ProductsCreateResponse;
-export interface ProductsBulkMetadataUpdate {
+export interface ProductsBulkUpdateMetadata {
     source_ids: string[];
     metadata: Record<string, any>;
 }
 export declare type ProductsBulkUpdate = ProductsCreate[];
-interface BulkUpdateResponse {
-    source_id?: string;
-    found: boolean;
-    updated: boolean;
-}
-export declare type ProductsBulkUpdateResponse = BulkUpdateResponse[];
-export declare type ProductsBulkMetadataUpdateResponse = BulkUpdateResponse[];
+export declare type ProductsBulkUpdateResponse = {
+    async_action_id: string;
+};
+export declare type ProductsBulkUpdateMetadataResponse = {
+    async_action_id: string;
+};
 export interface ProductsDeleteParams {
     force?: boolean;
 }
@@ -94,4 +93,3 @@ export interface ProductsListSkus {
     total: number;
     skus: ProductsGetSkuResponse[];
 }
-export {};

package/dist/types/Vouchers.d.ts

@@ -206,22 +206,19 @@ export interface VouchersImport {
 }
 export interface VouchersBulkUpdateObject {
     code: string;
-    metadata?: Record<string, any>;
+    metadata: Record<string, any>;
 }
 export declare type VouchersBulkUpdate = VouchersBulkUpdateObject[];
 export interface VouchersBulkUpdateMetadata {
     codes: string[];
-    metadata?: Record<string, any>;
-}
-export interface VouchersBulkUpdateMetadataObjectResponse {
-    code: string;
-    found: boolean;
-    updated: boolean;
-}
-export declare type VouchersBulkUpdateMetadataResponse = VouchersBulkUpdateMetadataObjectResponse[];
-export interface VouchersBulkUpdateObjectResponse {
-    code: string;
-    found: boolean;
-    updated: boolean;
-}
-export declare type VouchersBulkUpdateResponse = VouchersBulkUpdateObjectResponse[];
+    metadata: Record<string, any>;
+}
+export declare type VouchersImportResponse = {
+    async_action_id: string;
+};
+export declare type VouchersBulkUpdateMetadataResponse = {
+    async_action_id: string;
+};
+export declare type VouchersBulkUpdateResponse = {
+    async_action_id: string;
+};