@emilgroup/commission-sdk 1.0.0-beta.1

package/dist/models/commission-class.d.ts

@@ -0,0 +1,103 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CommissionItemClass } from './commission-item-class';
+/**
+ *
+ * @export
+ * @interface CommissionClass
+ */
+export interface CommissionClass {
+    /**
+     * The unique database identifier of the commission
+     * @type {number}
+     * @memberof CommissionClass
+     */
+    'id': number;
+    /**
+     * The unique code or identifier of the commission agreement this commission is based on
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionAgreementCode': string;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'code': string;
+    /**
+     * A detailed description explaining what this commission represents and its purpose
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'description': string;
+    /**
+     * The version identifier of the commission agreement being used for this commission
+     * @type {number}
+     * @memberof CommissionClass
+     */
+    'commissionAgreementVersionId': number;
+    /**
+     * The unique code or identifier of the partner associated with this commission
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'partnerCode': string;
+    /**
+     * The updated policy code or identifier of the policy associated with this commission
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'policyCode': string;
+    /**
+     * The total monetary amount of the commission in the smallest currency unit (e.g., cents). This is the sum of all commission items
+     * @type {number}
+     * @memberof CommissionClass
+     */
+    'amount': number;
+    /**
+     * The status of the commission. Valid values: pending, settled
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'status': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'updatedBy': string;
+    /**
+     * An array of commission items that make up this commission. Each item represents a specific commission component with its own amount, type
+     * @type {Array<CommissionItemClass>}
+     * @memberof CommissionClass
+     */
+    'items': Array<CommissionItemClass>;
+}

package/dist/models/commission-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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/commission-item-class.d.ts

@@ -0,0 +1,84 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 CommissionItemClass
+ */
+export interface CommissionItemClass {
+    /**
+     * The unique database identifier of the commission item
+     * @type {number}
+     * @memberof CommissionItemClass
+     */
+    'id': number;
+    /**
+     * The unique identifier of the parent commission this item belongs to
+     * @type {number}
+     * @memberof CommissionItemClass
+     */
+    'commissionId': number;
+    /**
+     * The name or title of the commission item
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'name': string;
+    /**
+     * A detailed description explaining what this commission item represents
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'description': string;
+    /**
+     * The monetary amount of the commission item in the smallest currency unit (e.g., cents)
+     * @type {number}
+     * @memberof CommissionItemClass
+     */
+    'amount': number;
+    /**
+     * The type of commission item. Valid values: \'sales\', \'maintenance\', \'other\'
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'type': CommissionItemClassTypeEnum;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof CommissionItemClass
+     */
+    'updatedBy': string;
+}
+export declare const CommissionItemClassTypeEnum: {
+    readonly Sales: "sales";
+    readonly Maintenance: "maintenance";
+    readonly Other: "other";
+};
+export type CommissionItemClassTypeEnum = typeof CommissionItemClassTypeEnum[keyof typeof CommissionItemClassTypeEnum];

package/dist/models/commission-item-class.js

@@ -0,0 +1,21 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.CommissionItemClassTypeEnum = void 0;
+exports.CommissionItemClassTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+};

package/dist/models/create-commission-agreement-request-dto.d.ts

@@ -0,0 +1,71 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 CreateCommissionAgreementRequestDto
+ */
+export interface CreateCommissionAgreementRequestDto {
+    /**
+     * Human-readable name of the commission agreement
+     * @type {string}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'name': string;
+    /**
+     * Frequency at which commissions are billed (e.g., monthly, quarterly, annually)
+     * @type {string}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'billingFrequency': CreateCommissionAgreementRequestDtoBillingFrequencyEnum;
+    /**
+     * Current status of the commission agreement (e.g., active, inactive)
+     * @type {string}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'status': CreateCommissionAgreementRequestDtoStatusEnum;
+    /**
+     * Array of product slugs that this commission agreement applies to
+     * @type {Array<string>}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'productSlugs': Array<string>;
+    /**
+     * Detailed description of the commission agreement terms and conditions
+     * @type {string}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'description'?: string;
+    /**
+     * Start date when the commission agreement becomes effective
+     * @type {string}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'startDate'?: string;
+    /**
+     * End date when the commission agreement expires or is terminated
+     * @type {string}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'endDate'?: string;
+}
+export declare const CreateCommissionAgreementRequestDtoBillingFrequencyEnum: {
+    readonly Monthly: "monthly";
+    readonly Quarterly: "quarterly";
+    readonly Yearly: "yearly";
+};
+export type CreateCommissionAgreementRequestDtoBillingFrequencyEnum = typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum[keyof typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum];
+export declare const CreateCommissionAgreementRequestDtoStatusEnum: {
+    readonly Active: "active";
+    readonly Inactive: "inactive";
+};
+export type CreateCommissionAgreementRequestDtoStatusEnum = typeof CreateCommissionAgreementRequestDtoStatusEnum[keyof typeof CreateCommissionAgreementRequestDtoStatusEnum];

package/dist/models/create-commission-agreement-request-dto.js

@@ -0,0 +1,25 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.CreateCommissionAgreementRequestDtoStatusEnum = exports.CreateCommissionAgreementRequestDtoBillingFrequencyEnum = void 0;
+exports.CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
+    Monthly: 'monthly',
+    Quarterly: 'quarterly',
+    Yearly: 'yearly'
+};
+exports.CreateCommissionAgreementRequestDtoStatusEnum = {
+    Active: 'active',
+    Inactive: 'inactive'
+};

package/dist/models/create-commission-agreement-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CommissionAgreementClass } from './commission-agreement-class';
+/**
+ *
+ * @export
+ * @interface CreateCommissionAgreementResponseClass
+ */
+export interface CreateCommissionAgreementResponseClass {
+    /**
+     * The created commission agreement object
+     * @type {CommissionAgreementClass}
+     * @memberof CreateCommissionAgreementResponseClass
+     */
+    'commissionAgreement'?: CommissionAgreementClass;
+}

package/dist/models/create-commission-agreement-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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-commission-agreement-version-request-dto.d.ts

@@ -0,0 +1,42 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 CreateCommissionAgreementVersionRequestDto
+ */
+export interface CreateCommissionAgreementVersionRequestDto {
+    /**
+     * Code of the parent commission agreement to create a version for
+     * @type {string}
+     * @memberof CreateCommissionAgreementVersionRequestDto
+     */
+    'commissionAgreementCode': string;
+    /**
+     * Start date when this version of the commission agreement becomes effective
+     * @type {string}
+     * @memberof CreateCommissionAgreementVersionRequestDto
+     */
+    'startDate'?: string;
+    /**
+     * End date when this version of the commission agreement expires
+     * @type {string}
+     * @memberof CreateCommissionAgreementVersionRequestDto
+     */
+    'endDate'?: string;
+    /**
+     * Description explaining what changed in this version or version notes
+     * @type {string}
+     * @memberof CreateCommissionAgreementVersionRequestDto
+     */
+    'versionDescription'?: string;
+}

package/dist/models/create-commission-agreement-version-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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-commission-agreement-version-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CommissionAgreementVersionClass } from './commission-agreement-version-class';
+/**
+ *
+ * @export
+ * @interface CreateCommissionAgreementVersionResponseClass
+ */
+export interface CreateCommissionAgreementVersionResponseClass {
+    /**
+     * The created commission agreement version object
+     * @type {CommissionAgreementVersionClass}
+     * @memberof CreateCommissionAgreementVersionResponseClass
+     */
+    'version'?: CommissionAgreementVersionClass;
+}

