@product-live/api-sdk 2.4.1 → 2.8.1

package/servers.ts

@@ -0,0 +1,55 @@
+import { RequestContext, HttpMethod } from "./http/http";
+
+export interface BaseServerConfiguration {
+    makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext;
+}
+
+/**
+ *
+ * Represents the configuration of a server including its
+ * url template and variable configuration based on the url.
+ *
+ */
+export class ServerConfiguration<T extends { [key: string]: string }> implements BaseServerConfiguration {
+    public constructor(private url: string, private variableConfiguration: T) {}
+
+    /**
+     * Sets the value of the variables of this server. Variables are included in 
+     * the `url` of this ServerConfiguration in the form `{variableName}`
+     *
+     * @param variableConfiguration a partial variable configuration for the 
+     * variables contained in the url
+     */
+    public setVariables(variableConfiguration: Partial<T>) {
+        Object.assign(this.variableConfiguration, variableConfiguration);
+    }
+
+    public getConfiguration(): T {
+        return this.variableConfiguration
+    }
+
+    private getUrl() {
+        let replacedUrl = this.url;
+        for (const key in this.variableConfiguration) {
+            var re = new RegExp("{" + key + "}","g");
+            replacedUrl = replacedUrl.replace(re, this.variableConfiguration[key]);
+        }
+        return replacedUrl
+    }
+
+    /**
+     * Creates a new request context for this server using the url with variables
+     * replaced with their respective values and the endpoint of the request appended.
+     *
+     * @param endpoint the endpoint to be queried on the server
+     * @param httpMethod httpMethod to be used
+     *
+     */
+    public makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext {
+        return new RequestContext(this.getUrl() + endpoint, httpMethod);
+    }
+}
+
+export const server1 = new ServerConfiguration<{  }>("", {  })
+
+export const servers = [server1];

package/types/ObjectParamAPI.ts

