@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1

package/sdk/application/Content/ContentApplicationClient.js

@@ -14,10 +14,14 @@ class Content {
       getAnnouncements: "/service/application/content/v1.0/announcements",
       getBlog: "/service/application/content/v1.0/blogs/{slug}",
       getBlogs: "/service/application/content/v1.0/blogs",
-      getCustomFieldsByResourceId:
-        "/service/application/content/v2.0/customfields/resource/{resource}/{resource_slug}",
-      getCustomObjectBySlug:
-        "/service/application/content/v2.0/customobjects/definition/{definition_slug}/entries/{slug}",
+      getCustomFieldDefinition:
+        "/service/application/content/v1.0/metafields/definitions/{id}",
+      getCustomFieldDefinitions:
+        "/service/application/content/v1.0/metafields/definitions",
+      getCustomFields:
+        "/service/application/content/v1.0/metafields/{resource}",
+      getCustomObject: "/service/application/content/v1.0/metaobjects/{id}",
+      getCustomObjects: "/service/application/content/v1.0/metaobjects",
       getDataLoaders: "/service/application/content/v1.0/data-loader",
       getFaqBySlug: "/service/application/content/v1.0/faq/{slug}",
       getFaqCategories: "/service/application/content/v1.0/faq/categories",
@@ -106,7 +110,7 @@ class Content {
    * @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
    */
   async getBlog(
-    { slug, rootId, preview, requestHeaders } = { requestHeaders: {} },
+    { slug, rootId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     let invalidInput = [];
@@ -126,7 +130,6 @@ class Content {
 
     const query_params = {};
     query_params["root_id"] = rootId;
-    query_params["preview"] = preview;
 
     const xHeaders = {};
 
@@ -154,7 +157,7 @@ class Content {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<BlogGetDetails>} - Success response
+   * @returns {Promise<BlogGetResponse>} - Success response
    * @name getBlogs
    * @summary: List blogs
    * @description: List all the blogs against an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
@@ -200,16 +203,113 @@ class Content {
     return response;
   }
 
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<CustomFieldDefinitionDetailResSchema>} - Success response
+   * @name getCustomFieldDefinition
+   * @summary: Get custom fields definition by id
+   * @description: Use this API to retrieve the definitions of custom fields using definition_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFieldDefinition/).
+   */
+  async getCustomFieldDefinition(
+    { id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+
+    if (!id) {
+      invalidInput.push({
+        message: `The 'id' field is required.`,
+        path: ["id"],
+      });
+    }
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getCustomFieldDefinition"],
+        params: { id },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<CustomFieldDefinitionsSchema>} - Success response
+   * @name getCustomFieldDefinitions
+   * @summary: Get custom fields definitions
+   * @description: Use this API to retrieve the definitions of custom fields. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFieldDefinitions/).
+   */
+  async getCustomFieldDefinitions(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getCustomFieldDefinitions"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
-   * @name getCustomFieldsByResourceId
-   * @summary: Get list of custom fields of given resource and resource slug
-   * @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFieldsByResourceId/).
+   * @name getCustomFields
+   * @summary: Get list of custom fields of given resource
+   * @description: Use this API to retrieve the custom fields for given resource and resource_ids in param - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
    */
-  async getCustomFieldsByResourceId(
-    { resource, resourceSlug, requestHeaders } = { requestHeaders: {} },
+  async getCustomFields(
+    { resource, resourceIds, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     let invalidInput = [];
@@ -220,10 +320,10 @@ class Content {
         path: ["resource"],
       });
     }
-    if (!resourceSlug) {
+    if (!resourceIds) {
       invalidInput.push({
-        message: `The 'resourceSlug' field is required.`,
-        path: ["resourceSlug"],
+        message: `The 'resourceIds' field is required.`,
+        path: ["resourceIds"],
       });
     }
     if (invalidInput.length) {
@@ -234,6 +334,7 @@ class Content {
     }
 
     const query_params = {};
+    query_params["resource_ids"] = resourceIds;
 
     const xHeaders = {};
 
@@ -241,8 +342,8 @@ class Content {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getCustomFieldsByResourceId"],
-        params: { resource, resourceSlug },
+        url: this._urls["getCustomFields"],
+        params: { resource },
       }),
       query_params,
       undefined,
@@ -262,26 +363,80 @@ class Content {
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<CustomObjectByIdSchema>} - Success response
-   * @name getCustomObjectBySlug
-   * @summary: Get custom object details
-   * @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObjectBySlug/).
+   * @name getCustomObject
+   * @summary: Get custom object
+   * @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
    */
-  async getCustomObjectBySlug(
-    { definitionSlug, slug, requestHeaders } = { requestHeaders: {} },
+  async getCustomObject(
+    { id, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     let invalidInput = [];
 
-    if (!definitionSlug) {
+    if (!id) {
       invalidInput.push({
-        message: `The 'definitionSlug' field is required.`,
-        path: ["definitionSlug"],
+        message: `The 'id' field is required.`,
+        path: ["id"],
       });
     }
-    if (!slug) {
+    if (invalidInput.length) {
+      const error = new Error();
+      error.message = "Missing required field";
+      error.details = invalidInput;
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getCustomObject"],
+        params: { id },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<CustomObjectsSchema>} - Success response
+   * @name getCustomObjects
+   * @summary: Get list of custom objects
+   * @description: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObjects/).
+   */
+  async getCustomObjects(
+    { pageNo, pageSize, definitionId, type, ids, search, requestHeaders } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    let invalidInput = [];
+
+    if (!pageNo) {
       invalidInput.push({
-        message: `The 'slug' field is required.`,
-        path: ["slug"],
+        message: `The 'pageNo' field is required.`,
+        path: ["pageNo"],
+      });
+    }
+    if (!pageSize) {
+      invalidInput.push({
+        message: `The 'pageSize' field is required.`,
+        path: ["pageSize"],
       });
     }
     if (invalidInput.length) {
@@ -292,6 +447,12 @@ class Content {
     }
 
     const query_params = {};
+    query_params["definition_id"] = definitionId;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["type"] = type;
+    query_params["ids"] = ids;
+    query_params["search"] = search;
 
     const xHeaders = {};
 
@@ -299,8 +460,8 @@ class Content {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getCustomObjectBySlug"],
-        params: { definitionSlug, slug },
+        url: this._urls["getCustomObjects"],
+        params: {},
       }),
       query_params,
       undefined,
@@ -613,7 +774,7 @@ class Content {
    * @returns {Promise<LandingPageSchema>} - Success response
    * @name getLandingPage
    * @summary: Get a landing page
-   * @description: Get content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
+   * @description: Gets the content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
    */
   async getLandingPage(
     { requestHeaders } = { requestHeaders: {} },
@@ -700,7 +861,7 @@ class Content {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<NavigationGetDetails>} - Success response
+   * @returns {Promise<NavigationGetResponse>} - Success response
    * @name getNavigations
    * @summary: List navigation items
    * @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
@@ -749,8 +910,8 @@ class Content {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<PageSchema>} - Success response
    * @name getPage
-   * @summary: Get a page
-   * @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
+   * @summary: Get page by slug
+   * @description: Get detailed information about a specific page using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
    */
   async getPage(
     { slug, rootId, requestHeaders } = { requestHeaders: {} },
@@ -800,10 +961,10 @@ class Content {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PageGetDetails>} - Success response
+   * @returns {Promise<PageGetResponse>} - Success response
    * @name getPages
    * @summary: Lists pages
-   * @description: Lists all Custom Pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
+   * @description: Lists all Custom Pages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
    */
   async getPages(
     { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },

package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts

@@ -12,30 +12,30 @@ declare class FileStorage {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<FileUploadComplete>} - Success response
+     * @returns {Promise<CompleteResponse>} - Success response
      * @name completeUpload
      * @summary: Finalizes upload process.
      * @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
      */
-    completeUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FileUploadComplete>;
+    completeUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CompleteResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<SignUrlResult>} - Success response
+     * @returns {Promise<SignUrlResponse>} - Success response
      * @name signUrls
      * @summary: Signs file URLs.
      * @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
      */
-    signUrls({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SignUrlResult>;
+    signUrls({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SignUrlResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<FileUpload>} - Success response
+     * @returns {Promise<StartResponse>} - Success response
      * @name startUpload
      * @summary: Initiates file upload
      * @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
      */
-    startUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FileUpload>;
+    startUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StartResponse>;
     /**
      * @param data
      * @param {string} file_name

package/sdk/application/FileStorage/FileStorageApplicationClient.js

@@ -38,7 +38,7 @@ class FileStorage {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<FileUploadComplete>} - Success response
+   * @returns {Promise<CompleteResponse>} - Success response
    * @name completeUpload
    * @summary: Finalizes upload process.
    * @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
@@ -90,7 +90,7 @@ class FileStorage {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<SignUrlResult>} - Success response
+   * @returns {Promise<SignUrlResponse>} - Success response
    * @name signUrls
    * @summary: Signs file URLs.
    * @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
@@ -135,7 +135,7 @@ class FileStorage {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<FileUpload>} - Success response
+   * @returns {Promise<StartResponse>} - Success response
    * @name startUpload
    * @summary: Initiates file upload
    * @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).

package/sdk/application/Lead/LeadApplicationClient.d.ts

@@ -16,7 +16,7 @@ declare class Lead {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<TicketHistory>} - Success response
      * @name createHistory
-     * @summary: Log ticket history
+     * @summary: Logs ticket history.
      * @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
      */
     createHistory({ id, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TicketHistory>;
@@ -50,10 +50,10 @@ declare class Lead {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<SubmitCustomFormDetails>} - Success response
+     * @returns {Promise<SubmitCustomFormResponse>} - Success response
      * @name submitCustomForm
      * @summary: Submits form data
      * @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
      */
-    submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SubmitCustomFormDetails>;
+    submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SubmitCustomFormResponse>;
 }

package/sdk/application/Lead/LeadApplicationClient.js

@@ -12,7 +12,7 @@ class Lead {
     this._conf = _conf;
     this._relativeUrls = {
       createHistory: "/service/application/lead/v1.0/ticket/{id}/history",
-      createTicket: "/service/application/lead/v1.0/ticket/",
+      createTicket: "/service/application/lead/v1.0/ticket",
       getCustomForm: "/service/application/lead/v1.0/form/{slug}",
       getTicket: "/service/application/lead/v1.0/ticket/{id}",
       submitCustomForm: "/service/application/lead/v1.0/form/{slug}/submit",
@@ -38,7 +38,7 @@ class Lead {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<TicketHistory>} - Success response
    * @name createHistory
-   * @summary: Log ticket history
+   * @summary: Logs ticket history.
    * @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
    */
   async createHistory(
@@ -237,7 +237,7 @@ class Lead {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<SubmitCustomFormDetails>} - Success response
+   * @returns {Promise<SubmitCustomFormResponse>} - Success response
    * @name submitCustomForm
    * @summary: Submits form data
    * @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).