@emilgroup/discount-sdk 1.5.1 → 1.7.0

package/dist/models/charge-policy-voucher-response-class.d.ts

@@ -0,0 +1,96 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ChargePolicyVoucherResponseClass
+ */
+export interface ChargePolicyVoucherResponseClass {
+    /**
+     * Unique identifier of the transaction that this object belongs to.
+     * @type {string}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'transactionCode': string;
+    /**
+     * Transaction date
+     * @type {string}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'transactionDate': string;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'code': string;
+    /**
+     * Voucher status
+     * @type {string}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'status': ChargePolicyVoucherResponseClassStatusEnum;
+    /**
+     * Customer-defined voucher code
+     * @type {string}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'voucherCode': string;
+    /**
+     * Slug of the product the voucher is redeemed for
+     * @type {string}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'productSlug': string;
+    /**
+     * Number of the partner the voucher is used by
+     * @type {string}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'partnerNumber': string;
+    /**
+     * The remaining number of months left in the voucher to use
+     * @type {number}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'remainingMonths': number;
+    /**
+     * The amount (in cents!) of remaining voucher credits
+     * @type {number}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'remainingCredits': number;
+    /**
+     * The yearly premium of the policy
+     * @type {number}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'yearlyPremium': number;
+    /**
+     * The amount charged for the voucher (monthly policy voucher discount)
+     * @type {number}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'chargedAmount': number;
+    /**
+     * The end date of the voucher discount. Calculated based on the policy start date and the voucher duration.
+     * @type {string}
+     * @memberof ChargePolicyVoucherResponseClass
+     */
+    'discountEndDate': string;
+}
+export declare const ChargePolicyVoucherResponseClassStatusEnum: {
+    readonly Redeemable: "REDEEMABLE";
+    readonly Active: "ACTIVE";
+    readonly Used: "USED";
+};
+export type ChargePolicyVoucherResponseClassStatusEnum = typeof ChargePolicyVoucherResponseClassStatusEnum[keyof typeof ChargePolicyVoucherResponseClassStatusEnum];

package/dist/models/charge-policy-voucher-response-class.js

@@ -0,0 +1,21 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChargePolicyVoucherResponseClassStatusEnum = void 0;
+exports.ChargePolicyVoucherResponseClassStatusEnum = {
+    Redeemable: 'REDEEMABLE',
+    Active: 'ACTIVE',
+    Used: 'USED'
+};

package/dist/models/check-account-eligibility-request-dto.d.ts

@@ -0,0 +1,48 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CheckAccountEligibilityRequestDto
+ */
+export interface CheckAccountEligibilityRequestDto {
+    /**
+     * The voucher code to check eligibility for
+     * @type {string}
+     * @memberof CheckAccountEligibilityRequestDto
+     */
+    'voucherCode': string;
+    /**
+     * The partner number to check eligibility for
+     * @type {string}
+     * @memberof CheckAccountEligibilityRequestDto
+     */
+    'partnerNumber': string;
+    /**
+     * The product slug to check eligibility for
+     * @type {string}
+     * @memberof CheckAccountEligibilityRequestDto
+     */
+    'productSlug': string;
+    /**
+     * The campaign slug to check eligibility for
+     * @type {string}
+     * @memberof CheckAccountEligibilityRequestDto
+     */
+    'campaignSlug': string;
+    /**
+     * The original yearly amount before applying any discount (in cents)
+     * @type {number}
+     * @memberof CheckAccountEligibilityRequestDto
+     */
+    'yearlyAmount'?: number;
+}

package/dist/models/check-account-eligibility-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/check-account-eligibility-response-class.d.ts

