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

package/models/callback-dto.ts

@@ -0,0 +1,43 @@
+/* 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 { JsonValue } from './json-value';
+
+/**
+ * 
+ * @export
+ * @interface CallbackDTO
+ */
+export interface CallbackDTO {
+    /**
+     * The HTTP Verb (eg: GET, PUT, POST, DELETE)
+     * @type {string}
+     * @memberof CallbackDTO
+     */
+    'verb'?: string | null;
+    /**
+     * The fully-qualified URL to call using the Verb
+     * @type {string}
+     * @memberof CallbackDTO
+     */
+    'url'?: string | null;
+    /**
+     * The serialized payload to send to the URL using the Verb and Headers
+     * @type {{ [key: string]: JsonValue; }}
+     * @memberof CallbackDTO
+     */
+    'payload'?: { [key: string]: JsonValue; } | null;
+}
+

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

package/models/care-case-clinical-trial-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 { CareCaseClinicalTrial } from './care-case-clinical-trial';
+import { Debug } from './debug';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface CareCaseClinicalTrialVBAResponse
+ */
+export interface CareCaseClinicalTrialVBAResponse {
+    /**
+     * 
+     * @type {CareCaseClinicalTrial}
+     * @memberof CareCaseClinicalTrialVBAResponse
+     */
+    'data'?: CareCaseClinicalTrial;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof CareCaseClinicalTrialVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof CareCaseClinicalTrialVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/care-case-clinical-trial.ts

@@ -0,0 +1,132 @@
+/* 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 CareCaseClinicalTrial
+ */
+export interface CareCaseClinicalTrial {
+    /**
+     * Identifier for the Clinical Trial  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 CareCaseClinicalTrial
+     */
+    'careCaseClinicalTrial_Key': number;
+    /**
+     * User Managed field that ties to the Clinical Trial Arm in the system
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'careCaseClinicalTrialArm_ID'?: string | null;
+    /**
+     * User Managed field that ties to the Clinical Trial Reason in the system.
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'careCaseClinicalTrialReason_ID'?: string | null;
+    /**
+     * User Managed field that ties to the Study Phase in the system
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'careCaseClinicalTrialStudyPhase_ID'?: string | null;
+    /**
+     * Identifier of the case.
+     * @type {number}
+     * @memberof CareCaseClinicalTrial
+     */
+    'case_Key'?: number | null;
+    /**
+     * User Managed field that displays the Comment of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'comment'?: string | null;
+    /**
+     * User Managed field that displays the Disease of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'disease'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'entry_User'?: string | null;
+    /**
+     * User Managed field that displays the Inclusion Exclusion of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'inclusionExclusion'?: string | null;
+    /**
+     * User Managed field that displays the Location of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'location'?: string | null;
+    /**
+     * User Managed field that displays the Protocol Number of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'protocol_Number'?: string | null;
+    /**
+     * User Managed field that displays the Study Drug of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'study_Drug'?: string | null;
+    /**
+     * User Managed field that displays the Study Length of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'study_Length'?: string | null;
+    /**
+     * User Managed field that displays the Study Title of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'study_Title'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'update_User'?: string | null;
+    /**
+     * User Managed field that displays the Website of this Clinical Trial
+     * @type {string}
+     * @memberof CareCaseClinicalTrial
+     */
+    'website'?: string | null;
+}
+

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

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

package/models/case-attachment.ts

@@ -0,0 +1,90 @@
+/* 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 CaseAttachment
+ */
+export interface CaseAttachment {
+    /**
+     * Identifier for the Case Attachment  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 CaseAttachment
+     */
+    'caseAttachment_Key': number;
+    /**
+     * Where the Attachment is stored within the database
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'attachment'?: string | null;
+    /**
+     * the File Name for the Case Attachment
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'attachment_File'?: string | null;
+    /**
+     * The Path for the Case Attachment
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'attachment_Path'?: string | null;
+    /**
+     * What type of Attachment this is
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'caseAttachment_Type'?: string | null;
+    /**
+     * Identifier of the case. This is the Case that has the attachment  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 CaseAttachment
+     */
+    'case_Key': number;
+    /**
+     * User Managed field that displays the Comment for this Attachment
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'comment'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof CaseAttachment
+     */
+    'update_User'?: string | null;
+}
+

package/models/company-data.ts

@@ -212,6 +212,30 @@ export interface CompanyData {
      * @memberof CompanyData
      */
     'auto_Term_Plan_On_Gateway_Request': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompanyData
+     */
+    'bR_Domain_Name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompanyData
+     */
+    'bR_Site_Name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompanyData
+     */
+    'bR_Site_Secret'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CompanyData
+     */
+    'bR_Site_User'?: string | null;
     /**
      * Whether or not BaseLoad is turned on
      * @type {boolean}

package/models/database-connection.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 DatabaseConnection
+ */
+export interface DatabaseConnection {
+    /**
+     * 
+     * @type {string}
+     * @memberof DatabaseConnection
+     */
+    'databaseName'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DatabaseConnection
+     */
+    'connectionString'?: string | null;
+}
+

package/models/email-report-dto.ts

@@ -0,0 +1,103 @@
+/* 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 EmailReportDTO
+ */
+export interface EmailReportDTO {
+    /**
+     * Activity ID that spawned this
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'parentActivityId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'when'?: string | null;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof EmailReportDTO
+     */
+    'onSuccess'?: CallbackDTO;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof EmailReportDTO
+     */
+    'onFailure'?: CallbackDTO;
+    /**
+     * ID of the Report
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'reportId'?: string | null;
+    /**
+     * Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'exportType'?: string | null;
+    /**
+     * Client specific Site ID within the report server.   This is typically their Client ID, but may be different based on client needs.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'siteId'?: string | null;
+    /**
+     * Filename of the report.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'filename'?: string | null;
+    /**
+     * An object of report parameters  Required if a report requires them.
+     * @type {{ [key: string]: string; }}
+     * @memberof EmailReportDTO
+     */
+    'reportParameters'?: { [key: string]: string; } | null;
+    /**
+     * The sender of the email containing the report. This should be a valid email address.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'from'?: string | null;
+    /**
+     * All recipients of the email containing the report. Each entry should be a valid email address.
+     * @type {Array<string>}
+     * @memberof EmailReportDTO
+     */
+    'recipients'?: Array<string> | null;
+    /**
+     * Subject of the email for the report.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'subject'?: string | null;
+    /**
+     * Body content of the email for the report.
+     * @type {string}
+     * @memberof EmailReportDTO
+     */
+    'body'?: string | null;
+}
+

package/models/fax-report-dto.ts

@@ -0,0 +1,85 @@
+/* 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 FaxReportDTO
+ */
+export interface FaxReportDTO {
+    /**
+     * Activity ID that spawned this
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'parentActivityId'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'when'?: string | null;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof FaxReportDTO
+     */
+    'onSuccess'?: CallbackDTO;
+    /**
+     * 
+     * @type {CallbackDTO}
+     * @memberof FaxReportDTO
+     */
+    'onFailure'?: CallbackDTO;
+    /**
+     * ID of the Report
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'reportId'?: string | null;
+    /**
+     * Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'exportType'?: string | null;
+    /**
+     * Client specific Site ID within the report server.   This is typically their Client ID, but may be different based on client needs.
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'siteId'?: string | null;
+    /**
+     * Filename of the report.
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'filename'?: string | null;
+    /**
+     * A json object of report parameters  Required if a report requires them.
+     * @type {{ [key: string]: string; }}
+     * @memberof FaxReportDTO
+     */
+    'reportParameters'?: { [key: string]: string; } | null;
+    /**
+     * Fax destination
+     * @type {string}
+     * @memberof FaxReportDTO
+     */
+    'faxNumber'?: string | null;
+}
+