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

package/models/member-provider-alternate.ts

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

package/models/member-provider.ts

@@ -21,7 +21,7 @@
  */
 export interface MemberProvider {
     /**
-     * Unique identifier for each PCP record attached to this member.
+     * Unique identifier for each PCP record attached to this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof MemberProvider
      */
@@ -33,7 +33,7 @@ export interface MemberProvider {
      */
     'capitation_Category'?: string | null;
     /**
-     * Date when the Provider became the Member\'s PCP.
+     * Date when the Provider became the Member\'s PCP. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof MemberProvider
      */
@@ -44,6 +44,18 @@ export interface MemberProvider {
      * @memberof MemberProvider
      */
     'end_Date'?: string | null;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof MemberProvider
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof MemberProvider
+     */
+    'entry_User'?: string | null;
     /**
      * Information field used for custom reporting and interfaces.
      * @type {string}
@@ -74,5 +86,17 @@ export interface MemberProvider {
      * @memberof MemberProvider
      */
     'subscriber_ID': string;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof MemberProvider
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof MemberProvider
+     */
+    'update_User'?: string | null;
 }
 

package/models/member-tax.ts

@@ -21,7 +21,7 @@
  */
 export interface MemberTax {
     /**
-     * Unique identier for each Tax configuration on this Member.
+     * Unique identier for each Tax configuration on this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof MemberTax
      */
@@ -63,7 +63,19 @@ export interface MemberTax {
      */
     'effective_Thru'?: string | null;
     /**
-     * Member\'s exemptions as listed on the Member\'s tax documents.
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof MemberTax
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof MemberTax
+     */
+    'entry_User'?: string | null;
+    /**
+     * Member\'s exemptions as listed on the Member\'s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof MemberTax
      */
@@ -81,7 +93,7 @@ export interface MemberTax {
      */
     'extra_Withholding_Amt'?: number | null;
     /**
-     * Member\'s federal exemption status as listed on the Member\'s tax documents.
+     * Member\'s federal exemption status as listed on the Member\'s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTax
      */
@@ -135,7 +147,7 @@ export interface MemberTax {
      */
     'local_Tax_Code'?: string | null;
     /**
-     * Member\'s medicare exemption status as listed on the Member\'s tax documents.
+     * Member\'s medicare exemption status as listed on the Member\'s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTax
      */
@@ -171,23 +183,29 @@ export interface MemberTax {
      */
     'percentage_Election'?: number | null;
     /**
-     * Member\'s social security exemption status as listed on the Member\'s tax documents.
+     * Member\'s social security exemption status as listed on the Member\'s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTax
      */
     'socSec_Tax_Exempt': boolean;
     /**
-     * Member\'s election percentage at the state level as listed on the Member\'s tax documents.
+     * Member\'s election percentage at the state level as listed on the Member\'s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTax
      */
     'state_Percentage_Election': boolean;
     /**
-     * Member\'s tax exemption status as listed on the Member\'s tax documents.
+     * Member\'s tax exemption status as listed on the Member\'s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTax
      */
     'state_Tax_Exempt': boolean;
+    /**
+     * Holds a numeric value listed as withholding, used in conjunction with Tax Control.
+     * @type {number}
+     * @memberof MemberTax
+     */
+    'state_Withholding'?: number | null;
     /**
      * References Members.Subscriber_ID value on the parent record.
      * @type {string}
@@ -195,7 +213,7 @@ export interface MemberTax {
      */
     'subscriber_ID'?: string | null;
     /**
-     * Member\'s exemption status as listed on the Member\'s tax documents.
+     * Member\'s exemption status as listed on the Member\'s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTax
      */
@@ -207,13 +225,25 @@ export interface MemberTax {
      */
     'tips'?: number | null;
     /**
-     * Specifies that the associated W4 is from 2020.
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof MemberTax
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof MemberTax
+     */
+    'update_User'?: string | null;
+    /**
+     * Specifies that the associated W4 is from 2020. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTax
      */
     'w4_2020': boolean;
     /**
-     * Specifies whether Box C was checked according to the Member\'s tax documents.
+     * Specifies whether Box C was checked according to the Member\'s tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTax
      */

package/models/member-tooth-ex-code.ts

@@ -33,16 +33,40 @@ export interface MemberToothExCode {
      */
     'member_Seq': string;
     /**
-     * Identifies the number of the tooth/teeth that the User intends to apply an Ex Code to.
+     * Identifies the number of the tooth/teeth that the User intends to apply an Ex Code to. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof MemberToothExCode
      */
     'tooth_Number': number;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof MemberToothExCode
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof MemberToothExCode
+     */
+    'entry_User'?: string | null;
     /**
      * Idenfities the Ex Code that will be applied to the selected tooth/teeth.
      * @type {string}
      * @memberof MemberToothExCode
      */
     'ex_Code': string;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof MemberToothExCode
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof MemberToothExCode
+     */
+    'update_User'?: string | null;
 }
 

package/models/member-tooth.ts

@@ -21,17 +21,29 @@
  */
 export interface MemberTooth {
     /**
-     * Unique identifier for each Tooth tracking record on this member.
+     * Unique identifier for each Tooth tracking record on this member. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof MemberTooth
      */
     'memberTooth_Key': number;
     /**
-     * Identifies that the information was automatically entered based upon claim information.
+     * Identifies that the information was automatically entered based upon claim information. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTooth
      */
     'claim_Entered': boolean;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof MemberTooth
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof MemberTooth
+     */
+    'entry_User'?: string | null;
     /**
      * References Members.Member_Seq value on the parent record.
      * @type {string}
@@ -45,7 +57,7 @@ export interface MemberTooth {
      */
     'subscriber_ID': string;
     /**
-     * Identifies the number of the tooth/teeth that the User intends to change the status of. Teeth may also be selected using one of the group buttons such as Right, left; molars, incisors; upper, lower; etc.
+     * Identifies the number of the tooth/teeth that the User intends to change the status of. Teeth may also be selected using one of the group buttons such as Right, left; molars, incisors; upper, lower; etc. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof MemberTooth
      */
@@ -57,7 +69,19 @@ export interface MemberTooth {
      */
     'tooth_Status'?: string | null;
     /**
-     * Idenfities that the information was manually entered by a User.
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof MemberTooth
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof MemberTooth
+     */
+    'update_User'?: string | null;
+    /**
+     * Idenfities that the information was manually entered by a User. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof MemberTooth
      */

package/models/member-vbaplan-type-id.ts

@@ -38,6 +38,30 @@ export interface MemberVBAPlanTypeID {
      * @memberof MemberVBAPlanTypeID
      */
     'vbA_Plan_Type': string;
+    /**
+     * Date when the record was first added to the system.
+     * @type {string}
+     * @memberof MemberVBAPlanTypeID
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system.
+     * @type {string}
+     * @memberof MemberVBAPlanTypeID
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date when the record was last updated in the system.
+     * @type {string}
+     * @memberof MemberVBAPlanTypeID
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system.
+     * @type {string}
+     * @memberof MemberVBAPlanTypeID
+     */
+    'update_User'?: string | null;
     /**
      * Member\'s alternate ID for the associated plan type.
      * @type {string}

package/models/mfadevice-setup-request.ts

@@ -0,0 +1,30 @@
+/* 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 MFADeviceSetupRequest
+ */
+export interface MFADeviceSetupRequest {
+    /**
+     * A valid access token issued to the user whose MFA Device you want to set-up.
+     * @type {string}
+     * @memberof MFADeviceSetupRequest
+     */
+    'accessToken'?: string | null;
+}
+

package/models/mfadevice-setup-response-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 { MFADeviceSetupResponse } from './mfadevice-setup-response';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface MFADeviceSetupResponseVBAResponse
+ */
+export interface MFADeviceSetupResponseVBAResponse {
+    /**
+     * 
+     * @type {MFADeviceSetupResponse}
+     * @memberof MFADeviceSetupResponseVBAResponse
+     */
+    'data'?: MFADeviceSetupResponse;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof MFADeviceSetupResponseVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof MFADeviceSetupResponseVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/mfadevice-setup-response.ts

@@ -0,0 +1,36 @@
+/* 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 MFADeviceSetupResponse
+ */
+export interface MFADeviceSetupResponse {
+    /**
+     * A Base64-encoded string representing the QR code image generated from the secret code.  Can be used for setting up multi-factor authentication with an authenticator app.
+     * @type {string}
+     * @memberof MFADeviceSetupResponse
+     */
+    'qrCode'?: string | null;
+    /**
+     * A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.
+     * @type {string}
+     * @memberof MFADeviceSetupResponse
+     */
+    'secretCode'?: string | null;
+}
+

package/models/network-procedure-cluster.ts

@@ -33,25 +33,25 @@ export interface NetworkProcedureCluster {
      */
     'procedure_Cluster': string;
     /**
-     * Date when the pricing rule becomes/became effective.  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.
+     * Date when the pricing rule becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof NetworkProcedureCluster
      */
     'effective_Date': string;
     /**
-     * 
+     * Used with the pricing claimrule, sets a value for the allowed amount to a percentage of the billed amount during adjudication. Subsequent claimrules may affect pricing.
      * @type {number}
      * @memberof NetworkProcedureCluster
      */
     'bill_Percent'?: number | null;
     /**
-     * 
+     * Defines what type of claims the Network Procedure Cluster applies to
      * @type {string}
      * @memberof NetworkProcedureCluster
      */
     'claim_Type'?: string | null;
     /**
-     * This option tells the pricing rule to reference pricing received from Context4. If this is unchecked, it allows the User to have the functionality without the Context4 hook.  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.
+     * This option tells the pricing rule to reference pricing received from Context4. If this is unchecked, it allows the User to have the functionality without the Context4 hook. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof NetworkProcedureCluster
      */
@@ -75,7 +75,7 @@ export interface NetworkProcedureCluster {
      */
     'fee_Percent'?: number | null;
     /**
-     * 
+     * Used with the pricing claimrule, sets a value for the allowed amount during adjudication. Subsequent claimrules may affect pricing.
      * @type {number}
      * @memberof NetworkProcedureCluster
      */

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

package/models/network-profile-assign-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 { NetworkProfileAssign } from './network-profile-assign';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface NetworkProfileAssignVBAResponse
+ */
+export interface NetworkProfileAssignVBAResponse {
+    /**
+     * 
+     * @type {NetworkProfileAssign}
+     * @memberof NetworkProfileAssignVBAResponse
+     */
+    'data'?: NetworkProfileAssign;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof NetworkProfileAssignVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof NetworkProfileAssignVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/network-profile-assign.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 NetworkProfileAssign
+ */
+export interface NetworkProfileAssign {
+    /**
+     * Unique idenfitier assigned to the Network Profile record.
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'profile_ID': string;
+    /**
+     * Defines the type of record match used by the assignment.  Supports Provider_ID, Profile_Provider_ID, or Federal_ID
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'assign_Type': string;
+    /**
+     * Holds ID value used in conjunction with the Assign_Type to define the desired provider match.
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'assign_ID': string;
+    /**
+     * Date when the Network Profile becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'effective_Date': string;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date when the Network Profile no longer applies.
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'term_Date'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof NetworkProfileAssign
+     */
+    'update_User'?: string | null;
+}
+