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

package/models/prem-rate.ts

@@ -21,511 +21,511 @@
  */
 export interface PremRate {
     /**
-     * 
+     * Unique identifier for the PremRate  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.
      * @type {number}
      * @memberof PremRate
      */
     'premRate_Key': number;
     /**
-     * 
+     * Address the additional invoice is sent to
      * @type {string}
      * @memberof PremRate
      */
     'additional_Invoice_Address'?: string | null;
     /**
-     * 
+     * Frequency of the additional invoice
      * @type {string}
      * @memberof PremRate
      */
     'additional_Invoice_Frequency'?: string | null;
     /**
-     * 
+     * Allows split billing at this level
      * @type {string}
      * @memberof PremRate
      */
     'additional_Invoice_Level'?: string | null;
     /**
-     * 
+     * Level of the Address used to determine if the rate applies
      * @type {string}
      * @memberof PremRate
      */
     'address_Type'?: string | null;
     /**
-     * 
+     * Adjustment Reason of the PremRate
      * @type {number}
      * @memberof PremRate
      */
     'adjustment_Reason'?: number | null;
     /**
-     * 
+     * Flag used to determine if the rate applies to Adults  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 PremRate
      */
     'adult': boolean;
     /**
-     * 
+     * Beginning Age range of the PremRate
      * @type {number}
      * @memberof PremRate
      */
     'age_From'?: number | null;
     /**
-     * 
+     * Ending Age range of the PremRate
      * @type {number}
      * @memberof PremRate
      */
     'age_Thru'?: number | null;
     /**
-     * 
+     * Detemines what date is used to calculate Age
      * @type {string}
      * @memberof PremRate
      */
     'age_Type'?: string | null;
     /**
-     * 
+     * Detemines what Month is used if the Month Type is selected
      * @type {string}
      * @memberof PremRate
      */
     'age_Type_Month'?: string | null;
     /**
-     * 
+     * Flag to determine if the rate applies to new Divisions  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 PremRate
      */
     'assign_To_New_Division': boolean;
     /**
-     * 
+     * Flag to determine if the rate applies to new Groups  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 PremRate
      */
     'assign_To_New_Group': boolean;
     /**
-     * 
+     * Flag to determine if the rate applies to new Members  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 PremRate
      */
     'assign_To_New_Member': boolean;
     /**
-     * 
+     * Flag that determines if the rate is automatically adjusted  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 PremRate
      */
     'auto_Adjust': boolean;
     /**
-     * 
+     * Reason applied to automatic adjustments
      * @type {number}
      * @memberof PremRate
      */
     'auto_Adjust_Reason'?: number | null;
     /**
-     * 
+     * This flag indicates prevention of the retro logic from creating backout adjustments for this rate  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 PremRate
      */
     'avoid_Retro': boolean;
     /**
-     * 
+     * Benefit Code of the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'benefit_Code'?: string | null;
     /**
-     * 
+     * Flag used to determine if the rate applies to Children  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 PremRate
      */
     'child': boolean;
     /**
-     * 
+     * City of the Address used to determine if the rate applies
      * @type {string}
      * @memberof PremRate
      */
     'city'?: string | null;
     /**
-     * 
+     * Class Code for the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'class_Code'?: string | null;
     /**
-     * 
+     * Country ID of the Address used to determine if the rate applies
      * @type {string}
      * @memberof PremRate
      */
     'country_ID'?: string | null;
     /**
-     * 
+     * Country Code of the Address used to determine if the rate applies
      * @type {string}
      * @memberof PremRate
      */
     'county_Code'?: string | null;
     /**
-     * 
+     * Description of the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'description'?: string | null;
     /**
-     * 
+     * Unique identifier for the Division
      * @type {string}
      * @memberof PremRate
      */
     'division_ID'?: string | null;
     /**
-     * 
+     * Effective Date of the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'effective_Date'?: string | null;
     /**
-     * 
+     * Determines if the contribution is Employee or Employer
      * @type {string}
      * @memberof PremRate
      */
     'employee_Employer_Contribution'?: string | null;
     /**
-     * 
+     * Amount of the contribution
      * @type {number}
      * @memberof PremRate
      */
     'employer_Contribution'?: number | null;
     /**
-     * 
+     * Determines if the contribution is a percentage  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 PremRate
      */
     'employer_Contribution_Pct': boolean;
     /**
-     * 
+     * Decimal value that defines the base employer rate
      * @type {number}
      * @memberof PremRate
      */
     'employer_Rate'?: number | null;
     /**
-     * 
+     * Maximum the employer rate will be regardless of the calculation
      * @type {number}
      * @memberof PremRate
      */
     'employer_Rate_Max'?: number | null;
     /**
-     * 
+     * Minimum the employer rate will be regardless of the calculation
      * @type {number}
      * @memberof PremRate
      */
     'employer_Rate_Minimum'?: number | null;
     /**
-     * 
+     * Type of Employer Rate
      * @type {string}
      * @memberof PremRate
      */
     'employer_Rate_Type'?: string | null;
     /**
-     * 
+     * First variable used in calculating the employer rate based on the type
      * @type {number}
      * @memberof PremRate
      */
     'employer_Rate_Variable1'?: number | null;
     /**
-     * 
+     * Second variable used in calculating the employer rate based on the type
      * @type {number}
      * @memberof PremRate
      */
     'employer_Rate_Variable2'?: number | null;
     /**
-     * 
+     * Third variable used in calculating the employer rate based on the type
      * @type {number}
      * @memberof PremRate
      */
     'employer_Rate_Variable3'?: number | null;
     /**
-     * 
+     * Precision that the employerrate is rounded to
      * @type {number}
      * @memberof PremRate
      */
     'employer_Round_Precision'?: number | null;
     /**
-     * 
+     * Type that determine how the employer rate is rounded
      * @type {string}
      * @memberof PremRate
      */
     'employer_Round_Type'?: string | null;
     /**
-     * 
+     * Beginning range based on number of enrollments
      * @type {number}
      * @memberof PremRate
      */
     'enrolled_Count_From'?: number | null;
     /**
-     * 
+     * Ending range based on number of enrollments
      * @type {number}
      * @memberof PremRate
      */
     'enrolled_Count_Thru'?: number | null;
     /**
-     * 
+     * Type of enrollments used to calculate the number of enrollments
      * @type {string}
      * @memberof PremRate
      */
     'enrolled_Count_Type'?: string | null;
     /**
-     * 
+     * Beginning range based on length of enrollment
      * @type {number}
      * @memberof PremRate
      */
     'enrolled_Duration_From'?: number | null;
     /**
-     * 
+     * Minimum length of enrollment
      * @type {number}
      * @memberof PremRate
      */
     'enrolled_Duration_Min'?: number | null;
     /**
-     * 
+     * Determines if the date is based on the Member or the Plan enrollment
      * @type {string}
      * @memberof PremRate
      */
     'enrolled_Duration_Option'?: string | null;
     /**
-     * 
+     * Ending range based on length of enrollment
      * @type {number}
      * @memberof PremRate
      */
     'enrolled_Duration_Thru'?: number | null;
     /**
-     * 
+     * Type of date used to determine the enrollment range
      * @type {string}
      * @memberof PremRate
      */
     'enrolled_Duration_Type'?: string | null;
     /**
-     * 
+     * Date record was first added to the system
      * @type {string}
      * @memberof PremRate
      */
     'entry_Date'?: string;
     /**
-     * 
+     * User that first added the record to the system
      * @type {string}
      * @memberof PremRate
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Used to determine which records are updated when applying changes to a template  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 PremRate
      */
     'group_Division_Offering': boolean;
     /**
-     * 
+     * Unique identifier for the Group
      * @type {string}
      * @memberof PremRate
      */
     'group_ID'?: string | null;
     /**
-     * 
+     * Unique sequence for a Member
      * @type {string}
      * @memberof PremRate
      */
     'member_Seq'?: string | null;
     /**
-     * 
+     * Unique identifier for the Network
      * @type {string}
      * @memberof PremRate
      */
     'network_ID'?: string | null;
     /**
-     * 
+     * Type of Network
      * @type {string}
      * @memberof PremRate
      */
     'network_Type'?: string | null;
     /**
-     * 
+     * Flag that determines the Age based on the date of hire  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 PremRate
      */
     'new_Hire_Age': boolean;
     /**
-     * 
+     * PremRate_Key of the template rate this rate was created from
      * @type {number}
      * @memberof PremRate
      */
     'parent_PremRate_Key'?: number | null;
     /**
-     * 
+     * Unique identifier for the Plan
      * @type {string}
      * @memberof PremRate
      */
     'plan_ID'?: string | null;
     /**
-     * 
+     * Type of Plan
      * @type {string}
      * @memberof PremRate
      */
     'plan_Type'?: string | null;
     /**
-     * 
+     * Basis of the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'premRate_Basis'?: string | null;
     /**
-     * 
+     * Category of the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'premRate_Category'?: string | null;
     /**
-     * 
+     * Unique identifier for the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'premRate_ID'?: string | null;
     /**
-     * 
+     * Type of the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'premRate_Type'?: string | null;
     /**
-     * 
+     * Flag that determines if the rate is prorated
      * @type {boolean}
      * @memberof PremRate
      */
     'premium_Proration': boolean;
     /**
-     * 
+     * Decimal value that defines the base rate
      * @type {number}
      * @memberof PremRate
      */
     'rate'?: number | null;
     /**
-     * 
+     * Maximum the rate will be regardless of the calculation
      * @type {number}
      * @memberof PremRate
      */
     'rate_Max'?: number | null;
     /**
-     * 
+     * Minimum the rate will be regardless of the calculation
      * @type {number}
      * @memberof PremRate
      */
     'rate_Minimum'?: number | null;
     /**
-     * 
+     * How often the rate applies
      * @type {string}
      * @memberof PremRate
      */
     'rate_Pace'?: string | null;
     /**
-     * 
+     * The day the rate applies when the pace is weekly
      * @type {string}
      * @memberof PremRate
      */
     'rate_Pace_Type'?: string | null;
     /**
-     * 
+     * Precision that the rate is rounded to
      * @type {number}
      * @memberof PremRate
      */
     'rate_Round_Precision'?: number | null;
     /**
-     * 
+     * Type that determine how the rate is rounded
      * @type {string}
      * @memberof PremRate
      */
     'rate_Round_Type'?: string | null;
     /**
-     * 
+     * Type of Rate
      * @type {string}
      * @memberof PremRate
      */
     'rate_Type'?: string | null;
     /**
-     * 
+     * First variable used in calculating the rate based on the type
      * @type {number}
      * @memberof PremRate
      */
     'rate_Variable1'?: number | null;
     /**
-     * 
+     * Second variable used in calculating the rate based on the type
      * @type {number}
      * @memberof PremRate
      */
     'rate_Variable2'?: number | null;
     /**
-     * 
+     * Third variable used in calculating the rate based on the type
      * @type {number}
      * @memberof PremRate
      */
     'rate_Variable3'?: number | null;
     /**
-     * 
+     * Region Code of the Address used to determine if the rate applies
      * @type {string}
      * @memberof PremRate
      */
     'region_Code'?: string | null;
     /**
-     * 
+     * Relationship for the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'relationship'?: string | null;
     /**
-     * 
+     * Flag used to determine what Sex the rate applies to
      * @type {string}
      * @memberof PremRate
      */
     'sex'?: string | null;
     /**
-     * 
+     * Flag to determine if the rate applies to Smokers
      * @type {string}
      * @memberof PremRate
      */
     'smoker'?: string | null;
     /**
-     * 
+     * State of the Address used to determine if the rate applies
      * @type {string}
      * @memberof PremRate
      */
     'state'?: string | null;
     /**
-     * 
+     * Unique identifier for the Subscriber
      * @type {string}
      * @memberof PremRate
      */
     'subscriber_ID'?: string | null;
     /**
-     * 
+     * Term Date of the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'term_Date'?: string | null;
     /**
-     * 
+     * Tier of the PremRate
      * @type {string}
      * @memberof PremRate
      */
     'tier'?: string | null;
     /**
-     * 
+     * Date the record was last updated in the system
      * @type {string}
      * @memberof PremRate
      */
     'update_Date'?: string;
     /**
-     * 
+     * User that last updated the record in the system
      * @type {string}
      * @memberof PremRate
      */
     'update_User'?: string | null;
     /**
-     * 
+     * Beginning Zip Code of the Address used to determine if the rate applies
      * @type {string}
      * @memberof PremRate
      */
     'zip_Code_From'?: string | null;
     /**
-     * 
+     * Ending Zip Code of the Address used to determine if the rate applies
      * @type {string}
      * @memberof PremRate
      */

package/models/sub-enrollment-plan.ts

@@ -39,13 +39,13 @@ export interface SubEnrollmentPlan {
      */
     'division_ID': string;
     /**
-     * References the Subenrollment.Group_Coverage_Start value in the parent table.
+     * References the Subenrollment.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 SubEnrollmentPlan
      */
     'group_Coverage_Start': string;
     /**
-     * References the Subenrollment.Start_Date value in the parent table.
+     * References the Subenrollment.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 SubEnrollmentPlan
      */
@@ -57,7 +57,7 @@ export interface SubEnrollmentPlan {
      */
     'plan_ID': string;
     /**
-     * Start date of Plan coverage.
+     * Start date of Plan 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 SubEnrollmentPlan
      */
@@ -81,31 +81,31 @@ export interface SubEnrollmentPlan {
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Member elected Daily Benefit Amount
      * @type {number}
      * @memberof SubEnrollmentPlan
      */
     'ltC_Daily_Benefit_Amount'?: number | null;
     /**
-     * 
+     * Lifetime Max Amount elected
      * @type {number}
      * @memberof SubEnrollmentPlan
      */
     'ltC_Lifetime_Max_Amount'?: number | null;
     /**
-     * 
+     * Lifetime Max Days elected
      * @type {number}
      * @memberof SubEnrollmentPlan
      */
     'ltC_Lifetime_Max_Days'?: number | null;
     /**
-     * 
+     * Lifetime Max Years elected
      * @type {number}
      * @memberof SubEnrollmentPlan
      */
     'ltC_Lifetime_Max_Years'?: number | null;
     /**
-     * 
+     * Member elected Monthly Benefit Amount
      * @type {number}
      * @memberof SubEnrollmentPlan
      */
@@ -123,7 +123,7 @@ export interface SubEnrollmentPlan {
      */
     'plan_End'?: string | null;
     /**
-     * 
+     * This identifier the reason the plan was termed.
      * @type {number}
      * @memberof SubEnrollmentPlan
      */
@@ -147,7 +147,7 @@ export interface SubEnrollmentPlan {
      */
     'update_User'?: string | null;
     /**
-     * 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.
+     * 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.  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 SubEnrollmentPlan
      */