yellowgrid-api-ts 3.2.289 → 3.2.291

package/dist/api.d.ts

@@ -1299,6 +1299,9 @@ export declare const AuditLogEntityTypeEnum: {
     readonly Pops3cxBackup: "pops_3cx_backup";
     readonly Pops3cxBilling: "pops_3cx_billing";
     readonly PopsDeadLicences: "pops_dead_licences";
+    readonly Pops3cxEngineering: "pops_3cx_engineering";
+    readonly Pops3cxEngineerTaskDefinitions: "pops_3cx_engineer_task_definitions";
+    readonly Pops3cxEngineerTasks: "pops_3cx_engineer_tasks";
     readonly Pops3cxExts: "pops_3cx_exts";
     readonly PopsHostingPricing: "pops_hosting_pricing";
     readonly Pops3cxKeys: "pops_3cx_keys";
@@ -3070,6 +3073,23 @@ export interface EmailRequestModel {
      */
     'email': string;
 }
+/**
+ * Engineered Wizard Request
+ */
+export interface EngineeredWizardRequestModel {
+    /**
+     * Customer Name
+     */
+    'customer': string;
+    /**
+     * Engineer ID
+     */
+    'engineerId': number;
+    /**
+     * Licence Key
+     */
+    'licenceKey': string;
+}
 /**
  * Service Event DTO
  */
@@ -9488,6 +9508,72 @@ export interface TcxDeadLicenceEntity {
      */
     'date': string;
 }
+/**
+ * 3CX Engineer Task
+ */
+export interface TcxEngineerTaskDTO {
+    /**
+     * Task ID
+     */
+    'taskId': number;
+    /**
+     * Title
+     */
+    'title': string;
+    /**
+     * Description
+     */
+    'description': string;
+    /**
+     * Completion Status
+     */
+    'complete': boolean;
+    /**
+     * Note
+     */
+    'note': string;
+}
+/**
+ * 3CX Engineering
+ */
+export interface TcxEngineeringDTO {
+    /**
+     * Engineering ID
+     */
+    'id': number;
+    /**
+     * Wizard ID
+     */
+    'wizardId': number;
+    /**
+     * Engineer ID
+     */
+    'engineerId': number;
+    /**
+     * Engineer Name
+     */
+    'engineerName': string;
+    /**
+     * Ticket URL
+     */
+    'ticketUrl': string;
+    /**
+     * Date Time
+     */
+    'goLiveDate'?: string | null;
+    /**
+     * Spec
+     */
+    'spec'?: string | null;
+    /**
+     * Note
+     */
+    'note'?: string | null;
+    /**
+     * Tasks
+     */
+    'tasks': Array<TcxEngineerTaskDTO>;
+}
 /**
  * 3CX Wizard Extension
  */
@@ -10479,6 +10565,19 @@ export interface TcxSipTrunksEntity {
      */
     'ipAddress'?: string | null;
 }
+/**
+ * 3CX Wizard Summary
+ */
+export interface TcxSummaryDTO {
+    /**
+     * Wizard ID
+     */
+    'id': number;
+    /**
+     * Licence Key
+     */
+    'licenceKey': string;
+}
 /**
  * 3CX Template
  */
@@ -10556,6 +10655,7 @@ export interface TcxWizardModel {
     'sbcs'?: Array<TcxSbcModel> | null;
     'sipTrunk'?: TcxSipTrunksEntity | null;
     'installationStatus'?: TcxWizardModelInstallationStatusEnum | null;
+    'engineering'?: TcxEngineeringDTO | null;
     'setup'?: TcxSetupEntity | null;
     /**
      * End User Wizard View
@@ -15335,6 +15435,13 @@ export declare const Class3CXInstallationWizardApiAxiosParamCreator: (configurat
      * @throws {RequiredError}
      */
     patchAddSbcs: (tcxSbcModel?: Array<TcxSbcModel>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Allocate Wizard Engineer
+     * @param {number} engineerId Engineer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchAllocateEngineer: (engineerId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update 3CX Installation Wizard
      * @summary Update 3CX Installation Wizard
@@ -15343,6 +15450,43 @@ export declare const Class3CXInstallationWizardApiAxiosParamCreator: (configurat
      * @throws {RequiredError}
      */
     patchGetWizard: (tcxWizardModel?: TcxWizardModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update Wizard Engineer Task Complete Status
+     * @param {number} taskId Task ID
+     * @param {PatchMarkEngineerTaskAsCompleteCompleteEnum} complete Complete Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMarkEngineerTaskAsComplete: (taskId: number, complete: PatchMarkEngineerTaskAsCompleteCompleteEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update Wizard Engineer Task Note
+     * @param {number} taskId Task ID
+     * @param {string} note note
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateEngineerTaskNote: (taskId: number, note: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update Wizard Go Live Date
+     * @param {string} goLiveDate Go Live Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateGoLiveDate: (goLiveDate: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update Wizard Engineer Note
+     * @param {string} note Note
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateNote: (note: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update Wizard Engineer Spec
+     * @param {string} spec Spec
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateSpec: (spec: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Add Extensions To 3CX Installation Wizard
      * @summary Add Extensions To 3CX Installation Wizard
@@ -15623,6 +15767,13 @@ export declare const Class3CXInstallationWizardApiFp: (configuration?: Configura
      * @throws {RequiredError}
      */
     patchAddSbcs(tcxSbcModel?: Array<TcxSbcModel>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxSbcModel>>>;
+    /**
+     * Allocate Wizard Engineer
+     * @param {number} engineerId Engineer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchAllocateEngineer(engineerId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Update 3CX Installation Wizard
      * @summary Update 3CX Installation Wizard
@@ -15631,6 +15782,43 @@ export declare const Class3CXInstallationWizardApiFp: (configuration?: Configura
      * @throws {RequiredError}
      */
     patchGetWizard(tcxWizardModel?: TcxWizardModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxWizardModel>>;
+    /**
+     * Update Wizard Engineer Task Complete Status
+     * @param {number} taskId Task ID
+     * @param {PatchMarkEngineerTaskAsCompleteCompleteEnum} complete Complete Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMarkEngineerTaskAsComplete(taskId: number, complete: PatchMarkEngineerTaskAsCompleteCompleteEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Update Wizard Engineer Task Note
+     * @param {number} taskId Task ID
+     * @param {string} note note
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateEngineerTaskNote(taskId: number, note: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Update Wizard Go Live Date
+     * @param {string} goLiveDate Go Live Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateGoLiveDate(goLiveDate: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Update Wizard Engineer Note
+     * @param {string} note Note
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateNote(note: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Update Wizard Engineer Spec
+     * @param {string} spec Spec
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateSpec(spec: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Add Extensions To 3CX Installation Wizard
      * @summary Add Extensions To 3CX Installation Wizard
@@ -15911,6 +16099,13 @@ export declare const Class3CXInstallationWizardApiFactory: (configuration?: Conf
      * @throws {RequiredError}
      */
     patchAddSbcs(tcxSbcModel?: Array<TcxSbcModel>, options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxSbcModel>>;
+    /**
+     * Allocate Wizard Engineer
+     * @param {number} engineerId Engineer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchAllocateEngineer(engineerId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Update 3CX Installation Wizard
      * @summary Update 3CX Installation Wizard
@@ -15919,6 +16114,43 @@ export declare const Class3CXInstallationWizardApiFactory: (configuration?: Conf
      * @throws {RequiredError}
      */
     patchGetWizard(tcxWizardModel?: TcxWizardModel, options?: RawAxiosRequestConfig): AxiosPromise<TcxWizardModel>;
+    /**
+     * Update Wizard Engineer Task Complete Status
+     * @param {number} taskId Task ID
+     * @param {PatchMarkEngineerTaskAsCompleteCompleteEnum} complete Complete Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMarkEngineerTaskAsComplete(taskId: number, complete: PatchMarkEngineerTaskAsCompleteCompleteEnum, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Update Wizard Engineer Task Note
+     * @param {number} taskId Task ID
+     * @param {string} note note
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateEngineerTaskNote(taskId: number, note: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Update Wizard Go Live Date
+     * @param {string} goLiveDate Go Live Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateGoLiveDate(goLiveDate: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Update Wizard Engineer Note
+     * @param {string} note Note
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateNote(note: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Update Wizard Engineer Spec
+     * @param {string} spec Spec
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateSpec(spec: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Add Extensions To 3CX Installation Wizard
      * @summary Add Extensions To 3CX Installation Wizard
@@ -16199,6 +16431,13 @@ export declare class Class3CXInstallationWizardApi extends BaseAPI {
      * @throws {RequiredError}
      */
     patchAddSbcs(tcxSbcModel?: Array<TcxSbcModel>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxSbcModel[], any, {}>>;
+    /**
+     * Allocate Wizard Engineer
+     * @param {number} engineerId Engineer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchAllocateEngineer(engineerId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Update 3CX Installation Wizard
      * @summary Update 3CX Installation Wizard
@@ -16207,6 +16446,43 @@ export declare class Class3CXInstallationWizardApi extends BaseAPI {
      * @throws {RequiredError}
      */
     patchGetWizard(tcxWizardModel?: TcxWizardModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxWizardModel, any, {}>>;
+    /**
+     * Update Wizard Engineer Task Complete Status
+     * @param {number} taskId Task ID
+     * @param {PatchMarkEngineerTaskAsCompleteCompleteEnum} complete Complete Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchMarkEngineerTaskAsComplete(taskId: number, complete: PatchMarkEngineerTaskAsCompleteCompleteEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Update Wizard Engineer Task Note
+     * @param {number} taskId Task ID
+     * @param {string} note note
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateEngineerTaskNote(taskId: number, note: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Update Wizard Go Live Date
+     * @param {string} goLiveDate Go Live Date
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateGoLiveDate(goLiveDate: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Update Wizard Engineer Note
+     * @param {string} note Note
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateNote(note: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Update Wizard Engineer Spec
+     * @param {string} spec Spec
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateSpec(spec: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Add Extensions To 3CX Installation Wizard
      * @summary Add Extensions To 3CX Installation Wizard
@@ -16318,6 +16594,11 @@ export declare class Class3CXInstallationWizardApi extends BaseAPI {
      */
     postUploadBackup(backup: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxBackupModel, any, {}>>;
 }
+export declare const PatchMarkEngineerTaskAsCompleteCompleteEnum: {
+    readonly True: "true";
+    readonly False: "false";
+};
+export type PatchMarkEngineerTaskAsCompleteCompleteEnum = typeof PatchMarkEngineerTaskAsCompleteCompleteEnum[keyof typeof PatchMarkEngineerTaskAsCompleteCompleteEnum];
 /**
  * Class3CXInstallationsApi - axios parameter creator
  */
@@ -18596,6 +18877,7 @@ export declare const PostAccessTokenScopeEnum: {
 export type PostAccessTokenScopeEnum = typeof PostAccessTokenScopeEnum[keyof typeof PostAccessTokenScopeEnum];
 export declare const PostAccessTokenTokenExchangeTypeEnum: {
     readonly TcxWizard: "tcx_wizard";
+    readonly TcxWizardAdmin: "tcx_wizard_admin";
     readonly Portal: "portal";
 };
 export type PostAccessTokenTokenExchangeTypeEnum = typeof PostAccessTokenTokenExchangeTypeEnum[keyof typeof PostAccessTokenTokenExchangeTypeEnum];
@@ -18799,6 +19081,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     postCreateShipment: (id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create Engineered Wizard
+     * @param {number} id Order ID
+     * @param {EngineeredWizardRequestModel} [engineeredWizardRequestModel] Engineered Wizard Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateWizardFromOrder: (id: number, engineeredWizardRequestModel?: EngineeredWizardRequestModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create An Order (Beta)
      * @summary Create An Order (Beta)
@@ -19101,6 +19391,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentDTO>>;
+    /**
+     * Create Engineered Wizard
+     * @param {number} id Order ID
+     * @param {EngineeredWizardRequestModel} [engineeredWizardRequestModel] Engineered Wizard Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateWizardFromOrder(id: number, engineeredWizardRequestModel?: EngineeredWizardRequestModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxSummaryDTO>>;
     /**
      * Create An Order (Beta)
      * @summary Create An Order (Beta)
@@ -19403,6 +19701,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentDTO>;
+    /**
+     * Create Engineered Wizard
+     * @param {number} id Order ID
+     * @param {EngineeredWizardRequestModel} [engineeredWizardRequestModel] Engineered Wizard Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateWizardFromOrder(id: number, engineeredWizardRequestModel?: EngineeredWizardRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<TcxSummaryDTO>;
     /**
      * Create An Order (Beta)
      * @summary Create An Order (Beta)
@@ -19705,6 +20011,14 @@ export declare class OrdersApi extends BaseAPI {
      * @throws {RequiredError}
      */
     postCreateShipment(id: number, batchId: number, shipmentRequestDTO?: ShipmentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShipmentDTO, any, {}>>;
+    /**
+     * Create Engineered Wizard
+     * @param {number} id Order ID
+     * @param {EngineeredWizardRequestModel} [engineeredWizardRequestModel] Engineered Wizard Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateWizardFromOrder(id: number, engineeredWizardRequestModel?: EngineeredWizardRequestModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxSummaryDTO, any, {}>>;
     /**
      * Create An Order (Beta)
      * @summary Create An Order (Beta)