@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.8

package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts

@@ -290,12 +290,23 @@ export = CatalogPlatformValidator;
  * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
  * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
  * @property {string[]} [itemCode] - Get multiple products filtered by Item Code
+ * @property {string} [name] - Get multiple products filtered by Name (Pattern Match)
+ * @property {string} [slug] - Get multiple products filtered by Slug
+ * @property {string[]} [allIdentifiers] - Get multiple products filtered by All
+ *   Identifiers
  * @property {string} [q] - Get multiple products filtered by q string
  * @property {string[]} [tags] - Get multiple products filtered by tags
  * @property {number} [pageNo] - The page number to navigate through the given
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
+ * @property {string} [pageType] - For pagination type value can be cursor or
+ *   number. Default is number.
+ * @property {string} [sortOn] - Field which is to be used for sorting, default
+ *   is latest. Value can be latest (modified_on) or created (record id)
+ * @property {string} [pageId] - If page_type is cursor, each response will
+ *   contain **next_id** param (datetime or id depending upon sort_on), which
+ *   should be sent back as page_id to make cursor pagination work.
  */
 /**
  * @typedef GetSellerInsightsParam
@@ -1137,6 +1148,19 @@ type GetProductsParam = {
      * - Get multiple products filtered by Item Code
      */
     itemCode?: string[];
+    /**
+     * - Get multiple products filtered by Name (Pattern Match)
+     */
+    name?: string;
+    /**
+     * - Get multiple products filtered by Slug
+     */
+    slug?: string;
+    /**
+     * - Get multiple products filtered by All
+     * Identifiers
+     */
+    allIdentifiers?: string[];
     /**
      * - Get multiple products filtered by q string
      */
@@ -1155,6 +1179,22 @@ type GetProductsParam = {
      * Default is 10.
      */
     pageSize?: number;
+    /**
+     * - For pagination type value can be cursor or
+     * number. Default is number.
+     */
+    pageType?: string;
+    /**
+     * - Field which is to be used for sorting, default
+     * is latest. Value can be latest (modified_on) or created (record id)
+     */
+    sortOn?: string;
+    /**
+     * - If page_type is cursor, each response will
+     * contain **next_id** param (datetime or id depending upon sort_on), which
+     * should be sent back as page_id to make cursor pagination work.
+     */
+    pageId?: string;
 };
 type GetSellerInsightsParam = {
     /**

package/sdk/platform/Catalog/CatalogPlatformValidator.js

@@ -345,12 +345,23 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
  * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
  * @property {string[]} [itemCode] - Get multiple products filtered by Item Code
+ * @property {string} [name] - Get multiple products filtered by Name (Pattern Match)
+ * @property {string} [slug] - Get multiple products filtered by Slug
+ * @property {string[]} [allIdentifiers] - Get multiple products filtered by All
+ *   Identifiers
  * @property {string} [q] - Get multiple products filtered by q string
  * @property {string[]} [tags] - Get multiple products filtered by tags
  * @property {number} [pageNo] - The page number to navigate through the given
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
+ * @property {string} [pageType] - For pagination type value can be cursor or
+ *   number. Default is number.
+ * @property {string} [sortOn] - Field which is to be used for sorting, default
+ *   is latest. Value can be latest (modified_on) or created (record id)
+ * @property {string} [pageId] - If page_type is cursor, each response will
+ *   contain **next_id** param (datetime or id depending upon sort_on), which
+ *   should be sent back as page_id to make cursor pagination work.
  */
 
 /**
@@ -963,10 +974,16 @@ class CatalogPlatformValidator {
       itemIds: Joi.array().items(Joi.number()),
       departmentIds: Joi.array().items(Joi.number()),
       itemCode: Joi.array().items(Joi.string().allow("")),
+      name: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      allIdentifiers: Joi.array().items(Joi.string().allow("")),
       q: Joi.string().allow(""),
       tags: Joi.array().items(Joi.string().allow("")),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      pageType: Joi.string().allow(""),
+      sortOn: Joi.string().allow(""),
+      pageId: Joi.string().allow(""),
     }).required();
   }
 

package/sdk/platform/Communication/CommunicationPlatformModel.d.ts

@@ -804,13 +804,13 @@ export = CommunicationPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef GenericError
@@ -1825,12 +1825,33 @@ type SystemNotifications = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {GenericError} */

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -912,13 +912,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts

@@ -259,13 +259,13 @@ export = CompanyProfilePlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef CompanyBrandListSerializer
@@ -733,12 +733,33 @@ type CompanyBrandSerializer = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {CompanyBrandListSerializer} */

package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js

@@ -286,13 +286,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts

@@ -23,18 +23,6 @@ declare class Configuration {
      * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
      */
     getApplications({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformValidator.GetApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationsResponse>;
-    /**
-     * @param {ConfigurationPlatformValidator.GetAvailableOptInsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
-     *   - Success response
-     *
-     * @name getAvailableOptIns
-     * @summary: List available opt-ins
-     * @description: Retrieve a list of available opt-ins.  Retrieve a list of all available integrations in a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAvailableOptIns/).
-     */
-    getAvailableOptIns({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetAvailableOptInsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
     /**
      * @param {ConfigurationPlatformValidator.GetBrandsByCompanyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -80,55 +68,6 @@ declare class Configuration {
      * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
      */
     getDomainAvailibility({ body, requestHeaders }?: ConfigurationPlatformValidator.GetDomainAvailibilityParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainSuggestionsResponse>;
-    /**
-     * @param {ConfigurationPlatformValidator.GetIntegrationByIdParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPlatformModel.Integration>} - Success response
-     * @name getIntegrationById
-     * @summary: Get integration by Id
-     * @description: Retrieve detailed information about a specific integration. Retrieve the details of an integration (such as Ginesys, SAP, etc.) using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationById/).
-     */
-    getIntegrationById({ id, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.Integration>;
-    /**
-     * @param {ConfigurationPlatformValidator.GetIntegrationByLevelIdParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
-     * @name getIntegrationByLevelId
-     * @summary: Get integration Id
-     * @description: Retrieve integration details for a specific level. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationByLevelId/).
-     */
-    getIntegrationByLevelId({ id, level, uid, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationByLevelIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
-    /**
-     * @param {ConfigurationPlatformValidator.GetIntegrationLevelConfigParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPlatformModel.IntegrationConfigResponse>}
-     *   - Success response
-     *
-     * @name getIntegrationLevelConfig
-     * @summary: Get level configuration
-     * @description: Retrieve configuration settings for integration levels. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationLevelConfig/).
-     */
-    getIntegrationLevelConfig({ id, level, opted, checkPermission, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationLevelConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationConfigResponse>;
-    /**
-     * @param {ConfigurationPlatformValidator.GetLevelActiveIntegrationsParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPlatformModel.OptedStoreIntegration>} -
-     *   Success response
-     * @name getLevelActiveIntegrations
-     * @summary: Get active integrations
-     * @description: Check if a store is already opted-in for any integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getLevelActiveIntegrations/).
-     */
-    getLevelActiveIntegrations({ id, level, uid, requestHeaders }?: ConfigurationPlatformValidator.GetLevelActiveIntegrationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OptedStoreIntegration>;
     /**
      * @param {ConfigurationPlatformValidator.GetOtherSellerApplicationByIdParam} arg
      *   - Arg object
@@ -156,18 +95,6 @@ declare class Configuration {
      * @description: Retrieve sales channels of  other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
      */
     getOtherSellerApplications({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetOtherSellerApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OtherSellerApplications>;
-    /**
-     * @param {ConfigurationPlatformValidator.GetSelectedOptInsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
-     *   - Success response
-     *
-     * @name getSelectedOptIns
-     * @summary: List selected opt-in
-     * @description: Retrieve a list of selected opt-ins. Retrieve the store-level/company-level integrations configured in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getSelectedOptIns/).
-     */
-    getSelectedOptIns({ level, uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetSelectedOptInsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
     /**
      * @param {ConfigurationPlatformValidator.GetStoreByBrandsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -190,30 +117,6 @@ declare class Configuration {
      * @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who  can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
      */
     optOutFromApplication({ id, body, requestHeaders }?: ConfigurationPlatformValidator.OptOutFromApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
-    /**
-     * @param {ConfigurationPlatformValidator.UpdateLevelIntegrationParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
-     * @name updateLevelIntegration
-     * @summary: Update level integration
-     * @description: Modify level integration. Update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelIntegration/).
-     */
-    updateLevelIntegration({ id, level, body, requestHeaders }?: ConfigurationPlatformValidator.UpdateLevelIntegrationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
-    /**
-     * @param {ConfigurationPlatformValidator.UpdateLevelUidIntegrationParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
-     * @name updateLevelUidIntegration
-     * @summary: Update level UID integration
-     * @description: Modify UID-based integration. Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
-     */
-    updateLevelUidIntegration({ id, level, uid, body, requestHeaders }?: ConfigurationPlatformValidator.UpdateLevelUidIntegrationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
 }
 import ConfigurationPlatformValidator = require("./ConfigurationPlatformValidator");
 import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");