@@ -0,0 +1,57 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CheckAccountEligibilityResponseClass
+ */
+export interface CheckAccountEligibilityResponseClass {
+    /**
+     * The eligibility status of the account
+     * @type {boolean}
+     * @memberof CheckAccountEligibilityResponseClass
+     */
+    'eligible': boolean;
+    /**
+     * The error code if the account is not eligible
+     * @type {string}
+     * @memberof CheckAccountEligibilityResponseClass
+     */
+    'errorCode': CheckAccountEligibilityResponseClassErrorCodeEnum;
+    /**
+     * The total discount amount applied to the original price (in cents)
+     * @type {number}
+     * @memberof CheckAccountEligibilityResponseClass
+     */
+    'totalDiscount': number;
+    /**
+     * The monthly discount amount applied to the original price (in cents)
+     * @type {number}
+     * @memberof CheckAccountEligibilityResponseClass
+     */
+    'monthlyDiscount': number;
+    /**
+     * The number of months the discount is applied
+     * @type {number}
+     * @memberof CheckAccountEligibilityResponseClass
+     */
+    'discountMonths': number;
+}
+export declare const CheckAccountEligibilityResponseClassErrorCodeEnum: {
+    readonly NA: "n/A";
+    readonly ErrorCampaignOver: "error_campaign_over";
+    readonly ErrorVoucherAlreadyRedeemed: "error_voucher_already_redeemed";
+    readonly ErrorCustomerHasNoVoucher: "error_customer_has_no_voucher";
+    readonly ErrorVoucherIsExclusive: "error_voucher_is_exclusive";
+    readonly ErrorProductNotAllowed: "error_product_not_allowed";
+};
+export type CheckAccountEligibilityResponseClassErrorCodeEnum = typeof CheckAccountEligibilityResponseClassErrorCodeEnum[keyof typeof CheckAccountEligibilityResponseClassErrorCodeEnum];

package/dist/models/check-account-eligibility-response-class.js

@@ -0,0 +1,24 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckAccountEligibilityResponseClassErrorCodeEnum = void 0;
+exports.CheckAccountEligibilityResponseClassErrorCodeEnum = {
+    NA: 'n/A',
+    ErrorCampaignOver: 'error_campaign_over',
+    ErrorVoucherAlreadyRedeemed: 'error_voucher_already_redeemed',
+    ErrorCustomerHasNoVoucher: 'error_customer_has_no_voucher',
+    ErrorVoucherIsExclusive: 'error_voucher_is_exclusive',
+    ErrorProductNotAllowed: 'error_product_not_allowed'
+};

package/dist/models/create-campaign-request-dto.d.ts

@@ -0,0 +1,42 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateCampaignRequestDto
+ */
+export interface CreateCampaignRequestDto {
+    /**
+     * The name of the campaign.
+     * @type {string}
+     * @memberof CreateCampaignRequestDto
+     */
+    'name': string;
+    /**
+     * A unique identifier for the campaign.
+     * @type {string}
+     * @memberof CreateCampaignRequestDto
+     */
+    'slug': string;
+    /**
+     * The date when the campaign becomes active. Must be today or a future date, and must be before the end date.
+     * @type {string}
+     * @memberof CreateCampaignRequestDto
+     */
+    'startDate': string;
+    /**
+     * The date when the campaign expires. Must be after the start date.
+     * @type {string}
+     * @memberof CreateCampaignRequestDto
+     */
+    'endDate': string;
+}

package/dist/models/create-campaign-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-campaign-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CampaignClass } from './campaign-class';
+/**
+ *
+ * @export
+ * @interface CreateCampaignResponseClass
+ */
+export interface CreateCampaignResponseClass {
+    /**
+     * The created campaign.
+     * @type {CampaignClass}
+     * @memberof CreateCampaignResponseClass
+     */
+    'campaign': CampaignClass;
+}

package/dist/models/create-campaign-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-eligible-account-request-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateEligibleAccountRequestDto
+ */
+export interface CreateEligibleAccountRequestDto {
+    /**
+     * The unique code of the voucher that will be assigned to this account.       This code will be used for redemption.
+     * @type {string}
+     * @memberof CreateEligibleAccountRequestDto
+     */
+    'voucherCode': string;
+    /**
+     * The unique identifier of the partner account        that will be eligible to redeem the voucher.
+     * @type {string}
+     * @memberof CreateEligibleAccountRequestDto
+     */
+    'partnerNumber': string;
+}