package/dist/models/create-commission-agreement-version-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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-commission-item-request-dto.d.ts

@@ -0,0 +1,48 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 CreateCommissionItemRequestDto
+ */
+export interface CreateCommissionItemRequestDto {
+    /**
+     * The name or title of the commission item
+     * @type {string}
+     * @memberof CreateCommissionItemRequestDto
+     */
+    'name': string;
+    /**
+     * A detailed description explaining what this commission item represents
+     * @type {string}
+     * @memberof CreateCommissionItemRequestDto
+     */
+    'description': string;
+    /**
+     * The monetary amount of the commission item in the smallest currency unit (e.g., cents)
+     * @type {number}
+     * @memberof CreateCommissionItemRequestDto
+     */
+    'amount': number;
+    /**
+     * The type of commission item. Valid values: sales, maintenance, other
+     * @type {string}
+     * @memberof CreateCommissionItemRequestDto
+     */
+    'type': CreateCommissionItemRequestDtoTypeEnum;
+}
+export declare const CreateCommissionItemRequestDtoTypeEnum: {
+    readonly Sales: "sales";
+    readonly Maintenance: "maintenance";
+    readonly Other: "other";
+};
+export type CreateCommissionItemRequestDtoTypeEnum = typeof CreateCommissionItemRequestDtoTypeEnum[keyof typeof CreateCommissionItemRequestDtoTypeEnum];

package/dist/models/create-commission-item-request-dto.js

@@ -0,0 +1,21 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.CreateCommissionItemRequestDtoTypeEnum = void 0;
+exports.CreateCommissionItemRequestDtoTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+};

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

@@ -0,0 +1,55 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CreateCommissionItemRequestDto } from './create-commission-item-request-dto';
+/**
+ *
+ * @export
+ * @interface CreateCommissionRequestDto
+ */
+export interface CreateCommissionRequestDto {
+    /**
+     * The unique code or identifier of the commission agreement this commission is based on
+     * @type {string}
+     * @memberof CreateCommissionRequestDto
+     */
+    'commissionAgreementCode': string;
+    /**
+     * A detailed description explaining what this commission represents and its purpose
+     * @type {string}
+     * @memberof CreateCommissionRequestDto
+     */
+    'description': string;
+    /**
+     * The version identifier of the commission agreement being used for this commission
+     * @type {number}
+     * @memberof CreateCommissionRequestDto
+     */
+    'commissionAgreementVersionId': number;
+    /**
+     * The unique code or identifier of the partner associated with this commission
+     * @type {string}
+     * @memberof CreateCommissionRequestDto
+     */
+    'partnerCode': string;
+    /**
+     * The policy code or identifier of the policy associated with this commission
+     * @type {string}
+     * @memberof CreateCommissionRequestDto
+     */
+    'policyCode': string;
+    /**
+     * An array of commission items that make up this commission. Each item represents a specific commission component with its own amount, type
+     * @type {Array<CreateCommissionItemRequestDto>}
+     * @memberof CreateCommissionRequestDto
+     */
+    'items': Array<CreateCommissionItemRequestDto>;
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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-commission-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CommissionClass } from './commission-class';
+/**
+ *
+ * @export
+ * @interface CreateCommissionResponseClass
+ */
+export interface CreateCommissionResponseClass {
+    /**
+     * The commission that was created
+     * @type {CommissionClass}
+     * @memberof CreateCommissionResponseClass
+     */
+    'commission'?: CommissionClass;
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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/get-commission-agreement-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CommissionAgreementClass } from './commission-agreement-class';
+/**
+ *
+ * @export
+ * @interface GetCommissionAgreementResponseClass
+ */
+export interface GetCommissionAgreementResponseClass {
+    /**
+     * The requested commission agreement object
+     * @type {CommissionAgreementClass}
+     * @memberof GetCommissionAgreementResponseClass
+     */
+    'commissionAgreement'?: CommissionAgreementClass;
+}