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

package/models/group-achpull-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 { Debug } from './debug';
+import { GroupACHPull } from './group-achpull';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface GroupACHPullVBAResponse
+ */
+export interface GroupACHPullVBAResponse {
+    /**
+     * 
+     * @type {GroupACHPull}
+     * @memberof GroupACHPullVBAResponse
+     */
+    'data'?: GroupACHPull;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof GroupACHPullVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof GroupACHPullVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/group-achpull.ts

@@ -0,0 +1,60 @@
+/* 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 GroupACHPull
+ */
+export interface GroupACHPull {
+    /**
+     * References the Groups.Group_ID value on the parent record.
+     * @type {string}
+     * @memberof GroupACHPull
+     */
+    'group_ID': string;
+    /**
+     * Day the ACH transaction occurs Note: This field is marked as NOT NULL in the database and therefore required by the API.
+     * @type {number}
+     * @memberof GroupACHPull
+     */
+    'acH_Pull_Day': number;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof GroupACHPull
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof GroupACHPull
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof GroupACHPull
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof GroupACHPull
+     */
+    'update_User'?: string | null;
+}
+

package/models/group-bill-cycle-payment-method-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 { Debug } from './debug';
+import { GroupBillCyclePaymentMethod } from './group-bill-cycle-payment-method';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface GroupBillCyclePaymentMethodListVBAResponse
+ */
+export interface GroupBillCyclePaymentMethodListVBAResponse {
+    /**
+     * 
+     * @type {Array<GroupBillCyclePaymentMethod>}
+     * @memberof GroupBillCyclePaymentMethodListVBAResponse
+     */
+    'data'?: Array<GroupBillCyclePaymentMethod> | null;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof GroupBillCyclePaymentMethodListVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof GroupBillCyclePaymentMethodListVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/group-bill-cycle-payment-method-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 { Debug } from './debug';
+import { GroupBillCyclePaymentMethod } from './group-bill-cycle-payment-method';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface GroupBillCyclePaymentMethodVBAResponse
+ */
+export interface GroupBillCyclePaymentMethodVBAResponse {
+    /**
+     * 
+     * @type {GroupBillCyclePaymentMethod}
+     * @memberof GroupBillCyclePaymentMethodVBAResponse
+     */
+    'data'?: GroupBillCyclePaymentMethod;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof GroupBillCyclePaymentMethodVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof GroupBillCyclePaymentMethodVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/group-bill-cycle-payment-method.ts

@@ -0,0 +1,78 @@
+/* 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 GroupBillCyclePaymentMethod
+ */
+export interface GroupBillCyclePaymentMethod {
+    /**
+     * Unique identifier for the Group Billing Cycle Payment Method Note: This field is marked as NOT NULL in the database and therefore required by the API.
+     * @type {number}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'groupBillCyclePaymentMethod_Key': number;
+    /**
+     * Unique identifier for the Billing Cycle
+     * @type {string}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'billing_Cycle_ID'?: string | null;
+    /**
+     * Unique ID for the Division
+     * @type {string}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'division_ID'?: string | null;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'entry_User'?: string | null;
+    /**
+     * Unique ID for the Group
+     * @type {string}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'group_ID'?: string | null;
+    /**
+     * The primary key of the payment method
+     * @type {string}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'payment_Method'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof GroupBillCyclePaymentMethod
+     */
+    'update_User'?: string | null;
+}
+

package/models/group-change-coverage-start.ts

@@ -39,5 +39,11 @@ export interface GroupChangeCoverageStart {
      * @memberof GroupChangeCoverageStart
      */
     'user_ID'?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GroupChangeCoverageStart
+     */
+    'disable_Enrollment_Update'?: boolean;
 }
 

package/models/group-class.ts

@@ -21,19 +21,19 @@
  */
 export interface GroupClass {
     /**
-     * Unique identifier for each Claim record within this Group/Division.
+     * Unique identifier for each Claim record within this Group/Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof GroupClass
      */
     'groupDivisionClass_Key': number;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof GroupClass
      */
     'cobra': boolean;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {string}
      * @memberof GroupClass
      */
@@ -56,6 +56,18 @@ export interface GroupClass {
      * @memberof GroupClass
      */
     'effective_Date'?: string | null;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof GroupClass
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof GroupClass
+     */
+    'entry_User'?: string | null;
     /**
      * References GroupDivision.Group_ID value on the parent record.
      * @type {string}
@@ -63,55 +75,55 @@ export interface GroupClass {
      */
     'group_ID': string;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {number}
      * @memberof GroupClass
      */
     'max_Amount'?: number | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {number}
      * @memberof GroupClass
      */
     'max_Guaranteed_Issue'?: number | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {number}
      * @memberof GroupClass
      */
     'max_Volume'?: number | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {number}
      * @memberof GroupClass
      */
     'min_Amount'?: number | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {number}
      * @memberof GroupClass
      */
     'min_Volume'?: number | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {string}
      * @memberof GroupClass
      */
     'multiplier_Option'?: string | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {number}
      * @memberof GroupClass
      */
     'pay_Freq'?: number | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {string}
      * @memberof GroupClass
      */
     'pay_Freq_Start'?: string | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {string}
      * @memberof GroupClass
      */
@@ -123,13 +135,13 @@ export interface GroupClass {
      */
     'plan_ID'?: string | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof GroupClass
      */
     'smart_Flex': boolean;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {string}
      * @memberof GroupClass
      */
@@ -141,25 +153,37 @@ export interface GroupClass {
      */
     'term_Date'?: string | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {string}
      * @memberof GroupClass
      */
     'term_Rule'?: string | null;
     /**
-     * 
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof GroupClass
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof GroupClass
+     */
+    'update_User'?: string | null;
+    /**
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {number}
      * @memberof GroupClass
      */
     'volume_Increment'?: number | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {number}
      * @memberof GroupClass
      */
     'waiting_Period'?: number | null;
     /**
-     * 
+     * Informational used in custom reporting for Life & Disability clients who have an additional \"Class\" structure under Division.
      * @type {string}
      * @memberof GroupClass
      */

package/models/group-company-data-ex-code-override.ts

@@ -21,7 +21,7 @@
  */
 export interface GroupCompanyDataExCodeOverride {
     /**
-     * Unique identifier for each Ex Code override configuration.
+     * Unique identifier for each Ex Code override configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof GroupCompanyDataExCodeOverride
      */
@@ -38,6 +38,18 @@ export interface GroupCompanyDataExCodeOverride {
      * @memberof GroupCompanyDataExCodeOverride
      */
     'division_ID'?: string | null;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof GroupCompanyDataExCodeOverride
+     */
+    'entry_Date'?: string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof GroupCompanyDataExCodeOverride
+     */
+    'entry_User'?: string | null;
     /**
      * References GroupDivision.Group_ID value on the parent record.
      * @type {string}
@@ -50,5 +62,17 @@ export interface GroupCompanyDataExCodeOverride {
      * @memberof GroupCompanyDataExCodeOverride
      */
     'override_Ex_Code'?: string | null;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof GroupCompanyDataExCodeOverride
+     */
+    'update_Date'?: string;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof GroupCompanyDataExCodeOverride
+     */
+    'update_User'?: string | null;
 }
 

package/models/group-contract-plan-premium.ts

@@ -21,13 +21,13 @@
  */
 export interface GroupContractPlanPremium {
     /**
-     * No longer in use. Replaced by Premium Billing module.
+     * No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof GroupContractPlanPremium
      */
     'groupContractPlanPremium_Key': number;
     /**
-     * No longer in use. Replaced by Premium Billing module.
+     * No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof GroupContractPlanPremium
      */
@@ -57,13 +57,13 @@ export interface GroupContractPlanPremium {
      */
     'billing_Basis': string;
     /**
-     * No longer in use. Replaced by Premium Billing module.
+     * No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof GroupContractPlanPremium
      */
     'child': boolean;
     /**
-     * No longer in use. Replaced by Premium Billing module.
+     * No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof GroupContractPlanPremium
      */
@@ -74,6 +74,18 @@ export interface GroupContractPlanPremium {
      * @memberof GroupContractPlanPremium
      */
     'division_ID': string;
+    /**
+     * No longer in use. Replaced by Premium Billing module.
+     * @type {string}
+     * @memberof GroupContractPlanPremium
+     */
+    'entry_Date'?: string;
+    /**
+     * No longer in use. Replaced by Premium Billing module.
+     * @type {string}
+     * @memberof GroupContractPlanPremium
+     */
+    'entry_User'?: string | null;
     /**
      * No longer in use. Replaced by Premium Billing module.
      * @type {string}
@@ -110,5 +122,17 @@ export interface GroupContractPlanPremium {
      * @memberof GroupContractPlanPremium
      */
     'tier'?: string | null;
+    /**
+     * No longer in use. Replaced by Premium Billing module.
+     * @type {string}
+     * @memberof GroupContractPlanPremium
+     */
+    'update_Date'?: string;
+    /**
+     * No longer in use. Replaced by Premium Billing module.
+     * @type {string}
+     * @memberof GroupContractPlanPremium
+     */
+    'update_User'?: string | null;
 }
 

package/models/group-contract-plan-rider-external-id.ts

@@ -33,7 +33,7 @@ export interface GroupContractPlanRiderExternalID {
      */
     'division_ID': string;
     /**
-     * References GroupContractPlanRider.Coverage_Start value on the parent record.
+     * References GroupContractPlanRider.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof GroupContractPlanRiderExternalID
      */
@@ -56,5 +56,29 @@ export interface GroupContractPlanRiderExternalID {
      * @memberof GroupContractPlanRiderExternalID
      */
     'external_ID': string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof GroupContractPlanRiderExternalID
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof GroupContractPlanRiderExternalID
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof GroupContractPlanRiderExternalID
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof GroupContractPlanRiderExternalID
+     */
+    'update_User'?: string | null;
 }
 

package/models/group-contract-plan-rider.ts

@@ -33,7 +33,7 @@ export interface GroupContractPlanRider {
      */
     'division_ID': string;
     /**
-     * References GroupContractPlan.Coverage_Start value on the parent record.
+     * References GroupContractPlan.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof GroupContractPlanRider
      */
@@ -63,11 +63,23 @@ export interface GroupContractPlanRider {
      */
     'employee_Contribution'?: number | null;
     /**
-     * For flex, notes if the amount entered into \"Employee_Contribution\" is a percent or flat amount.
+     * For flex, notes if the amount entered into \"Employee_Contribution\" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof GroupContractPlanRider
      */
     'employee_Contribution_Pct': boolean;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof GroupContractPlanRider
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof GroupContractPlanRider
+     */
+    'entry_User'?: string | null;
     /**
      * Information only, used in custom client reporting.
      * @type {string}
@@ -93,7 +105,19 @@ export interface GroupContractPlanRider {
      */
     'salary_Pct'?: number | null;
     /**
-     * Indicates if a percent of salary should be used when determing this benefit amount.
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof GroupContractPlanRider
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof GroupContractPlanRider
+     */
+    'update_User'?: string | null;
+    /**
+     * Indicates if a percent of salary should be used when determing this benefit amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof GroupContractPlanRider
      */