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

package/models/search-request.ts

@@ -13,6 +13,7 @@
  */
 
 
+import { CriteriaDetail } from './criteria-detail';
 import { SelectedField } from './selected-field';
 
 /**
@@ -35,6 +36,36 @@ export interface SearchRequest {
     'searchConfigId': string;
     /**
      * Fields to return in the search results.  These must be a subset of the SearchConfig Fields.
+     * @type {string}
+     * @memberof SearchRequest
+     */
+    'user_ID'?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof SearchRequest
+     */
+    'page'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof SearchRequest
+     */
+    'pageCount'?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SearchRequest
+     */
+    'include_Result_Details'?: boolean | null;
+    /**
+     * 
+     * @type {Array<CriteriaDetail>}
+     * @memberof SearchRequest
+     */
+    'criterias'?: Array<CriteriaDetail> | null;
+    /**
+     * 
      * @type {Array<SelectedField>}
      * @memberof SearchRequest
      */

package/models/smsdto.ts

@@ -0,0 +1,67 @@
+/* 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 { CallbackDTO } from './callback-dto';
+
+/**
+ * 
+ * @export
+ * @interface SMSDTO
+ */
+export interface SMSDTO {
+    /**
+     * Activity ID that spawned this
+     * @type {string}
+     * @memberof SMSDTO
+     */
+    'parentActivityId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SMSDTO
+     */
+    'when'?: string | null;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof SMSDTO
+     */
+    'onSuccess'?: CallbackDTO;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof SMSDTO
+     */
+    'onFailure'?: CallbackDTO;
+    /**
+     * The 3 chatacter ID for the Client to bill for the message
+     * @type {string}
+     * @memberof SMSDTO
+     */
+    'senderClientId'?: string | null;
+    /**
+     * The number to send the SMS
+     * @type {string}
+     * @memberof SMSDTO
+     */
+    'toNumber'?: string | null;
+    /**
+     * The content of the SMS
+     * @type {string}
+     * @memberof SMSDTO
+     */
+    'content'?: string | null;
+}
+

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

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

package/models/ssoconfig.ts

@@ -0,0 +1,84 @@
+/* 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 SSOConfig
+ */
+export interface SSOConfig {
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'ssoConfig_ID': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'auth_URL'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'client_ID'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'client_Secret'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'description'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'display'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'provider_Name'?: 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.
+     * @type {boolean}
+     * @memberof SSOConfig
+     */
+    'ssO_Enable': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'scopes'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'token_URL'?: string | null;
+}
+

package/models/users.ts

@@ -93,7 +93,7 @@ export interface Users {
      */
     'country_ID'?: string | null;
     /**
-     * Email address of the User.
+     * 
      * @type {string}
      * @memberof Users
      */
@@ -146,6 +146,12 @@ export interface Users {
      * @memberof Users
      */
     'iD_Card_Notification': boolean;
+    /**
+     * 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
+     */
+    'is_SSO_User': boolean;
     /**
      * Identifies the machine on which the User is logged in.
      * @type {string}
@@ -212,6 +218,12 @@ export interface Users {
      * @memberof Users
      */
     'phone_Country_Code'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Users
+     */
+    'ssO_User_Name'?: string | null;
     /**
      * 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}

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

package/models/vbaclient-environment.ts

@@ -0,0 +1,37 @@
+/* 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 { VBASSOLoginConfig } from './vbassologin-config';
+
+/**
+ * 
+ * @export
+ * @interface VBAClientEnvironment
+ */
+export interface VBAClientEnvironment {
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAClientEnvironment
+     */
+    'databaseName'?: string | null;
+    /**
+     * 
+     * @type {Array<VBASSOLoginConfig>}
+     * @memberof VBAClientEnvironment
+     */
+    'ssoConfigs'?: Array<VBASSOLoginConfig> | null;
+}
+

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

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

package/models/vbaclient.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 { DatabaseConnection } from './database-connection';
+
+/**
+ * 
+ * @export
+ * @interface VBAClient
+ */
+export interface VBAClient {
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAClient
+     */
+    'id'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAClient
+     */
+    'name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAClient
+     */
+    'clientId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAClient
+     */
+    'clientCode'?: string | null;
+    /**
+     * 
+     * @type {Array<DatabaseConnection>}
+     * @memberof VBAClient
+     */
+    'databaseConnections'?: Array<DatabaseConnection> | null;
+}
+

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

package/models/vbareport.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 VBAReport
+ */
+export interface VBAReport {
+    /**
+     * 
+     * @type {number}
+     * @memberof VBAReport
+     */
+    'reportDefinition_Key'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAReport
+     */
+    'report_ID'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAReport
+     */
+    'report_Name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAReport
+     */
+    'report_Category'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAReport
+     */
+    'report_Description'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof VBAReport
+     */
+    'embed_Url'?: string | null;
+}
+

package/models/vbassologin-config.ts

@@ -0,0 +1,42 @@
+/* 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 VBASSOLoginConfig
+ */
+export interface VBASSOLoginConfig {
+    /**
+     * Name of the SSO connection client.
+     * @type {string}
+     * @memberof VBASSOLoginConfig
+     */
+    'name'?: string | null;
+    /**
+     * Description of this SSO connection.
+     * @type {string}
+     * @memberof VBASSOLoginConfig
+     */
+    'description'?: string | null;
+    /**
+     * The URL used to login to the client\'s SSO instance
+     * @type {string}
+     * @memberof VBASSOLoginConfig
+     */
+    'login_URL'?: string | null;
+}
+