@gofynd/fdk-client-javascript 1.3.3 → 1.3.4-beta.2

package/sdk/partner/FileStorage/FileStoragePartnerClient.js

@@ -0,0 +1,177 @@
+const Paginator = require("../../common/Paginator");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const PartnerAPIClient = require("../PartnerAPIClient");
+const FileStorageValidator = require("./FileStoragePartnerValidator");
+const FileStorageModel = require("./FileStoragePartnerModel");
+const { Logger } = require("./../../common/Logger");
+
+class FileStorage {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
+   * @param {StartRequest} arg.body
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PartnerAPIClient").Options} - Options
+   * @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, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = FileStorageValidator.startUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "post",
+      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/namespaces/${namespace}/upload/start`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
+   * @param {StartResponse} arg.body
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PartnerAPIClient").Options} - Options
+   * @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, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = FileStorageValidator.completeUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "post",
+      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/namespaces/${namespace}/upload/complete`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Segregation of different types of
+   *   files(products, orders, logistics etc), Required for validating the
+   *   data of the file being uploaded, decides where exactly the file will be
+   *   stored inside the storage bucket.
+   * @param {string} arg.applicationId -
+   * @param {number} arg.companyId -
+   * @param {number} [arg.page] - Page no
+   * @param {number} [arg.limit] - Limit
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PartnerAPIClient").Options} - Options
+   * @summary: Browse Files
+   * @description: Browse Files
+   */
+  browse(
+    { namespace, applicationId, companyId, page, limit, requestHeaders } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = FileStorageValidator.browse().validate(
+      {
+        namespace,
+        applicationId,
+        companyId,
+        page,
+        limit,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page"] = page;
+    query_params["limit"] = limit;
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/namespaces/${namespace}/browse`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+}
+module.exports = FileStorage;

package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts

@@ -0,0 +1,139 @@
+export = FileStoragePartnerModel;
+/**
+ * @typedef CDN
+ * @property {string} absolute_url
+ * @property {string} relative_url
+ * @property {string} url
+ */
+/**
+ * @typedef CompleteResponse
+ * @property {string} _id
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {CreatedBy} [created_by]
+ * @property {string} created_on
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} modified_on
+ * @property {string} namespace
+ * @property {string} operation
+ * @property {number} size
+ * @property {boolean} success
+ * @property {string[]} [tags]
+ * @property {Upload} upload
+ */
+/**
+ * @typedef CreatedBy
+ * @property {string} [username]
+ */
+/**
+ * @typedef FailedResponse
+ * @property {string} message
+ */
+/**
+ * @typedef Params
+ * @property {string} [subpath] - The subpath for the file.
+ */
+/**
+ * @typedef StartRequest
+ * @property {string} content_type
+ * @property {string} file_name
+ * @property {Params} [params]
+ * @property {number} size
+ * @property {string[]} [tags]
+ */
+/**
+ * @typedef StartResponse
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} [method]
+ * @property {string} namespace
+ * @property {string} operation
+ * @property {number} size
+ * @property {string[]} [tags]
+ * @property {Upload} upload
+ */
+/**
+ * @typedef Upload
+ * @property {number} expiry
+ * @property {string} url
+ */
+declare class FileStoragePartnerModel {
+}
+declare namespace FileStoragePartnerModel {
+    export { CDN, CompleteResponse, CreatedBy, FailedResponse, Params, StartRequest, StartResponse, Upload };
+}
+/** @returns {CDN} */
+declare function CDN(): CDN;
+type CDN = {
+    absolute_url: string;
+    relative_url: string;
+    url: string;
+};
+/** @returns {CompleteResponse} */
+declare function CompleteResponse(): CompleteResponse;
+type CompleteResponse = {
+    _id: string;
+    cdn: CDN;
+    content_type: string;
+    created_by?: CreatedBy;
+    created_on: string;
+    file_name: string;
+    file_path: string;
+    modified_on: string;
+    namespace: string;
+    operation: string;
+    size: number;
+    success: boolean;
+    tags?: string[];
+    upload: Upload;
+};
+/** @returns {CreatedBy} */
+declare function CreatedBy(): CreatedBy;
+type CreatedBy = {
+    username?: string;
+};
+/** @returns {FailedResponse} */
+declare function FailedResponse(): FailedResponse;
+type FailedResponse = {
+    message: string;
+};
+/** @returns {Params} */
+declare function Params(): Params;
+type Params = {
+    /**
+     * - The subpath for the file.
+     */
+    subpath?: string;
+};
+/** @returns {StartRequest} */
+declare function StartRequest(): StartRequest;
+type StartRequest = {
+    content_type: string;
+    file_name: string;
+    params?: Params;
+    size: number;
+    tags?: string[];
+};
+/** @returns {StartResponse} */
+declare function StartResponse(): StartResponse;
+type StartResponse = {
+    cdn: CDN;
+    content_type: string;
+    file_name: string;
+    file_path: string;
+    method?: string;
+    namespace: string;
+    operation: string;
+    size: number;
+    tags?: string[];
+    upload: Upload;
+};
+/** @returns {Upload} */
+declare function Upload(): Upload;
+type Upload = {
+    expiry: number;
+    url: string;
+};

package/sdk/partner/FileStorage/FileStoragePartnerModel.js

@@ -0,0 +1,158 @@
+const Joi = require("joi");
+
+/**
+ * @typedef CDN
+ * @property {string} absolute_url
+ * @property {string} relative_url
+ * @property {string} url
+ */
+
+/**
+ * @typedef CompleteResponse
+ * @property {string} _id
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {CreatedBy} [created_by]
+ * @property {string} created_on
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} modified_on
+ * @property {string} namespace
+ * @property {string} operation
+ * @property {number} size
+ * @property {boolean} success
+ * @property {string[]} [tags]
+ * @property {Upload} upload
+ */
+
+/**
+ * @typedef CreatedBy
+ * @property {string} [username]
+ */
+
+/**
+ * @typedef FailedResponse
+ * @property {string} message
+ */
+
+/**
+ * @typedef Params
+ * @property {string} [subpath] - The subpath for the file.
+ */
+
+/**
+ * @typedef StartRequest
+ * @property {string} content_type
+ * @property {string} file_name
+ * @property {Params} [params]
+ * @property {number} size
+ * @property {string[]} [tags]
+ */
+
+/**
+ * @typedef StartResponse
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} [method]
+ * @property {string} namespace
+ * @property {string} operation
+ * @property {number} size
+ * @property {string[]} [tags]
+ * @property {Upload} upload
+ */
+
+/**
+ * @typedef Upload
+ * @property {number} expiry
+ * @property {string} url
+ */
+
+class FileStoragePartnerModel {
+  /** @returns {CDN} */
+  static CDN() {
+    return Joi.object({
+      absolute_url: Joi.string().allow("").required(),
+      relative_url: Joi.string().allow("").required(),
+      url: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {CompleteResponse} */
+  static CompleteResponse() {
+    return Joi.object({
+      _id: Joi.string().allow("").required(),
+      cdn: FileStoragePartnerModel.CDN().required(),
+      content_type: Joi.string().allow("").required(),
+      created_by: FileStoragePartnerModel.CreatedBy(),
+      created_on: Joi.string().allow("").required(),
+      file_name: Joi.string().allow("").required(),
+      file_path: Joi.string().allow("").required(),
+      modified_on: Joi.string().allow("").required(),
+      namespace: Joi.string().allow("").required(),
+      operation: Joi.string().allow("").required(),
+      size: Joi.number().required(),
+      success: Joi.boolean().required(),
+      tags: Joi.array().items(Joi.string().allow("")),
+      upload: FileStoragePartnerModel.Upload().required(),
+    });
+  }
+
+  /** @returns {CreatedBy} */
+  static CreatedBy() {
+    return Joi.object({
+      username: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {FailedResponse} */
+  static FailedResponse() {
+    return Joi.object({
+      message: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {Params} */
+  static Params() {
+    return Joi.object({
+      subpath: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {StartRequest} */
+  static StartRequest() {
+    return Joi.object({
+      content_type: Joi.string().allow("").required(),
+      file_name: Joi.string().allow("").required(),
+      params: FileStoragePartnerModel.Params(),
+      size: Joi.number().required(),
+      tags: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  /** @returns {StartResponse} */
+  static StartResponse() {
+    return Joi.object({
+      cdn: FileStoragePartnerModel.CDN().required(),
+      content_type: Joi.string().allow("").required(),
+      file_name: Joi.string().allow("").required(),
+      file_path: Joi.string().allow("").required(),
+      method: Joi.string().allow(""),
+      namespace: Joi.string().allow("").required(),
+      operation: Joi.string().allow("").required(),
+      size: Joi.number().required(),
+      tags: Joi.array().items(Joi.string().allow("")),
+      upload: FileStoragePartnerModel.Upload().required(),
+    });
+  }
+
+  /** @returns {Upload} */
+  static Upload() {
+    return Joi.object({
+      expiry: Joi.number().required(),
+      url: Joi.string().allow("").required(),
+    });
+  }
+}
+module.exports = FileStoragePartnerModel;

package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts

@@ -0,0 +1,6 @@
+export = FileStorageValidator;
+declare class FileStorageValidator {
+    static startUpload(): any;
+    static completeUpload(): any;
+    static browse(): any;
+}

package/sdk/partner/FileStorage/FileStoragePartnerValidator.js

@@ -0,0 +1,33 @@
+const Joi = require("joi");
+
+const FileStorageModel = require("./FileStoragePartnerModel");
+class FileStorageValidator {
+  static startUpload() {
+    return Joi.object({
+      namespace: Joi.string().allow("").required(),
+
+      body: FileStorageModel.StartRequest().required(),
+    }).required();
+  }
+
+  static completeUpload() {
+    return Joi.object({
+      namespace: Joi.string().allow("").required(),
+
+      body: FileStorageModel.StartResponse().required(),
+    }).required();
+  }
+
+  static browse() {
+    return Joi.object({
+      namespace: Joi.string().allow("").required(),
+
+      applicationId: Joi.string().allow("").required(),
+      companyId: Joi.number().required(),
+      page: Joi.number(),
+      limit: Joi.number(),
+    }).required();
+  }
+}
+
+module.exports = FileStorageValidator;

package/sdk/partner/PartnerClient.d.ts

@@ -13,6 +13,7 @@ declare class PartnerClient {
      */
     constructor(config: import("./PartnerConfig"));
     config: import("./PartnerConfig");
+    fileStorage: FileStorage;
     theme: Theme;
     /**
      * Sets the extra headers for the partner client.
@@ -22,4 +23,5 @@ declare class PartnerClient {
      */
     setExtraHeaders(header: object): void;
 }
+import FileStorage = require("./FileStorage/FileStoragePartnerClient");
 import Theme = require("./Theme/ThemePartnerClient");

package/sdk/partner/PartnerClient.js

@@ -1,3 +1,5 @@
+const FileStorage = require("./FileStorage/FileStoragePartnerClient");
+
 const Theme = require("./Theme/ThemePartnerClient");
 
 const { FDKClientValidationError } = require("../common/FDKError");
@@ -16,6 +18,7 @@ class PartnerClient {
    */
   constructor(config) {
     this.config = config;
+    this.fileStorage = new FileStorage(config);
     this.theme = new Theme(config);
   }
 

package/sdk/partner/PartnerConfig.js

@@ -29,11 +29,9 @@ class PartnerConfig {
     this.domain = config.domain || "https://api.fynd.com";
     this.apiKey = config.apiKey;
     this.apiSecret = config.apiSecret;
-    (this.scope = config.scope),
-      (this.useAutoRenewTimer =
-        config.useAutoRenewTimer !== undefined
-          ? config.useAutoRenewTimer
-          : true);
+    this.scope = config.scope;
+    this.useAutoRenewTimer =
+      config.useAutoRenewTimer !== undefined ? config.useAutoRenewTimer : true;
     this.oauthClient = new OauthClient(this);
     this.logLevel = config.logLevel || "ERROR";
     this.setLogLevel(this.logLevel);

package/sdk/partner/index.d.ts

@@ -1,5 +1,6 @@
 export const PartnerConfig: typeof import("./PartnerConfig");
 export const PartnerClient: typeof import("./PartnerClient");
 export namespace PartnerModel {
+    const FileStoragePartnerModel: typeof import("./FileStorage/FileStoragePartnerModel");
     const ThemePartnerModel: typeof import("./Theme/ThemePartnerModel");
 }

package/sdk/partner/index.js

@@ -2,6 +2,8 @@ module.exports = {
   PartnerConfig: require("./PartnerConfig"),
   PartnerClient: require("./PartnerClient"),
   PartnerModel: {
+    FileStoragePartnerModel: require("./FileStorage/FileStoragePartnerModel"),
+
     ThemePartnerModel: require("./Theme/ThemePartnerModel"),
   },
 };

package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts

@@ -135,18 +135,6 @@ declare class Content {
      * @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to create a slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSlideshow/).
      */
     createSlideshow({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
-    /**
-     * @param {ContentPlatformApplicationValidator.DeleteAllInjectableTagsParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
-     * @name deleteAllInjectableTags
-     * @summary: Delete tags in application
-     * @description: Use this API to delete all the existing tags at once. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAllInjectableTags/).
-     */
-    deleteAllInjectableTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
     /**
      * @param {ContentPlatformApplicationValidator.DeleteAnnouncementParam} arg
      *   - Arg object
@@ -456,9 +444,9 @@ declare class Content {
      * @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
      * @name getInjectableTags
      * @summary: Get all the tags in an application
-     * @description: Use this API to get all the CSS and JS injected in the application in the form of tags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getInjectableTags/).
+     * @description: Use this API to get the CSS and JS injected in the application in the form of tags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getInjectableTags/).
      */
-    getInjectableTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
+    getInjectableTags({ all, requestHeaders }?: ContentPlatformApplicationValidator.GetInjectableTagsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
     /**
      * @param {ContentPlatformApplicationValidator.GetLandingPagesParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -788,8 +776,8 @@ declare class Content {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
      * @name updateInjectableTag
-     * @summary: Update a tag
-     * @description: Use this API to edit the details of an existing tag. This includes the tag name, tag type (css/js), url and position of the tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateInjectableTag/).
+     * @summary: Update the exisitng tags for an application by replacing with provided tags
+     * @description: Use this API to edit and override all existing tags. All existing tags will be replaced by the new tags provided in body.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateInjectableTag/).
      */
     updateInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
     /**