@product-live/api-sdk 1.87.0-dev

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/apis/DataFactoryFileApi.ts

@@ -0,0 +1,185 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product-Live API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.87.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ExecuteJob400Response,
+  FileCreatedDto,
+} from '../models';
+import {
+    ExecuteJob400ResponseFromJSON,
+    ExecuteJob400ResponseToJSON,
+    FileCreatedDtoFromJSON,
+    FileCreatedDtoToJSON,
+} from '../models';
+
+export interface GetFileRequest {
+    id: string;
+}
+
+export interface GetFilesRequest {
+    page?: string;
+    size?: string;
+}
+
+export interface UploadFileRequest {
+    file: Blob;
+}
+
+/**
+ * 
+ */
+export class DataFactoryFileApi extends runtime.BaseAPI {
+
+    /**
+     * (Experimental) - Obtain a file by its ID
+     */
+    async getFileRaw(requestParameters: GetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileCreatedDto>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling getFile.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/files/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FileCreatedDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - Obtain a file by its ID
+     */
+    async getFile(requestParameters: GetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileCreatedDto> {
+        const response = await this.getFileRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * (Experimental) - List files
+     */
+    async getFilesRaw(requestParameters: GetFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileCreatedDto>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.page !== undefined) {
+            queryParameters['page'] = requestParameters.page;
+        }
+
+        if (requestParameters.size !== undefined) {
+            queryParameters['size'] = requestParameters.size;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/files`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FileCreatedDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - List files
+     */
+    async getFiles(requestParameters: GetFilesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileCreatedDto> {
+        const response = await this.getFilesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Post a file so it can be consume by a Data Factory job
+     */
+    async uploadFileRaw(requestParameters: UploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileCreatedDto>> {
+        if (requestParameters.file === null || requestParameters.file === undefined) {
+            throw new runtime.RequiredError('file','Required parameter requestParameters.file was null or undefined when calling uploadFile.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters.file !== undefined) {
+            formParams.append('file', requestParameters.file as any);
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/files`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => FileCreatedDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Post a file so it can be consume by a Data Factory job
+     */
+    async uploadFile(requestParameters: UploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileCreatedDto> {
+        const response = await this.uploadFileRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/JobApi.ts

@@ -0,0 +1,284 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product-Live API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.87.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ExecuteJob400Response,
+  JobDto,
+} from '../models';
+import {
+    ExecuteJob400ResponseFromJSON,
+    ExecuteJob400ResponseToJSON,
+    JobDtoFromJSON,
+    JobDtoToJSON,
+} from '../models';
+
+export interface CreateJobRequest {
+    jobDto: JobDto;
+}
+
+export interface GetJobRequest {
+    id: string;
+}
+
+export interface GetJobsRequest {
+    page?: string;
+    size?: string;
+}
+
+export interface UpdateJobRequest {
+    jobDto: JobDto;
+}
+
+export interface UpdateJobZipRequest {
+    file: Blob;
+    id: string;
+}
+
+/**
+ * 
+ */
+export class JobApi extends runtime.BaseAPI {
+
+    /**
+     * (Experimental) - Create job
+     */
+    async createJobRaw(requestParameters: CreateJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>> {
+        if (requestParameters.jobDto === null || requestParameters.jobDto === undefined) {
+            throw new runtime.RequiredError('jobDto','Required parameter requestParameters.jobDto was null or undefined when calling createJob.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/jobs`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: JobDtoToJSON(requestParameters.jobDto),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - Create job
+     */
+    async createJob(requestParameters: CreateJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto> {
+        const response = await this.createJobRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * (Experimental) - Obtain a job by its ID
+     */
+    async getJobRaw(requestParameters: GetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling getJob.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/jobs/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - Obtain a job by its ID
+     */
+    async getJob(requestParameters: GetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto> {
+        const response = await this.getJobRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * (Experimental) - List jobs
+     */
+    async getJobsRaw(requestParameters: GetJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.page !== undefined) {
+            queryParameters['page'] = requestParameters.page;
+        }
+
+        if (requestParameters.size !== undefined) {
+            queryParameters['size'] = requestParameters.size;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/jobs`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - List jobs
+     */
+    async getJobs(requestParameters: GetJobsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto> {
+        const response = await this.getJobsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * (Experimental) - Update Job
+     */
+    async updateJobRaw(requestParameters: UpdateJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>> {
+        if (requestParameters.jobDto === null || requestParameters.jobDto === undefined) {
+            throw new runtime.RequiredError('jobDto','Required parameter requestParameters.jobDto was null or undefined when calling updateJob.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/jobs`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: JobDtoToJSON(requestParameters.jobDto),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - Update Job
+     */
+    async updateJob(requestParameters: UpdateJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto> {
+        const response = await this.updateJobRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * (Experimental) - Upload a zip to update a job
+     */
+    async updateJobZipRaw(requestParameters: UpdateJobZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobDto>> {
+        if (requestParameters.file === null || requestParameters.file === undefined) {
+            throw new runtime.RequiredError('file','Required parameter requestParameters.file was null or undefined when calling updateJobZip.');
+        }
+
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling updateJobZip.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters.file !== undefined) {
+            formParams.append('file', requestParameters.file as any);
+        }
+
+        if (requestParameters.id !== undefined) {
+            formParams.append('id', requestParameters.id as any);
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/jobs/zip`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - Upload a zip to update a job
+     */
+    async updateJobZip(requestParameters: UpdateJobZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobDto> {
+        const response = await this.updateJobZipRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/apis/JobExecutionApi.ts

@@ -0,0 +1,123 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Product-Live API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.87.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ExecuteJob400Response,
+  ExecuteJobDto,
+  JobExecutionDto,
+} from '../models';
+import {
+    ExecuteJob400ResponseFromJSON,
+    ExecuteJob400ResponseToJSON,
+    ExecuteJobDtoFromJSON,
+    ExecuteJobDtoToJSON,
+    JobExecutionDtoFromJSON,
+    JobExecutionDtoToJSON,
+} from '../models';
+
+export interface ExecuteJobRequest {
+    executeJobDto: ExecuteJobDto;
+}
+
+export interface GetJobexecutionRequest {
+    id: string;
+}
+
+/**
+ * 
+ */
+export class JobExecutionApi extends runtime.BaseAPI {
+
+    /**
+     * (Experimental) - Execute a job
+     */
+    async executeJobRaw(requestParameters: ExecuteJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobExecutionDto>> {
+        if (requestParameters.executeJobDto === null || requestParameters.executeJobDto === undefined) {
+            throw new runtime.RequiredError('executeJobDto','Required parameter requestParameters.executeJobDto was null or undefined when calling executeJob.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/job_executions`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ExecuteJobDtoToJSON(requestParameters.executeJobDto),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobExecutionDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - Execute a job
+     */
+    async executeJob(requestParameters: ExecuteJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobExecutionDto> {
+        const response = await this.executeJobRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * (Experimental) - Obtain information about a job execution from its id
+     */
+    async getJobexecutionRaw(requestParameters: GetJobexecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobExecutionDto>> {
+        if (requestParameters.id === null || requestParameters.id === undefined) {
+            throw new runtime.RequiredError('id','Required parameter requestParameters.id was null or undefined when calling getJobexecution.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = this.configuration.apiKey("X-Api-Key"); // ApiKeyAuthHeader authentication
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            queryParameters["api_key"] = this.configuration.apiKey("api_key"); // ApiKeyAuthQuery authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/data_factory/job_executions/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JobExecutionDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * (Experimental) - Obtain information about a job execution from its id
+     */
+    async getJobexecution(requestParameters: GetJobexecutionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobExecutionDto> {
+        const response = await this.getJobexecutionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}