@gofynd/fdk-client-javascript 0.1.35

package/sdk/platform/client/FileStoragePlatformClient.js

@@ -0,0 +1,268 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const FileStorageValidator = require("../models/FileStorageValidator");
+class FileStorage {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {StartRequest} arg.body
+   * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
+   * @description: Uploads an arbitrarily sized buffer or blob.
+   *
+   * It has three Major Steps:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `startUpload`.
+   * It returns the storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
+   *
+   * ### Complete
+   * After successfully upload, call `completeUpload` api to complete the upload process.
+   * This operation will return the url for the uploaded file.
+   */
+  startUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.startUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/upload/start/`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {StartResponse} arg.body
+   * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
+   * @description: Uploads an arbitrarily sized buffer or blob.
+   *
+   * It has three Major Steps:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `startUpload`.
+   * It returns the storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
+   *
+   * ### Complete
+   * After successfully upload, call `completeUpload` api to complete the upload process.
+   * This operation will return the url for the uploaded file.
+   */
+  completeUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.completeUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/upload/complete/`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {SignUrlRequest} arg.body
+   * @summary: Gives signed urls to access private files
+   * @description: Describe here
+   */
+  getSignUrls({ body } = {}) {
+    const { error } = FileStorageValidator.getSignUrls().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/sign-urls/`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {boolean} [arg.sync] - Sync
+   * @param {BulkRequest} arg.body
+   * @summary: Copy Files
+   * @description: Copy Files
+   */
+  copyFiles({ body, sync } = {}) {
+    const { error } = FileStorageValidator.copyFiles().validate(
+      {
+        body,
+        sync,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["sync"] = sync;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/uploads/copy/`,
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @param {number} [arg.pageNo] - Page no
+   * @summary: Browse Files
+   * @description: Browse Files
+   */
+  browse({ namespace, pageNo } = {}) {
+    const { error } = FileStorageValidator.browse().validate(
+      {
+        namespace,
+        pageNo,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/browse/`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @summary: Browse Files
+   * @description: Browse Files
+   */
+  browsePaginator({ namespace } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.browse({
+        namespace: namespace,
+        pageNo: pageNo,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback);
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.url - Url
+   * @summary: Proxy
+   * @description: Proxy
+   */
+  proxy({ url } = {}) {
+    const { error } = FileStorageValidator.proxy().validate(
+      {
+        url,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["url"] = url;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/proxy/`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = FileStorage;

package/sdk/platform/client/InventoryPlatformClient.d.ts

@@ -0,0 +1,125 @@
+export = Inventory;
+declare class Inventory {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Page Number
+     * @param {number} [arg.pageSize] - Page Size
+     * @summary: Get Job Configs For A Company
+     * @description: REST Endpoint that returns all job configs for a company
+     */
+    getJobsByCompany({ pageNo, pageSize }?: {
+        pageNo?: number;
+        pageSize?: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {JobConfigDTO} arg.body
+     * @summary: Updates An Existing Job Config
+     * @description: REST Endpoint that updates a job config
+     */
+    updateJob({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {JobConfigDTO} arg.body
+     * @summary: Creates A New Job Config
+     * @description: REST Endpoint that creates a new job config
+     */
+    createJob({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SuppressStorePayload} arg.body
+     * @summary: Get Slingshot Configuration Of  A Company
+     * @description: REST Endpoint that returns all configuration detail of a company
+     */
+    suppressStores({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get Slingshot Configuration Of  A Company
+     * @description: REST Endpoint that returns all configuration detail of a company
+     */
+    getConfigByCompany({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.jobId - Job Id
+     * @summary: Get Job Code Steps
+     * @description: REST Endpoint that returns Inventory Job Steps
+     */
+    getJobSteps({ jobId }?: {
+        jobId: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.integrationId - Integration Id
+     * @param {number} [arg.pageNo] - Page Number
+     * @param {number} [arg.pageSize] - Page Size
+     * @summary: Get Job Configs By Company And Integration
+     * @description: REST Endpoint that returns all job configs by company And integration
+     */
+    getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize }?: {
+        integrationId: string;
+        pageNo?: number;
+        pageSize?: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.integrationId - IntegrationId
+     * @summary: Disable Job Config
+     * @description: REST Endpoint that disables Inventory Job Config
+     */
+    disable({ integrationId }?: {
+        integrationId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get Job Configs Defaults
+     * @description: REST Endpoint that returns default fields job configs by company And integration
+     */
+    getJobConfigDefaults({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.code - Job Code
+     * @summary: Get Job Config By Code
+     * @description: REST Endpoint that returns job config by code
+     */
+    getJobByCode({ code }?: {
+        code: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.code - Code
+     * @param {number} [arg.pageNo] - Page Number
+     * @param {number} [arg.pageSize] - Page Size
+     * @param {string} [arg.status] - Status
+     * @param {string} [arg.date] - From Date
+     * @summary: Get Job Metrics
+     * @description: REST Endpoint that returns Inventory Run History For A Job Code
+     */
+    getJobCodeMetrics({ code, pageNo, pageSize, status, date }?: {
+        code: string;
+        pageNo?: number;
+        pageSize?: number;
+        status?: string;
+        date?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.integrationId - Integration Id
+     * @param {number} [arg.pageNo] - Page Number
+     * @param {number} [arg.pageSize] - Page Size
+     * @summary: Get Job Codes By Company And Integration
+     * @description: REST Endpoint that returns all job codes by company And integration
+     */
+    getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize }?: {
+        integrationId: string;
+        pageNo?: number;
+        pageSize?: number;
+    }): Promise<any>;
+}