@@ -0,0 +1,580 @@
+import { ResponseContext, RequestContext, HttpFile } from '../http/http';
+import { Configuration} from '../configuration'
+
+import { CreateJobDto } from '../models/CreateJobDto';
+import { CreateJobExecutionDto } from '../models/CreateJobExecutionDto';
+import { CreateTaskDto } from '../models/CreateTaskDto';
+import { CreateVariableDto } from '../models/CreateVariableDto';
+import { FileDto } from '../models/FileDto';
+import { FindVariablesRequest } from '../models/FindVariablesRequest';
+import { GetFiles200Response } from '../models/GetFiles200Response';
+import { GetJobExecutionById400Response } from '../models/GetJobExecutionById400Response';
+import { GetJobExecutions200Response } from '../models/GetJobExecutions200Response';
+import { GetJobs200Response } from '../models/GetJobs200Response';
+import { GetTasks200Response } from '../models/GetTasks200Response';
+import { GetVariables200Response } from '../models/GetVariables200Response';
+import { HighOrderQuery } from '../models/HighOrderQuery';
+import { JobDto } from '../models/JobDto';
+import { JobExecutionDto } from '../models/JobExecutionDto';
+import { LowOrderQuery } from '../models/LowOrderQuery';
+import { LowOrderQueryValue } from '../models/LowOrderQueryValue';
+import { PatchTaskExecutionDto } from '../models/PatchTaskExecutionDto';
+import { Query } from '../models/Query';
+import { TaskDto } from '../models/TaskDto';
+import { TaskExecutionDto } from '../models/TaskExecutionDto';
+import { UpdateJobDto } from '../models/UpdateJobDto';
+import { UpdateTaskDto } from '../models/UpdateTaskDto';
+import { UpdateVariableDto } from '../models/UpdateVariableDto';
+import { VariableDto } from '../models/VariableDto';
+
+import { ObservableDataFactoryFileApi } from "./ObservableAPI";
+import { DataFactoryFileApiRequestFactory, DataFactoryFileApiResponseProcessor} from "../apis/DataFactoryFileApi";
+
+export interface DataFactoryFileApiGetFileByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof DataFactoryFileApigetFileById
+     */
+    id: string
+}
+
+export interface DataFactoryFileApiGetFilesRequest {
+    /**
+     * 
+     * @type number
+     * @memberof DataFactoryFileApigetFiles
+     */
+    size?: number
+    /**
+     * 
+     * @type number
+     * @memberof DataFactoryFileApigetFiles
+     */
+    page?: number
+}
+
+export interface DataFactoryFileApiUploadFileRequest {
+    /**
+     * 
+     * @type HttpFile
+     * @memberof DataFactoryFileApiuploadFile
+     */
+    file: HttpFile
+}
+
+export class ObjectDataFactoryFileApi {
+    private api: ObservableDataFactoryFileApi
+
+    public constructor(configuration: Configuration, requestFactory?: DataFactoryFileApiRequestFactory, responseProcessor?: DataFactoryFileApiResponseProcessor) {
+        this.api = new ObservableDataFactoryFileApi(configuration, requestFactory, responseProcessor);
+    }
+
+    /**
+     * (Experimental) - Get a Data Factory File by id
+     * @param param the request object
+     */
+    public getFileById(param: DataFactoryFileApiGetFileByIdRequest, options?: Configuration): Promise<FileDto> {
+        return this.api.getFileById(param.id,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a list of Data Factory File
+     * @param param the request object
+     */
+    public getFiles(param: DataFactoryFileApiGetFilesRequest = {}, options?: Configuration): Promise<GetFiles200Response> {
+        return this.api.getFiles(param.size, param.page,  options).toPromise();
+    }
+
+    /**
+     * Post a file so it can be consume by a Data Factory job
+     * @param param the request object
+     */
+    public uploadFile(param: DataFactoryFileApiUploadFileRequest, options?: Configuration): Promise<FileDto> {
+        return this.api.uploadFile(param.file,  options).toPromise();
+    }
+
+}
+
+import { ObservableJobApi } from "./ObservableAPI";
+import { JobApiRequestFactory, JobApiResponseProcessor} from "../apis/JobApi";
+
+export interface JobApiCreateJobRequest {
+    /**
+     * 
+     * @type CreateJobDto
+     * @memberof JobApicreateJob
+     */
+    createJobDto: CreateJobDto
+}
+
+export interface JobApiGetJobByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof JobApigetJobById
+     */
+    id: string
+}
+
+export interface JobApiGetJobsRequest {
+    /**
+     * 
+     * @type number
+     * @memberof JobApigetJobs
+     */
+    size?: number
+    /**
+     * 
+     * @type number
+     * @memberof JobApigetJobs
+     */
+    page?: number
+}
+
+export interface JobApiUpdateJobRequest {
+    /**
+     * 
+     * @type string
+     * @memberof JobApiupdateJob
+     */
+    id: string
+    /**
+     * 
+     * @type UpdateJobDto
+     * @memberof JobApiupdateJob
+     */
+    updateJobDto: UpdateJobDto
+}
+
+export interface JobApiUpdateJobZipRequest {
+    /**
+     * 
+     * @type string
+     * @memberof JobApiupdateJobZip
+     */
+    id: string
+    /**
+     * 
+     * @type HttpFile
+     * @memberof JobApiupdateJobZip
+     */
+    file: HttpFile
+}
+
+export class ObjectJobApi {
+    private api: ObservableJobApi
+
+    public constructor(configuration: Configuration, requestFactory?: JobApiRequestFactory, responseProcessor?: JobApiResponseProcessor) {
+        this.api = new ObservableJobApi(configuration, requestFactory, responseProcessor);
+    }
+
+    /**
+     * (Experimental) - Create a Job
+     * @param param the request object
+     */
+    public createJob(param: JobApiCreateJobRequest, options?: Configuration): Promise<JobDto> {
+        return this.api.createJob(param.createJobDto,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a Job by id
+     * @param param the request object
+     */
+    public getJobById(param: JobApiGetJobByIdRequest, options?: Configuration): Promise<JobDto> {
+        return this.api.getJobById(param.id,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a list of Job
+     * @param param the request object
+     */
+    public getJobs(param: JobApiGetJobsRequest = {}, options?: Configuration): Promise<GetJobs200Response> {
+        return this.api.getJobs(param.size, param.page,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Update a Job
+     * @param param the request object
+     */
+    public updateJob(param: JobApiUpdateJobRequest, options?: Configuration): Promise<JobDto> {
+        return this.api.updateJob(param.id, param.updateJobDto,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Upload a zip to update a job
+     * @param param the request object
+     */
+    public updateJobZip(param: JobApiUpdateJobZipRequest, options?: Configuration): Promise<JobDto> {
+        return this.api.updateJobZip(param.id, param.file,  options).toPromise();
+    }
+
+}
+
+import { ObservableJobExecutionApi } from "./ObservableAPI";
+import { JobExecutionApiRequestFactory, JobExecutionApiResponseProcessor} from "../apis/JobExecutionApi";
+
+export interface JobExecutionApiCreateJobExecutionRequest {
+    /**
+     * 
+     * @type CreateJobExecutionDto
+     * @memberof JobExecutionApicreateJobExecution
+     */
+    createJobExecutionDto: CreateJobExecutionDto
+}
+
+export interface JobExecutionApiGetJobExecutionByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof JobExecutionApigetJobExecutionById
+     */
+    id: string
+}
+
+export interface JobExecutionApiGetJobExecutionsRequest {
+    /**
+     * 
+     * @type number
+     * @memberof JobExecutionApigetJobExecutions
+     */
+    size?: number
+    /**
+     * 
+     * @type number
+     * @memberof JobExecutionApigetJobExecutions
+     */
+    page?: number
+}
+
+export class ObjectJobExecutionApi {
+    private api: ObservableJobExecutionApi
+
+    public constructor(configuration: Configuration, requestFactory?: JobExecutionApiRequestFactory, responseProcessor?: JobExecutionApiResponseProcessor) {
+        this.api = new ObservableJobExecutionApi(configuration, requestFactory, responseProcessor);
+    }
+
+    /**
+     * (Experimental) - Create a Job execution
+     * @param param the request object
+     */
+    public createJobExecution(param: JobExecutionApiCreateJobExecutionRequest, options?: Configuration): Promise<JobExecutionDto> {
+        return this.api.createJobExecution(param.createJobExecutionDto,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a Job execution by id
+     * @param param the request object
+     */
+    public getJobExecutionById(param: JobExecutionApiGetJobExecutionByIdRequest, options?: Configuration): Promise<JobExecutionDto> {
+        return this.api.getJobExecutionById(param.id,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a list of Job execution
+     * @param param the request object
+     */
+    public getJobExecutions(param: JobExecutionApiGetJobExecutionsRequest = {}, options?: Configuration): Promise<GetJobExecutions200Response> {
+        return this.api.getJobExecutions(param.size, param.page,  options).toPromise();
+    }
+
+}
+
+import { ObservableTaskApi } from "./ObservableAPI";
+import { TaskApiRequestFactory, TaskApiResponseProcessor} from "../apis/TaskApi";
+
+export interface TaskApiCreateTaskRequest {
+    /**
+     * 
+     * @type CreateTaskDto
+     * @memberof TaskApicreateTask
+     */
+    createTaskDto: CreateTaskDto
+}
+
+export interface TaskApiDeleteTaskRequest {
+    /**
+     * 
+     * @type string
+     * @memberof TaskApideleteTask
+     */
+    id: string
+}
+
+export interface TaskApiGetTaskByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof TaskApigetTaskById
+     */
+    id: string
+}
+
+export interface TaskApiGetTasksRequest {
+    /**
+     * 
+     * @type number
+     * @memberof TaskApigetTasks
+     */
+    size?: number
+    /**
+     * 
+     * @type number
+     * @memberof TaskApigetTasks
+     */
+    page?: number
+}
+
+export interface TaskApiPollTaskExecutionRequest {
+    /**
+     * 
+     * @type string
+     * @memberof TaskApipollTaskExecution
+     */
+    id: string
+}
+
+export interface TaskApiUpdateTaskRequest {
+    /**
+     * 
+     * @type string
+     * @memberof TaskApiupdateTask
+     */
+    id: string
+    /**
+     * 
+     * @type UpdateTaskDto
+     * @memberof TaskApiupdateTask
+     */
+    updateTaskDto: UpdateTaskDto
+}
+
+export class ObjectTaskApi {
+    private api: ObservableTaskApi
+
+    public constructor(configuration: Configuration, requestFactory?: TaskApiRequestFactory, responseProcessor?: TaskApiResponseProcessor) {
+        this.api = new ObservableTaskApi(configuration, requestFactory, responseProcessor);
+    }
+
+    /**
+     * (Experimental) - Create a Task
+     * @param param the request object
+     */
+    public createTask(param: TaskApiCreateTaskRequest, options?: Configuration): Promise<TaskDto> {
+        return this.api.createTask(param.createTaskDto,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Delete a Task by id
+     * @param param the request object
+     */
+    public deleteTask(param: TaskApiDeleteTaskRequest, options?: Configuration): Promise<TaskDto> {
+        return this.api.deleteTask(param.id,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a Task by id
+     * @param param the request object
+     */
+    public getTaskById(param: TaskApiGetTaskByIdRequest, options?: Configuration): Promise<TaskDto> {
+        return this.api.getTaskById(param.id,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a list of Task
+     * @param param the request object
+     */
+    public getTasks(param: TaskApiGetTasksRequest = {}, options?: Configuration): Promise<GetTasks200Response> {
+        return this.api.getTasks(param.size, param.page,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Poll a task if there is not task to poll, the API returns a `404 Not Found` error
+     * @param param the request object
+     */
+    public pollTaskExecution(param: TaskApiPollTaskExecutionRequest, options?: Configuration): Promise<TaskExecutionDto> {
+        return this.api.pollTaskExecution(param.id,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Update a Task
+     * @param param the request object
+     */
+    public updateTask(param: TaskApiUpdateTaskRequest, options?: Configuration): Promise<TaskDto> {
+        return this.api.updateTask(param.id, param.updateTaskDto,  options).toPromise();
+    }
+
+}
+
+import { ObservableTaskExecutionApi } from "./ObservableAPI";
+import { TaskExecutionApiRequestFactory, TaskExecutionApiResponseProcessor} from "../apis/TaskExecutionApi";
+
+export interface TaskExecutionApiGetTaskExecutionByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof TaskExecutionApigetTaskExecutionById
+     */
+    id: string
+}
+
+export interface TaskExecutionApiPatchTaskExecutionRequest {
+    /**
+     * 
+     * @type string
+     * @memberof TaskExecutionApipatchTaskExecution
+     */
+    id: string
+    /**
+     * 
+     * @type PatchTaskExecutionDto
+     * @memberof TaskExecutionApipatchTaskExecution
+     */
+    patchTaskExecutionDto: PatchTaskExecutionDto
+}
+
+export class ObjectTaskExecutionApi {
+    private api: ObservableTaskExecutionApi
+
+    public constructor(configuration: Configuration, requestFactory?: TaskExecutionApiRequestFactory, responseProcessor?: TaskExecutionApiResponseProcessor) {
+        this.api = new ObservableTaskExecutionApi(configuration, requestFactory, responseProcessor);
+    }
+
+    /**
+     * (Experimental) - Get a Task execution by id
+     * @param param the request object
+     */
+    public getTaskExecutionById(param: TaskExecutionApiGetTaskExecutionByIdRequest, options?: Configuration): Promise<TaskExecutionDto> {
+        return this.api.getTaskExecutionById(param.id,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Update running task instance
+     * @param param the request object
+     */
+    public patchTaskExecution(param: TaskExecutionApiPatchTaskExecutionRequest, options?: Configuration): Promise<TaskExecutionDto> {
+        return this.api.patchTaskExecution(param.id, param.patchTaskExecutionDto,  options).toPromise();
+    }
+
+}
+
+import { ObservableVariableApi } from "./ObservableAPI";
+import { VariableApiRequestFactory, VariableApiResponseProcessor} from "../apis/VariableApi";
+
+export interface VariableApiCreateVariableRequest {
+    /**
+     * 
+     * @type CreateVariableDto
+     * @memberof VariableApicreateVariable
+     */
+    createVariableDto: CreateVariableDto
+}
+
+export interface VariableApiFindVariablesRequest {
+    /**
+     * 
+     * @type FindVariablesRequest
+     * @memberof VariableApifindVariables
+     */
+    findVariablesRequest: FindVariablesRequest
+    /**
+     * 
+     * @type number
+     * @memberof VariableApifindVariables
+     */
+    size?: number
+    /**
+     * 
+     * @type number
+     * @memberof VariableApifindVariables
+     */
+    page?: number
+}
+
+export interface VariableApiGetVariableByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof VariableApigetVariableById
+     */
+    id: string
+}
+
+export interface VariableApiGetVariablesRequest {
+    /**
+     * 
+     * @type number
+     * @memberof VariableApigetVariables
+     */
+    size?: number
+    /**
+     * 
+     * @type number
+     * @memberof VariableApigetVariables
+     */
+    page?: number
+}
+
+export interface VariableApiUpdateVariableRequest {
+    /**
+     * 
+     * @type string
+     * @memberof VariableApiupdateVariable
+     */
+    id: string
+    /**
+     * 
+     * @type UpdateVariableDto
+     * @memberof VariableApiupdateVariable
+     */
+    updateVariableDto: UpdateVariableDto
+}
+
+export class ObjectVariableApi {
+    private api: ObservableVariableApi
+
+    public constructor(configuration: Configuration, requestFactory?: VariableApiRequestFactory, responseProcessor?: VariableApiResponseProcessor) {
+        this.api = new ObservableVariableApi(configuration, requestFactory, responseProcessor);
+    }
+
+    /**
+     * (Experimental) - Create a Variable
+     * @param param the request object
+     */
+    public createVariable(param: VariableApiCreateVariableRequest, options?: Configuration): Promise<VariableDto> {
+        return this.api.createVariable(param.createVariableDto,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Find a list of Variable
+     * @param param the request object
+     */
+    public findVariables(param: VariableApiFindVariablesRequest, options?: Configuration): Promise<GetVariables200Response> {
+        return this.api.findVariables(param.findVariablesRequest, param.size, param.page,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a Variable by id
+     * @param param the request object
+     */
+    public getVariableById(param: VariableApiGetVariableByIdRequest, options?: Configuration): Promise<VariableDto> {
+        return this.api.getVariableById(param.id,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Get a list of Variable
+     * @param param the request object
+     */
+    public getVariables(param: VariableApiGetVariablesRequest = {}, options?: Configuration): Promise<GetVariables200Response> {
+        return this.api.getVariables(param.size, param.page,  options).toPromise();
+    }
+
+    /**
+     * (Experimental) - Update a Variable
+     * @param param the request object
+     */
+    public updateVariable(param: VariableApiUpdateVariableRequest, options?: Configuration): Promise<VariableDto> {
+        return this.api.updateVariable(param.id, param.updateVariableDto,  options).toPromise();
+    }
+
+}