package/dist/models/create-eligible-account-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-eligible-account-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EligibleAccountClass } from './eligible-account-class';
+/**
+ *
+ * @export
+ * @interface CreateEligibleAccountResponseClass
+ */
+export interface CreateEligibleAccountResponseClass {
+    /**
+     * The account that has been marked as eligible to redeem a voucher from a specific campaign.
+     * @type {EligibleAccountClass}
+     * @memberof CreateEligibleAccountResponseClass
+     */
+    'eligibleAccount': EligibleAccountClass;
+}

package/dist/models/create-eligible-account-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-policy-voucher-request-dto.d.ts

@@ -0,0 +1,48 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreatePolicyVoucherRequestDto
+ */
+export interface CreatePolicyVoucherRequestDto {
+    /**
+     * Customer-defined voucher code
+     * @type {string}
+     * @memberof CreatePolicyVoucherRequestDto
+     */
+    'voucherCode': string;
+    /**
+     * Slug of the campaign the voucher is used for
+     * @type {string}
+     * @memberof CreatePolicyVoucherRequestDto
+     */
+    'campaignSlug': string;
+    /**
+     * Number of the partner the voucher is used by
+     * @type {string}
+     * @memberof CreatePolicyVoucherRequestDto
+     */
+    'partnerNumber': string;
+    /**
+     * Slug of the product the voucher is redeemed for
+     * @type {string}
+     * @memberof CreatePolicyVoucherRequestDto
+     */
+    'productSlug'?: string;
+    /**
+     * The yearly premium of the policy (in cents).        This value is required to ensure accurate discount calculations,        especially in edge cases where the total premium is less than the discount.        It helps prevent situations where the discount would exceed the actual premium amount.
+     * @type {number}
+     * @memberof CreatePolicyVoucherRequestDto
+     */
+    'yearlyPremium'?: number;
+}

package/dist/models/create-policy-voucher-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-policy-voucher-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PolicyVoucherClass } from './policy-voucher-class';
+/**
+ *
+ * @export
+ * @interface CreatePolicyVoucherResponseClass
+ */
+export interface CreatePolicyVoucherResponseClass {
+    /**
+     * policy voucher
+     * @type {PolicyVoucherClass}
+     * @memberof CreatePolicyVoucherResponseClass
+     */
+    'policyVoucher': PolicyVoucherClass;
+}

package/dist/models/create-policy-voucher-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-product-discount-dto.d.ts

@@ -0,0 +1,48 @@
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateProductDiscountDto
+ */
+export interface CreateProductDiscountDto {
+    /**
+     * The slug of the product this discount applies to.
+     * @type {string}
+     * @memberof CreateProductDiscountDto
+     */
+    'productSlug': string;
+    /**
+     * The number of months this discount will be applied.
+     * @type {number}
+     * @memberof CreateProductDiscountDto
+     */
+    'discountMonths'?: number;
+    /**
+     * The monthly price of the product (in cents).
+     * @type {number}
+     * @memberof CreateProductDiscountDto
+     */
+    'monthlyPrice'?: number;
+    /**
+     * The total discount amount for the product.       For absolute discounts: fixed amount in cents (integer).       For relative discounts: percentage with max 2 decimals (1-100).
+     * @type {number}
+     * @memberof CreateProductDiscountDto
+     */
+    'totalDiscount'?: number;
+    /**
+     * The monthly discount applied to the product.       For absolute discounts: fixed amount in cents (integer).       For relative discounts: percentage with max 2 decimals (1-100).
+     * @type {number}
+     * @memberof CreateProductDiscountDto
+     */
+    'monthlyDiscountApplied'?: number;
+}

package/dist/models/create-product-discount-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DiscountService
+ * The EMIL DiscountService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });