@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/platform/Common/CommonPlatformClient.d.ts

@@ -8,7 +8,7 @@ declare class Common {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<CommonPlatformModel.Locations>} - Success response
      * @name getLocations
-     * @summary: Get company locations.
+     * @summary: Get company locations
      * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/getLocations/).
      */
     getLocations({ locationType, id, requestHeaders }?: CommonPlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CommonPlatformModel.Locations>;
@@ -16,12 +16,13 @@ declare class Common {
      * @param {CommonPlatformValidator.SearchApplicationParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CommonPlatformModel.ApplicationResponse>} - Success response
+     * @returns {Promise<CommonPlatformModel.ApplicationResponseSchema>} -
+     *   Success response
      * @name searchApplication
-     * @summary: Search for applications.
-     * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/searchApplication/).
+     * @summary: List sales channel categories
+     * @description: This API retrieves details for a specific sales channel based on the provided search criteria. The search can be performed using the name of the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/searchApplication/).
      */
-    searchApplication({ authorization, query, requestHeaders }?: CommonPlatformValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonPlatformModel.ApplicationResponse>;
+    searchApplication({ authorization, query, requestHeaders }?: CommonPlatformValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonPlatformModel.ApplicationResponseSchema>;
 }
 import CommonPlatformValidator = require("./CommonPlatformValidator");
 import CommonPlatformModel = require("./CommonPlatformModel");

package/sdk/platform/Common/CommonPlatformClient.js

@@ -20,7 +20,7 @@ class Common {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<CommonPlatformModel.Locations>} - Success response
    * @name getLocations
-   * @summary: Get company locations.
+   * @summary: Get company locations
    * @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/getLocations/).
    */
   async getLocations(
@@ -93,10 +93,11 @@ class Common {
    * @param {CommonPlatformValidator.SearchApplicationParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CommonPlatformModel.ApplicationResponse>} - Success response
+   * @returns {Promise<CommonPlatformModel.ApplicationResponseSchema>} -
+   *   Success response
    * @name searchApplication
-   * @summary: Search for applications.
-   * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/searchApplication/).
+   * @summary: List sales channel categories
+   * @description: This API retrieves details for a specific sales channel based on the provided search criteria. The search can be performed using the name of the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/searchApplication/).
    */
   async searchApplication(
     { authorization, query, requestHeaders } = { requestHeaders: {} },
@@ -147,7 +148,7 @@ class Common {
 
     const {
       error: res_error,
-    } = CommonPlatformModel.ApplicationResponse().validate(responseData, {
+    } = CommonPlatformModel.ApplicationResponseSchema().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

package/sdk/platform/Common/CommonPlatformModel.d.ts

@@ -1,9 +1,9 @@
 export = CommonPlatformModel;
 /**
- * @typedef ApplicationResponse
+ * @typedef ApplicationResponseSchema
  * @property {Application} [application]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the current sales channel supported currency
+ * @property {string} [_id] - The unique identifier of the current sales channel
+ *   supported currency
  * @property {boolean} [is_active] - Shows currency is enabled or not in current
  *   sales channel
  * @property {string} [name] - Name of the currency, e.g. Indian Rupee
@@ -24,8 +24,7 @@ export = CommonPlatformModel;
  * @property {boolean} [is_primary] - Indicates domain is primary or not.
  *   Primary domain is the default/main domain.
  * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {string} [name]
  * @property {boolean} [is_predefined] - Domain is hosting domain or not
  */
@@ -76,11 +75,9 @@ export = CommonPlatformModel;
  *   internal or not
  * @property {boolean} [is_active] - Indicates whether a sales channel is active
  *   or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
  * @property {string} [token] - Randomly generated fixed-length string for sales
@@ -104,7 +101,7 @@ export = CommonPlatformModel;
  * @property {string} [message] - Response message for not found
  */
 /**
- * @typedef BadRequest
+ * @typedef BadRequestSchema
  * @property {string} [message] - Failure message (in a string format)
  */
 /**
@@ -145,15 +142,15 @@ export = CommonPlatformModel;
 declare class CommonPlatformModel {
 }
 declare namespace CommonPlatformModel {
-    export { ApplicationResponse, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, NotFound, BadRequest, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
+    export { ApplicationResponseSchema, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, NotFound, BadRequestSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
 }
-/** @returns {ApplicationResponse} */
-declare function ApplicationResponse(): ApplicationResponse;
-type ApplicationResponse = {
+/** @returns {ApplicationResponseSchema} */
+declare function ApplicationResponseSchema(): ApplicationResponseSchema;
+type ApplicationResponseSchema = {
     application?: Application;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the current sales channel supported currency
+     * - The unique identifier of the current sales channel
+     * supported currency
      */
     _id?: string;
     /**
@@ -208,8 +205,7 @@ type Domain = {
      */
     is_shortlink?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the domain
+     * - The unique identifier of the domain
      */
     _id?: string;
     name?: string;
@@ -315,8 +311,7 @@ type Application = {
      */
     is_active?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel
+     * - The unique identifier of the sales channel
      */
     _id?: string;
     /**
@@ -324,8 +319,7 @@ type Application = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of owner who owns the application
+     * - The unique identifier of owner who owns the application
      */
     owner?: string;
     /**
@@ -372,9 +366,9 @@ type NotFound = {
      */
     message?: string;
 };
-/** @returns {BadRequest} */
-declare function BadRequest(): BadRequest;
-type BadRequest = {
+/** @returns {BadRequestSchema} */
+declare function BadRequestSchema(): BadRequestSchema;
+type BadRequestSchema = {
     /**
      * - Failure message (in a string format)
      */

package/sdk/platform/Common/CommonPlatformModel.js

@@ -1,10 +1,10 @@
 const Joi = require("joi");
 
 /**
- * @typedef ApplicationResponse
+ * @typedef ApplicationResponseSchema
  * @property {Application} [application]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the current sales channel supported currency
+ * @property {string} [_id] - The unique identifier of the current sales channel
+ *   supported currency
  * @property {boolean} [is_active] - Shows currency is enabled or not in current
  *   sales channel
  * @property {string} [name] - Name of the currency, e.g. Indian Rupee
@@ -26,8 +26,7 @@ const Joi = require("joi");
  * @property {boolean} [is_primary] - Indicates domain is primary or not.
  *   Primary domain is the default/main domain.
  * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {string} [name]
  * @property {boolean} [is_predefined] - Domain is hosting domain or not
  */
@@ -85,11 +84,9 @@ const Joi = require("joi");
  *   internal or not
  * @property {boolean} [is_active] - Indicates whether a sales channel is active
  *   or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
  * @property {string} [token] - Randomly generated fixed-length string for sales
@@ -115,7 +112,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef BadRequest
+ * @typedef BadRequestSchema
  * @property {string} [message] - Failure message (in a string format)
  */
 
@@ -159,8 +156,8 @@ const Joi = require("joi");
  */
 
 class CommonPlatformModel {
-  /** @returns {ApplicationResponse} */
-  static ApplicationResponse() {
+  /** @returns {ApplicationResponseSchema} */
+  static ApplicationResponseSchema() {
     return Joi.object({
       application: CommonPlatformModel.Application(),
       _id: Joi.string().allow(""),
@@ -272,8 +269,8 @@ class CommonPlatformModel {
     });
   }
 
-  /** @returns {BadRequest} */
-  static BadRequest() {
+  /** @returns {BadRequestSchema} */
+  static BadRequestSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });