@voucherify/sdk 3.0.0 → 3.0.1

package/dist/types/api/PublicationsApi.d.ts

@@ -0,0 +1,115 @@
+/**
+* Publications service.
+* @module api/PublicationsApi
+* @version 3.0.1
+*/
+export default class PublicationsApi {
+    /**
+    * Constructs a new PublicationsApi.
+    * @alias PublicationsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the createPublication operation.
+     * @callback createPublicationCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PublicationsCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Publication
+     * This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet.    🚧 Clearly define the source of the voucher  You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code.    🚧 Publish multiple vouchers  In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish.    📘 Auto-update campaign  In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign.
+     * @param {PublicationsCreateRequestBody} publicationsCreateRequestBody Specify the publication parameters.
+     * @param {{
+        joinOnce?: Boolean,
+     }} [opts] Optional parameters
+     * @param {createPublicationCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PublicationsCreateResponseBody}
+     * @returns {Promise<(PublicationsCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PublicationsCreateResponseBody` object or with `undefined`.
+     */
+    createPublication(publicationsCreateRequestBody: PublicationsCreateRequestBody, opts?: {
+        joinOnce?: boolean;
+    }, callback?: (error: Error | null, data?: PublicationsCreateResponseBody, response?: any) => any): Promise<(PublicationsCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the createPublication1 operation.
+     * @callback createPublication1Callback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PublicationsCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Create Publication with GET
+     * This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet.  ❗️ Limited access  Access to this endpoint is limited. This endpoint is designed for specific integrations and the API keys need to be configured to access this endpoint. Navigate to the **Dashboard** &rarr; **Project Settings** &rarr; **General** &rarr; **Integration Keys** to set up a pair of API keys and use them to send the request.    🚧 Clearly define the source of the voucher  You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code.    🚧 Publish multiple vouchers  This endpoint does not support the publishing of multiple vouchers from a single campaign. In case you want to publish multiple vouchers within a single publication, you need to use a [dedicated endpoint](/api-reference/publications/create-publication).    📘 Auto-update campaign  In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign.   # Example Request      ❗️ Required    Query param voucher OR campaign MUST be filled out. If you provide both, campaign param will be skipped.
+     * @param {Customer} customer Contains information about the customer to whom the publication was directed.
+     * @param {{
+        joinOnce?: Boolean,
+        voucher?: String,
+        campaign?: CreatePublicationCampaign,
+        sourceId?: String,
+        metadata?: Object.<String, Object>,
+     }} [opts] Optional parameters
+     * @param {createPublication1Callback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PublicationsCreateResponseBody}
+     * @returns {Promise<(PublicationsCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PublicationsCreateResponseBody` object or with `undefined`.
+     */
+    createPublication1(customer: Customer, opts?: {
+        joinOnce?: boolean;
+        voucher?: string;
+        campaign?: CreatePublicationCampaign;
+        sourceId?: string;
+        metadata?: any;
+    }, callback?: (error: Error | null, data?: PublicationsCreateResponseBody, response?: any) => any): Promise<(PublicationsCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listPublications operation.
+     * @callback listPublicationsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {PublicationsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Publications
+     * Retrieve a list of publications. To return a **particular** publication, you can use the source_id query parameter and provide the source_id of the publication you are looking for specifically. # Pagination  🚧 Important!  If you want to scroll through a huge set of records, it is recommended to use the [Exports API](/api-reference/exports/create-export). This API will return an error page_over_limit if you reach a page above 1000. # Filter Query The filters query parameter allows for joining multiple parameters with logical operators. The syntax looks as follows:  ## Examples
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListPublications, "prototype" | "constructFromObject">,
+        campaign?: String,
+        customer?: String,
+        voucher?: String,
+        result?: Exclude<keyof typeof ParameterResultListPublications, "prototype" | "constructFromObject">,
+        voucherType?: Exclude<keyof typeof ParameterVoucherTypeListPublications, "prototype" | "constructFromObject">,
+        isReferralCode?: Boolean,
+        filters?: ParameterFiltersListPublications,
+        sourceId?: String,
+     }} [opts] Optional parameters
+     * @param {listPublicationsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link PublicationsListResponseBody}
+     * @returns {Promise<(PublicationsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `PublicationsListResponseBody` object or with `undefined`.
+     */
+    listPublications(opts?: {
+        limit?: number;
+        page?: number;
+        order?: Exclude<keyof typeof ParameterOrderListPublications, "prototype" | "constructFromObject">;
+        campaign?: string;
+        customer?: string;
+        voucher?: string;
+        result?: Exclude<keyof typeof ParameterResultListPublications, "prototype" | "constructFromObject">;
+        voucherType?: Exclude<keyof typeof ParameterVoucherTypeListPublications, "prototype" | "constructFromObject">;
+        isReferralCode?: boolean;
+        filters?: ParameterFiltersListPublications;
+        sourceId?: string;
+    }, callback?: (error: Error | null, data?: PublicationsListResponseBody, response?: any) => any): Promise<(PublicationsListResponseBody | undefined)>;
+}
+import PublicationsCreateRequestBody from '../model/PublicationsCreateRequestBody';
+import PublicationsCreateResponseBody from '../model/PublicationsCreateResponseBody';
+import Customer from '../model/Customer';
+import CreatePublicationCampaign from '../model/CreatePublicationCampaign';
+import ParameterOrderListPublications from '../model/ParameterOrderListPublications';
+import ParameterResultListPublications from '../model/ParameterResultListPublications';
+import ParameterVoucherTypeListPublications from '../model/ParameterVoucherTypeListPublications';
+import ParameterFiltersListPublications from '../model/ParameterFiltersListPublications';
+import PublicationsListResponseBody from '../model/PublicationsListResponseBody';

package/dist/types/api/QualificationsApi.d.ts

@@ -0,0 +1,34 @@
+/**
+* Qualifications service.
+* @module api/QualificationsApi
+* @version 3.0.1
+*/
+export default class QualificationsApi {
+    /**
+    * Constructs a new QualificationsApi.
+    * @alias QualificationsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the checkEligibility operation.
+     * @callback checkEligibilityCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {QualificationsCheckEligibilityResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Check Eligibility
+     *   🚧 The Qualifications endpoint ignores the rules checking:    - Limit of total redeemed discount amount per campaign  - Limit of total redemptions count per campaign  - Redemptions per customer  - Redemptions per customer in a campaign  Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version  👍 Scenario Guide  Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging  The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables.
+     * @param {QualificationsCheckEligibilityRequestBody} qualificationsCheckEligibilityRequestBody Define order and customer context.
+     * @param {checkEligibilityCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link QualificationsCheckEligibilityResponseBody}
+     * @returns {Promise<(QualificationsCheckEligibilityResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `QualificationsCheckEligibilityResponseBody` object or with `undefined`.
+     */
+    checkEligibility(qualificationsCheckEligibilityRequestBody: QualificationsCheckEligibilityRequestBody, callback?: (error: Error | null, data?: QualificationsCheckEligibilityResponseBody, response?: any) => any): Promise<(QualificationsCheckEligibilityResponseBody | undefined)>;
+}
+import QualificationsCheckEligibilityRequestBody from '../model/QualificationsCheckEligibilityRequestBody';
+import QualificationsCheckEligibilityResponseBody from '../model/QualificationsCheckEligibilityResponseBody';

package/dist/types/api/RedemptionsApi.d.ts

@@ -0,0 +1,158 @@
+/**
+* Redemptions service.
+* @module api/RedemptionsApi
+* @version 3.0.1
+*/
+export default class RedemptionsApi {
+    /**
+    * Constructs a new RedemptionsApi.
+    * @alias RedemptionsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the getRedemption operation.
+     * @callback getRedemptionCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {RedemptionsGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Redemption
+     * Return a redemption or redemption rollback object. This object can either be a successfull or failed redemption or redemption rollback.
+     * @param {String} redemptionId ID of previously created redemption.
+     * @param {getRedemptionCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link RedemptionsGetResponseBody}
+     * @returns {Promise<(RedemptionsGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `RedemptionsGetResponseBody` object or with `undefined`.
+     */
+    getRedemption(redemptionId: string, callback?: (error: Error | null, data?: RedemptionsGetResponseBody, response?: any) => any): Promise<(RedemptionsGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the getVoucherRedemptions operation.
+     * @callback getVoucherRedemptionsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {VouchersRedemptionGetResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Get Voucher's Redemptions
+     * Retrieve the number of times a voucher was redeemed and each of the redemption details.
+     * @param {String} code A **code** that identifies the voucher.
+     * @param {getVoucherRedemptionsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link VouchersRedemptionGetResponseBody}
+     * @returns {Promise<(VouchersRedemptionGetResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `VouchersRedemptionGetResponseBody` object or with `undefined`.
+     */
+    getVoucherRedemptions(code: string, callback?: (error: Error | null, data?: VouchersRedemptionGetResponseBody, response?: any) => any): Promise<(VouchersRedemptionGetResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the listRedemptions operation.
+     * @callback listRedemptionsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {RedemptionsListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Redemptions
+     * Returns a list of redemptions previously created. The redemptions are returned in a sorted order, with the most recent redemptions appearing first. The response returns a list of redemptions of all vouchers.  # Filtering results The result can be narrowed according to specified (or default) filters, for example, you can sort redemptions by date: https://api.voucherify.io/v1/redemptions?limit 3&[created_at][before] 2017-09-08T13:52:18.227Z. A filter based on the object created_at field narrows down the results and lists redemptions done before or after a particular date time. You can use the following options: [created_at][after], [created_at][before]. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z. # Failed Redemptions A redemption may fail for various reasons. You can figure out an exact reason from the failure_code: - resource_not_found - voucher with given code does not exist - voucher_not_active - voucher is not active yet (before start date) - voucher_expired - voucher has already expired (after expiration date) - voucher_disabled -  voucher has been disabled (active: false) - quantity_exceeded - vouchers redemptions limit has been exceeded - gift_amount_exceeded - gift amount has been exceeded - customer_rules_violated - customer did not match the segment - order_rules_violated - order did not match validation rules - invalid_order - order was specified incorrectly - invalid_amount - order amount was specified incorrectly - missing_amount - order amount was not specified - missing_order_items - order items were not specified - missing_customer - customer was not specified
+     * @param {{
+        limit?: Number,
+        page?: Number,
+        result?: String,
+        campaign?: String,
+        customer?: String,
+        order?: Exclude<keyof typeof ParameterOrderListRedemptions, "prototype" | "constructFromObject">,
+        createdAt?: ParameterCreatedBeforeAfter,
+        filters?: ParameterFiltersListRedemptions,
+     }} [opts] Optional parameters
+     * @param {listRedemptionsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link RedemptionsListResponseBody}
+     * @returns {Promise<(RedemptionsListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `RedemptionsListResponseBody` object or with `undefined`.
+     */
+    listRedemptions(opts?: {
+        limit?: number;
+        page?: number;
+        result?: string;
+        campaign?: string;
+        customer?: string;
+        order?: Exclude<keyof typeof ParameterOrderListRedemptions, "prototype" | "constructFromObject">;
+        createdAt?: ParameterCreatedBeforeAfter;
+        filters?: ParameterFiltersListRedemptions;
+    }, callback?: (error: Error | null, data?: RedemptionsListResponseBody, response?: any) => any): Promise<(RedemptionsListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the redeemStackedDiscounts operation.
+     * @callback redeemStackedDiscountsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {RedemptionsRedeemResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Redeem Stackable Discounts
+     * # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts:   API keys with a Merchant role cant use this endpoint.  📘 Rollbacks  You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions).      📘 Also available on client-side  This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more.  - Use X-Client-Application-Id as the application ID header.  - Use X-Client-Token as the appliction secret key header.  - Use client-side base URL.  - Use an origin header for your custom domain.
+     * @param {RedemptionsRedeemRequestBody} redemptionsRedeemRequestBody
+     * @param {redeemStackedDiscountsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link RedemptionsRedeemResponseBody}
+     * @returns {Promise<(RedemptionsRedeemResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `RedemptionsRedeemResponseBody` object or with `undefined`.
+     */
+    redeemStackedDiscounts(redemptionsRedeemRequestBody: RedemptionsRedeemRequestBody, callback?: (error: Error | null, data?: RedemptionsRedeemResponseBody, response?: any) => any): Promise<(RedemptionsRedeemResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the rollbackRedemption operation.
+     * @callback rollbackRedemptionCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {RedemptionsRollbackCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Rollback Redemption
+     * Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions)  🚧  You can roll back a redemption up to 3 months back.   # Effect  The operation  - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and  - gives 1 redemption back to the pool (decreases redeemed_quantity by 1).  # Returned funds  In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption.
+     * @param {String} redemptionId The original redemption ID to be rolled back (undone).
+     * @param {RedemptionsRollbackCreateRequestBody} redemptionsRollbackCreateRequestBody Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body.
+     * @param {{
+        reason?: String,
+        trackingId?: String,
+     }} [opts] Optional parameters
+     * @param {rollbackRedemptionCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link RedemptionsRollbackCreateResponseBody}
+     * @returns {Promise<(RedemptionsRollbackCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `RedemptionsRollbackCreateResponseBody` object or with `undefined`.
+     */
+    rollbackRedemption(redemptionId: string, redemptionsRollbackCreateRequestBody: RedemptionsRollbackCreateRequestBody, opts?: {
+        reason?: string;
+        trackingId?: string;
+    }, callback?: (error: Error | null, data?: RedemptionsRollbackCreateResponseBody, response?: any) => any): Promise<(RedemptionsRollbackCreateResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the rollbackStackedRedemptions operation.
+     * @callback rollbackStackedRedemptionsCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {RedemptionsRollbacksCreateResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Rollback Stackable Redemptions
+     * Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧   You can roll back a redemption up to 3 months back.
+     * @param {String} parentRedemptionId Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm.
+     * @param {RedemptionsRollbacksCreateRequestBody} redemptionsRollbacksCreateRequestBody Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body.
+     * @param {{
+        reason?: String,
+        trackingId?: String,
+     }} [opts] Optional parameters
+     * @param {rollbackStackedRedemptionsCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link RedemptionsRollbacksCreateResponseBody}
+     * @returns {Promise<(RedemptionsRollbacksCreateResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `RedemptionsRollbacksCreateResponseBody` object or with `undefined`.
+     */
+    rollbackStackedRedemptions(parentRedemptionId: string, redemptionsRollbacksCreateRequestBody: RedemptionsRollbacksCreateRequestBody, opts?: {
+        reason?: string;
+        trackingId?: string;
+    }, callback?: (error: Error | null, data?: RedemptionsRollbacksCreateResponseBody, response?: any) => any): Promise<(RedemptionsRollbacksCreateResponseBody | undefined)>;
+}
+import RedemptionsGetResponseBody from '../model/RedemptionsGetResponseBody';
+import VouchersRedemptionGetResponseBody from '../model/VouchersRedemptionGetResponseBody';
+import ParameterOrderListRedemptions from '../model/ParameterOrderListRedemptions';
+import ParameterCreatedBeforeAfter from '../model/ParameterCreatedBeforeAfter';
+import ParameterFiltersListRedemptions from '../model/ParameterFiltersListRedemptions';
+import RedemptionsListResponseBody from '../model/RedemptionsListResponseBody';
+import RedemptionsRedeemRequestBody from '../model/RedemptionsRedeemRequestBody';
+import RedemptionsRedeemResponseBody from '../model/RedemptionsRedeemResponseBody';
+import RedemptionsRollbackCreateRequestBody from '../model/RedemptionsRollbackCreateRequestBody';
+import RedemptionsRollbackCreateResponseBody from '../model/RedemptionsRollbackCreateResponseBody';
+import RedemptionsRollbacksCreateRequestBody from '../model/RedemptionsRollbacksCreateRequestBody';
+import RedemptionsRollbacksCreateResponseBody from '../model/RedemptionsRollbacksCreateResponseBody';

package/dist/types/api/ReferralsApi.d.ts

@@ -0,0 +1,144 @@
+/**
+* Referrals service.
+* @module api/ReferralsApi
+* @version 3.0.1
+*/
+export default class ReferralsApi {
+    /**
+    * Constructs a new ReferralsApi.
+    * @alias ReferralsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the referralsAddHolders operation.
+     * @callback referralsAddHoldersCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ReferralsMembersHoldersCreateInBulkResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Add Referral Code Holders
+     * Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  👍 To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint.  📘 Alternative endpoint This endpoint is an alternative to the [Add Referral Code Holders endpoint](/api-reference/referrals/add-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+     * @param {String} memberId Unique referral code or its identifier.
+     * @param {ReferralsMembersHoldersCreateInBulkRequestBody} referralsMembersHoldersCreateInBulkRequestBody Specify the customer data to be upserted as redeemable holders.
+     * @param {referralsAddHoldersCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ReferralsMembersHoldersCreateInBulkResponseBody}
+     * @returns {Promise<(ReferralsMembersHoldersCreateInBulkResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ReferralsMembersHoldersCreateInBulkResponseBody` object or with `undefined`.
+     */
+    referralsAddHolders(memberId: string, referralsMembersHoldersCreateInBulkRequestBody: ReferralsMembersHoldersCreateInBulkRequestBody, callback?: (error: Error | null, data?: ReferralsMembersHoldersCreateInBulkResponseBody, response?: any) => any): Promise<(ReferralsMembersHoldersCreateInBulkResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the referralsAddHolders1 operation.
+     * @callback referralsAddHolders1Callback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ReferralsMembersHoldersCreateInBulkResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Add Referral Code Holders with Campaign ID
+     * Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  👍 To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint.
+     * @param {String} campaignId Unique identifier of a referral program campaign.
+     * @param {String} memberId Unique referral code or its identifier.
+     * @param {ReferralsMembersHoldersCreateInBulkRequestBody} referralsMembersHoldersCreateInBulkRequestBody Specify the customer data to be upserted as redeemable holders.
+     * @param {referralsAddHolders1Callback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ReferralsMembersHoldersCreateInBulkResponseBody}
+     * @returns {Promise<(ReferralsMembersHoldersCreateInBulkResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ReferralsMembersHoldersCreateInBulkResponseBody` object or with `undefined`.
+     */
+    referralsAddHolders1(campaignId: string, memberId: string, referralsMembersHoldersCreateInBulkRequestBody: ReferralsMembersHoldersCreateInBulkRequestBody, callback?: (error: Error | null, data?: ReferralsMembersHoldersCreateInBulkResponseBody, response?: any) => any): Promise<(ReferralsMembersHoldersCreateInBulkResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the referralsCodeHolders operation.
+     * @callback referralsCodeHoldersCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ReferralsMembersHoldersListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Referral Code Holders with campaign ID
+     * Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)
+     * @param {String} campaignId Unique identifier of a referral program campaign.
+     * @param {String} memberId Unique referral code or its identifier.
+     * @param {{
+        limit?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListRedeemables, "prototype" | "constructFromObject">,
+        startingAfterId?: String,
+        filters?: ParameterFiltersListReferralsRedeemableHolders,
+     }} [opts] Optional parameters
+     * @param {referralsCodeHoldersCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ReferralsMembersHoldersListResponseBody}
+     * @returns {Promise<(ReferralsMembersHoldersListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ReferralsMembersHoldersListResponseBody` object or with `undefined`.
+     */
+    referralsCodeHolders(campaignId: string, memberId: string, opts?: {
+        limit?: number;
+        order?: Exclude<keyof typeof ParameterOrderListRedeemables, "prototype" | "constructFromObject">;
+        startingAfterId?: string;
+        filters?: ParameterFiltersListReferralsRedeemableHolders;
+    }, callback?: (error: Error | null, data?: ReferralsMembersHoldersListResponseBody, response?: any) => any): Promise<(ReferralsMembersHoldersListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the referralsCodeHolders1 operation.
+     * @callback referralsCodeHolders1Callback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param {ReferralsMembersHoldersListResponseBody} [data] The data returned by the service call.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * List Referral Code Holders
+     * Retrieves the holders of the referral code from a referral campaign. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)  📘 Alternative endpoint This endpoint is an alternative to the [List Member Holders endpoint](/api-reference/referrals/list-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+     * @param {String} memberId Unique referral code or its identifier.
+     * @param {{
+        limit?: Number,
+        order?: Exclude<keyof typeof ParameterOrderListRedeemables, "prototype" | "constructFromObject">,
+        startingAfterId?: String,
+        filters?: ParameterFiltersListReferralsRedeemableHolders,
+     }} [opts] Optional parameters
+     * @param {referralsCodeHolders1Callback} [callback] The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link ReferralsMembersHoldersListResponseBody}
+     * @returns {Promise<(ReferralsMembersHoldersListResponseBody | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `ReferralsMembersHoldersListResponseBody` object or with `undefined`.
+     */
+    referralsCodeHolders1(memberId: string, opts?: {
+        limit?: number;
+        order?: Exclude<keyof typeof ParameterOrderListRedeemables, "prototype" | "constructFromObject">;
+        startingAfterId?: string;
+        filters?: ParameterFiltersListReferralsRedeemableHolders;
+    }, callback?: (error: Error | null, data?: ReferralsMembersHoldersListResponseBody, response?: any) => any): Promise<(ReferralsMembersHoldersListResponseBody | undefined)>;
+    /**
+     * Callback function to receive the result of the referralsRemoveHolder operation.
+     * @callback referralsRemoveHolderCallback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param data This operation does not return a value.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Remove Referral Card Holder
+     * Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  📘 Alternative endpoint This endpoint is an alternative to the [Remove Referral Card Holder endpoint](/api-reference/referrals/remove-referral-card-holder-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+     * @param {String} memberId Unique referral code or its identifier.
+     * @param {String} holderId Unique identifier of a redeemable holder.
+     * @param {referralsRemoveHolderCallback} [callback] The callback function, accepting three arguments: error, data, response
+     * @returns {Promise<( | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `` object or with `undefined`.
+     */
+    referralsRemoveHolder(memberId: string, holderId: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+    /**
+     * Callback function to receive the result of the referralsRemoveHolder1 operation.
+     * @callback referralsRemoveHolder1Callback
+     * @param {Error|null} error Error object if failed, null otherwise.
+     * @param data This operation does not return a value.
+     * @param {Object} [response] Full response object if successful.
+     */
+    /**
+     * Remove Referral Card Holder with campaign ID
+     * Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)
+     * @param {String} campaignId Unique identifier of a referral program campaign.
+     * @param {String} memberId Unique referral code or its identifier.
+     * @param {String} holderId Unique identifier of a redeemable holder.
+     * @param {referralsRemoveHolder1Callback} [callback] The callback function, accepting three arguments: error, data, response
+     * @returns {Promise<( | undefined)>} Depending on whether the `callback` parameter is provided, the promise will resolve with a `` object or with `undefined`.
+     */
+    referralsRemoveHolder1(campaignId: string, memberId: string, holderId: string, callback?: (error: Error | null, data: any, response?: any) => any): Promise<(undefined)>;
+}
+import ReferralsMembersHoldersCreateInBulkRequestBody from '../model/ReferralsMembersHoldersCreateInBulkRequestBody';
+import ReferralsMembersHoldersCreateInBulkResponseBody from '../model/ReferralsMembersHoldersCreateInBulkResponseBody';
+import ParameterOrderListRedeemables from '../model/ParameterOrderListRedeemables';
+import ParameterFiltersListReferralsRedeemableHolders from '../model/ParameterFiltersListReferralsRedeemableHolders';
+import ReferralsMembersHoldersListResponseBody from '../model/ReferralsMembersHoldersListResponseBody';