@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20240302.1 → 1.20240913.2

package/models/commission-activity.ts

@@ -21,67 +21,67 @@
  */
 export interface CommissionActivity {
     /**
-     * 
+     * Unique identifier for the CommissionActivity table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionActivity
      */
     'commissionActivity_Key': number;
     /**
-     * 
+     * Date the activity was completed
      * @type {string}
      * @memberof CommissionActivity
      */
     'end_Date'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof CommissionActivity
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof CommissionActivity
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Unique identifier for the Machine
      * @type {string}
      * @memberof CommissionActivity
      */
     'machine_ID'?: string | null;
     /**
-     * 
+     * Date the activity began
      * @type {string}
      * @memberof CommissionActivity
      */
     'start_Date'?: string | null;
     /**
-     * 
+     * Date activity was undone
      * @type {string}
      * @memberof CommissionActivity
      */
     'undo_Date'?: string | null;
     /**
-     * 
+     * User who undid the activity
      * @type {string}
      * @memberof CommissionActivity
      */
     'undo_User'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof CommissionActivity
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof CommissionActivity
      */
     'update_User'?: string | null;
     /**
-     * 
+     * Unique identifier for the User
      * @type {string}
      * @memberof CommissionActivity
      */

package/models/commission-adjustment.ts

@@ -21,7 +21,7 @@
  */
 export interface CommissionAdjustment {
     /**
-     * Unique identifier for the Commission Activity  Note: The database will apply a default value of `0` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Unique identifier for the Commission Activity Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAdjustment
      */
@@ -99,7 +99,7 @@ export interface CommissionAdjustment {
      */
     'payor_ID'?: string | null;
     /**
-     * Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * TBD Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof CommissionAdjustment
      */

package/models/commission-agency-rep.ts

@@ -21,103 +21,109 @@
  */
 export interface CommissionAgencyRep {
     /**
-     * 
+     * Unique identifier for the CommissionAgencyRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAgencyRep
      */
     'commissionAgencyRep_Key': number;
     /**
-     * 
+     * Unique identifier for the Agent
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'agent_Number'?: string | null;
     /**
      * 
+     * @type {string}
+     * @memberof CommissionAgencyRep
+     */
+    'cluster_Level'?: string | null;
+    /**
+     * Unique identifier for the CommissionAgency table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAgencyRep
      */
     'commissionAgency_Key': number;
     /**
-     * 
+     * Unique identifier for the CommissionRep table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAgencyRep
      */
     'commissionRep_Key': number;
     /**
-     * 
+     * Informational
      * @type {number}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_Deductible'?: number | null;
     /**
-     * 
+     * Informational
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_End'?: string | null;
     /**
-     * 
+     * Informational
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_Level'?: string | null;
     /**
-     * 
+     * Informational
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_Name'?: string | null;
     /**
-     * 
+     * Informational
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'eO_Coverage_Start'?: string | null;
     /**
-     * 
+     * Beginning date range the Agent represents the Agency
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'effective_Date'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Payee of the Agent
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'payee_ID'?: string | null;
     /**
-     * 
+     * Determine if the Payee, Agnecy, or Agent is paid
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'send_Check_To'?: string | null;
     /**
-     * 
+     * Ending date range the Agent represents the Agency
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'term_Date'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof CommissionAgencyRep
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof CommissionAgencyRep
      */

package/models/commission-agency.ts

@@ -21,31 +21,31 @@
  */
 export interface CommissionAgency {
     /**
-     * 
+     * Unique identifier for the Commission Agency table Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof CommissionAgency
      */
     'commissionAgency_Key': number;
     /**
-     * 
+     * Address1 of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'address1'?: string | null;
     /**
-     * 
+     * Address2 of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'address2'?: string | null;
     /**
-     * 
+     * Type of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'agency_Type'?: string | null;
     /**
-     * 
+     * City of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
@@ -55,87 +55,93 @@ export interface CommissionAgency {
      * @type {string}
      * @memberof CommissionAgency
      */
+    'cluster_Hierarchy'?: string | null;
+    /**
+     * Country ID of the Agency
+     * @type {string}
+     * @memberof CommissionAgency
+     */
     'country_ID'?: string | null;
     /**
-     * 
+     * County Code of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'county_Code'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof CommissionAgency
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof CommissionAgency
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Fax Country Code of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'fax_Country_Code'?: string | null;
     /**
-     * 
+     * Fax Number of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'fax_Number'?: string | null;
     /**
-     * 
+     * Name of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'name'?: string | null;
     /**
-     * 
+     * Payee ID of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'payee_ID'?: string | null;
     /**
-     * 
+     * Payment Distribution Interval of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'payment_Distribution_Interval'?: string | null;
     /**
-     * 
+     * Phone Country Code of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'phone_Country_Code'?: string | null;
     /**
-     * 
+     * Phone Number of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'phone_Number'?: string | null;
     /**
-     * 
+     * State of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */
     'state'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof CommissionAgency
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof CommissionAgency
      */
     'update_User'?: string | null;
     /**
-     * 
+     * Zip Code of the Agency
      * @type {string}
      * @memberof CommissionAgency
      */

package/models/commission-rate-cluster-agency-rep-list-vbaresponse.ts

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VBASoftware
+ * APIs for VBASoftware
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { CommissionRateClusterAgencyRep } from './commission-rate-cluster-agency-rep';
+import { Debug } from './debug';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface CommissionRateClusterAgencyRepListVBAResponse
+ */
+export interface CommissionRateClusterAgencyRepListVBAResponse {
+    /**
+     * 
+     * @type {Array<CommissionRateClusterAgencyRep>}
+     * @memberof CommissionRateClusterAgencyRepListVBAResponse
+     */
+    'data'?: Array<CommissionRateClusterAgencyRep> | null;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof CommissionRateClusterAgencyRepListVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof CommissionRateClusterAgencyRepListVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/commission-rate-cluster-agency-rep-vbaresponse.ts

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VBASoftware
+ * APIs for VBASoftware
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { CommissionRateClusterAgencyRep } from './commission-rate-cluster-agency-rep';
+import { Debug } from './debug';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface CommissionRateClusterAgencyRepVBAResponse
+ */
+export interface CommissionRateClusterAgencyRepVBAResponse {
+    /**
+     * 
+     * @type {CommissionRateClusterAgencyRep}
+     * @memberof CommissionRateClusterAgencyRepVBAResponse
+     */
+    'data'?: CommissionRateClusterAgencyRep;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof CommissionRateClusterAgencyRepVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof CommissionRateClusterAgencyRepVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/commission-rate-cluster-agency-rep.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VBASoftware
+ * APIs for VBASoftware
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * 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 CommissionRateClusterAgencyRep
+ */
+export interface CommissionRateClusterAgencyRep {
+    /**
+     * Unique identifer for the Commission Rate Cluster Agency Rep Note: This field is marked as NOT NULL in the database and therefore required by the API.
+     * @type {number}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'commissionRateClusterAgencyRep_Key': number;
+    /**
+     * Unique identifier for the CommissionAgencyRep
+     * @type {number}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'commissionAgencyRep_Key'?: number | null;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'entry_User'?: string | null;
+    /**
+     * Parent key for the CommissionAgencyRep record this is a child of
+     * @type {number}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'parent_CommissionAgencyRep_Key'?: number | null;
+    /**
+     * Unique identifer for the Rate Cluster
+     * @type {string}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'rate_Cluster'?: string | null;
+    /**
+     * The amount or percentage of the split
+     * @type {number}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'split'?: number | null;
+    /**
+     * Maximum amount of the split
+     * @type {number}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'split_Max'?: number | null;
+    /**
+     * Minimum amount of the split
+     * @type {number}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'split_Min'?: number | null;
+    /**
+     * Priority of the split
+     * @type {number}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'split_Priority'?: number | null;
+    /**
+     * Determines if split is percent or flat amount
+     * @type {string}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'split_Type'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof CommissionRateClusterAgencyRep
+     */
+    'update_User'?: string | null;
+}
+

package/models/commission-rate-cluster.ts

@@ -21,7 +21,7 @@
  */
 export interface CommissionRateCluster {
     /**
-     * 
+     * Unique identifer for the Rate Cluster
      * @type {string}
      * @memberof CommissionRateCluster
      */
@@ -31,27 +31,33 @@ export interface CommissionRateCluster {
      * @type {string}
      * @memberof CommissionRateCluster
      */
+    'cluster_Level'?: string | null;
+    /**
+     * Description of the rate Cluster
+     * @type {string}
+     * @memberof CommissionRateCluster
+     */
     'description'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof CommissionRateCluster
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof CommissionRateCluster
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof CommissionRateCluster
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof CommissionRateCluster
      */