@emilgroup/commission-sdk 1.0.0-beta.1

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

@@ -0,0 +1,20 @@
+"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.UpdateCommissionRequestDtoStatusEnum = void 0;
+exports.UpdateCommissionRequestDtoStatusEnum = {
+    Pending: 'pending',
+    Settled: 'settled'
+};

package/dist/models/update-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 UpdateCommissionResponseClass
+ */
+export interface UpdateCommissionResponseClass {
+    /**
+     * The commission that was updated
+     * @type {CommissionClass}
+     * @memberof UpdateCommissionResponseClass
+     */
+    'commission'?: CommissionClass;
+}

package/dist/models/update-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/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="Emil"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="commission-sdk"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,19 @@
+/* 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.
+ */
+
+
+export { Environment, BaseAPI } from "./base";
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/models/commission-agreement-class.ts

@@ -0,0 +1,99 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CommissionAgreementClass
+ */
+export interface CommissionAgreementClass {
+    /**
+     * Unique identifier for the commission agreement
+     * @type {number}
+     * @memberof CommissionAgreementClass
+     */
+    'id': number;
+    /**
+     * Human-readable name of the commission agreement
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'name': string;
+    /**
+     * Unique code identifier for the commission agreement, auto-generated on creation
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'code': string;
+    /**
+     * Current status of the commission agreement (e.g., active, inactive)
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'status': CommissionAgreementClassStatusEnum;
+    /**
+     * Detailed description of the commission agreement terms and conditions
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'description'?: string;
+    /**
+     * Frequency at which commissions are billed (e.g., monthly, quarterly, yearly)
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'billingFrequency'?: CommissionAgreementClassBillingFrequencyEnum;
+    /**
+     * Timestamp when the commission agreement was created
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'createdAt'?: string;
+    /**
+     * Timestamp when the commission agreement was last updated
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'updatedAt'?: string;
+    /**
+     * User identifier who created the commission agreement
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'createdBy'?: string;
+    /**
+     * User identifier who last updated the commission agreement
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'updatedBy'?: string;
+}
+
+export const CommissionAgreementClassStatusEnum = {
+    Active: 'active',
+    Inactive: 'inactive'
+} as const;
+
+export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
+export const CommissionAgreementClassBillingFrequencyEnum = {
+    Monthly: 'monthly',
+    Quarterly: 'quarterly',
+    Yearly: 'yearly'
+} as const;
+
+export type CommissionAgreementClassBillingFrequencyEnum = typeof CommissionAgreementClassBillingFrequencyEnum[keyof typeof CommissionAgreementClassBillingFrequencyEnum];
+
+

package/models/commission-agreement-version-class.ts

@@ -0,0 +1,85 @@
+/* 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.
+ */
+
+
+import { CommissionAgreementClass } from './commission-agreement-class';
+
+/**
+ * 
+ * @export
+ * @interface CommissionAgreementVersionClass
+ */
+export interface CommissionAgreementVersionClass {
+    /**
+     * Unique identifier for the commission agreement version
+     * @type {number}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'id': number;
+    /**
+     * The parent commission agreement
+     * @type {CommissionAgreementClass}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'agreement': CommissionAgreementClass;
+    /**
+     * Unique code identifier for the commission agreement version, auto-generated on creation
+     * @type {string}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'code': string;
+    /**
+     * Start date when this version of the commission agreement becomes effective
+     * @type {string}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'startDate'?: string;
+    /**
+     * End date when this version of the commission agreement expires
+     * @type {string}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'endDate'?: string;
+    /**
+     * Description explaining what changed in this version or version notes
+     * @type {string}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'versionDescription'?: string;
+    /**
+     * Timestamp when the commission agreement version was created
+     * @type {string}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'createdAt'?: string;
+    /**
+     * Timestamp when the commission agreement version was last updated
+     * @type {string}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'updatedAt'?: string;
+    /**
+     * User identifier who created the commission agreement version
+     * @type {string}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'createdBy'?: string;
+    /**
+     * User identifier who last updated the commission agreement version
+     * @type {string}
+     * @memberof CommissionAgreementVersionClass
+     */
+    'updatedBy'?: string;
+}
+

package/models/commission-class.ts

@@ -0,0 +1,109 @@
+/* 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.
+ */
+
+
+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/models/commission-item-class.ts

@@ -0,0 +1,93 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @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 const CommissionItemClassTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+} as const;
+
+export type CommissionItemClassTypeEnum = typeof CommissionItemClassTypeEnum[keyof typeof CommissionItemClassTypeEnum];
+
+

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

@@ -0,0 +1,81 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @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 const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
+    Monthly: 'monthly',
+    Quarterly: 'quarterly',
+    Yearly: 'yearly'
+} as const;
+
+export type CreateCommissionAgreementRequestDtoBillingFrequencyEnum = typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum[keyof typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum];
+export const CreateCommissionAgreementRequestDtoStatusEnum = {
+    Active: 'active',
+    Inactive: 'inactive'
+} as const;
+
+export type CreateCommissionAgreementRequestDtoStatusEnum = typeof CreateCommissionAgreementRequestDtoStatusEnum[keyof typeof CreateCommissionAgreementRequestDtoStatusEnum];
+
+

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

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

package/models/create-commission-agreement-version-request-dto.ts

@@ -0,0 +1,48 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @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;
+}
+