@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20230130.2 → 1.20230225.1

package/models/sub-enrollment-rider.ts

@@ -39,13 +39,13 @@ export interface SubEnrollmentRider {
      */
     'division_ID': string;
     /**
-     * References the SubenrollmentPlan.Group_Coverage_Start value in the parent table.
+     * References the SubenrollmentPlan.Group_Coverage_Start value in the parent table.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof SubEnrollmentRider
      */
     'group_Coverage_Start': string;
     /**
-     * References the SubenrollmentPlan.Start_Date value in the parent table.
+     * References the SubenrollmentPlan.Start_Date value in the parent table.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof SubEnrollmentRider
      */
@@ -57,7 +57,7 @@ export interface SubEnrollmentRider {
      */
     'plan_ID': string;
     /**
-     * References the SubenrollmentPlan.Plan_Start value in the parent table.
+     * References the SubenrollmentPlan.Plan_Start value in the parent table.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof SubEnrollmentRider
      */
@@ -69,7 +69,7 @@ export interface SubEnrollmentRider {
      */
     'benefit_Code': string;
     /**
-     * Start date of Rider coverage.
+     * Start date of Rider coverage.  Note: The database will apply a default value of `1/1/0001 12:00:00 AM` 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 `1/1/0001 12:00:00 AM` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {string}
      * @memberof SubEnrollmentRider
      */
@@ -87,7 +87,7 @@ export interface SubEnrollmentRider {
      */
     'employee_Contribution'?: number | null;
     /**
-     * Indicates if the Emploee Contribution amount entered is a Pct or flat amount.
+     * Indicates if the Emploee Contribution amount entered is a Pct or flat amount.  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.
      * @type {boolean}
      * @memberof SubEnrollmentRider
      */
@@ -117,37 +117,37 @@ export interface SubEnrollmentRider {
      */
     'initial_Volume'?: number | null;
     /**
-     * Indicates that the number from the \'Initial Volume\' field represents a percentage of the Member\'s salary. Salaries are found from a Member\'s \'Financial\' detail dropdown.
+     * Indicates that the number from the \'Initial Volume\' field represents a percentage of the Member\'s salary. Salaries are found from a Member\'s \'Financial\' detail dropdown.  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.
      * @type {boolean}
      * @memberof SubEnrollmentRider
      */
     'initial_Volume_Salary_Pct': boolean;
     /**
-     * 
+     * Member elected Daily Benefit Amount
      * @type {number}
      * @memberof SubEnrollmentRider
      */
     'ltC_Daily_Benefit_Amount'?: number | null;
     /**
-     * 
+     * Lifetime Max Amount elected
      * @type {number}
      * @memberof SubEnrollmentRider
      */
     'ltC_Lifetime_Max_Amount'?: number | null;
     /**
-     * 
+     * Lifetime Max Days elected
      * @type {number}
      * @memberof SubEnrollmentRider
      */
     'ltC_Lifetime_Max_Days'?: number | null;
     /**
-     * 
+     * Lifetime Max Years elected
      * @type {number}
      * @memberof SubEnrollmentRider
      */
     'ltC_Lifetime_Max_Years'?: number | null;
     /**
-     * 
+     * Member elected Monthly Benefit Amount
      * @type {number}
      * @memberof SubEnrollmentRider
      */
@@ -183,19 +183,19 @@ export interface SubEnrollmentRider {
      */
     'update_User'?: string | null;
     /**
-     * Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider.
+     * Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider.  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.
      * @type {boolean}
      * @memberof SubEnrollmentRider
      */
     'use_Employee_Age': boolean;
     /**
-     * The \'Gaurantee Issue\' option is an alternative to the \'Use Scale\' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the \"Life AD&D\" indicator.
+     * The \'Gaurantee Issue\' option is an alternative to the \'Use Scale\' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the \"Life AD&D\" indicator.  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.
      * @type {boolean}
      * @memberof SubEnrollmentRider
      */
     'use_GI_Volume_Min_Max': boolean;
     /**
-     * This option tells the system to calculate the \'Volume\' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the \"Life AD&D\" indicator.
+     * This option tells the system to calculate the \'Volume\' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the \"Life AD&D\" indicator.  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.
      * @type {boolean}
      * @memberof SubEnrollmentRider
      */

package/models/subscribers.ts

@@ -183,13 +183,13 @@ export interface Subscribers {
      */
     'salutation'?: string | null;
     /**
-     * 
+     * This holds the Subscriber ID of the subscriber that sponsored this subscriber.
      * @type {string}
      * @memberof Subscribers
      */
     'sponsor_ID'?: string | null;
     /**
-     * 
+     * This identifies the relationship between the sponor and this subscriber.
      * @type {string}
      * @memberof Subscribers
      */

package/models/users.ts

@@ -27,7 +27,7 @@ export interface Users {
      */
     'user_ID': string;
     /**
-     * This option will lock the account out of the application. To unlock the account, uncheck the box.
+     * This option will lock the account out of the application. To unlock the account, uncheck the box.  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.
      * @type {boolean}
      * @memberof Users
      */
@@ -45,13 +45,13 @@ export interface Users {
      */
     'address2'?: string | null;
     /**
-     * Grants the User administrative rights. No security area needs to be assigned. This User will have full rights to every aspect of the application.
+     * Grants the User administrative rights. No security area needs to be assigned. This User will have full rights to every aspect of the application.  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.
      * @type {boolean}
      * @memberof Users
      */
     'administrator': boolean;
     /**
-     * This option enables logging based on the definitions provided within ‘User Log Message’.
+     * This option enables logging based on the definitions provided within ‘User Log Message’.  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.
      * @type {boolean}
      * @memberof Users
      */
@@ -141,7 +141,7 @@ export interface Users {
      */
     'home_Phone_Country_Code'?: string | null;
     /**
-     * This option is informational only but can be used with a custom report.
+     * This option is informational only but can be used with a custom report.  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.
      * @type {boolean}
      * @memberof Users
      */
@@ -213,7 +213,7 @@ export interface Users {
      */
     'phone_Country_Code'?: string | null;
     /**
-     * This option indicates that only one application can be opened using this login ID.
+     * This option indicates that only one application can be opened using this login ID.  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.
      * @type {boolean}
      * @memberof Users
      */
@@ -243,7 +243,7 @@ export interface Users {
      */
     'update_User'?: string | null;
     /**
-     * Whether or not to use Windows Authentication to login
+     * Whether or not to use Windows Authentication to login  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.
      * @type {boolean}
      * @memberof Users
      */
@@ -261,13 +261,13 @@ export interface Users {
      */
     'user_Type'?: string | null;
     /**
-     * 
+     * This flag indicates that this user can change other VBA_User\'s passwords.  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.
      * @type {boolean}
      * @memberof Users
      */
     'vbA_Password_Reset': boolean;
     /**
-     * Identifies that the User is a VBA User.
+     * Identifies that the User is a VBA User.  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.
      * @type {boolean}
      * @memberof Users
      */

package/models/vbagroup-contract-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 { VBAGroupContract } from './vbagroup-contract';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface VBAGroupContractListVBAResponse
+ */
+export interface VBAGroupContractListVBAResponse {
+    /**
+     * 
+     * @type {Array<VBAGroupContract>}
+     * @memberof VBAGroupContractListVBAResponse
+     */
+    'data'?: Array<VBAGroupContract> | null;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof VBAGroupContractListVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof VBAGroupContractListVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/vbagroup-contract.ts

@@ -0,0 +1,55 @@
+/* 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 { GroupContract } from './group-contract';
+
+/**
+ * 
+ * @export
+ * @interface VBAGroupContract
+ */
+export interface VBAGroupContract {
+    /**
+     * 
+     * @type {number}
+     * @memberof VBAGroupContract
+     */
+    'total_Subscribers'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof VBAGroupContract
+     */
+    'eligible_Subscribers'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof VBAGroupContract
+     */
+    'total_Members'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof VBAGroupContract
+     */
+    'eligible_Members'?: number | null;
+    /**
+     * 
+     * @type {GroupContract}
+     * @memberof VBAGroupContract
+     */
+    'groupContractDetail'?: GroupContract;
+}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbasoftware/vbapi-vbasoftware-typescript-axios",
-  "version": "1.20230130.2",
+  "version": "1.20230225.1",
   "description": "APIs for VBASoftware APIs",
   "main": "index.js",
   "scripts": {