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

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,13 +16,12 @@ 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.ApplicationResponseSchema>} -
-     *   Success response
+     * @returns {Promise<CommonPlatformModel.ApplicationResponse>} - Success response
      * @name 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/).
+     * @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/).
      */
-    searchApplication({ authorization, query, requestHeaders }?: CommonPlatformValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonPlatformModel.ApplicationResponseSchema>;
+    searchApplication({ authorization, query, requestHeaders }?: CommonPlatformValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonPlatformModel.ApplicationResponse>;
 }
 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,11 +93,10 @@ class Common {
    * @param {CommonPlatformValidator.SearchApplicationParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CommonPlatformModel.ApplicationResponseSchema>} -
-   *   Success response
+   * @returns {Promise<CommonPlatformModel.ApplicationResponse>} - Success response
    * @name 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/).
+   * @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/).
    */
   async searchApplication(
     { authorization, query, requestHeaders } = { requestHeaders: {} },
@@ -148,7 +147,7 @@ class Common {
 
     const {
       error: res_error,
-    } = CommonPlatformModel.ApplicationResponseSchema().validate(responseData, {
+    } = CommonPlatformModel.ApplicationResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

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

@@ -1,6 +1,6 @@
 export = CommonPlatformModel;
 /**
- * @typedef ApplicationResponseSchema
+ * @typedef ApplicationResponse
  * @property {Application} [application]
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
  *   of the current sales channel supported currency
@@ -104,7 +104,7 @@ export = CommonPlatformModel;
  * @property {string} [message] - Response message for not found
  */
 /**
- * @typedef BadRequestSchema
+ * @typedef BadRequest
  * @property {string} [message] - Failure message (in a string format)
  */
 /**
@@ -145,11 +145,11 @@ export = CommonPlatformModel;
 declare class CommonPlatformModel {
 }
 declare namespace CommonPlatformModel {
-    export { ApplicationResponseSchema, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, NotFound, BadRequestSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
+    export { ApplicationResponse, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, NotFound, BadRequest, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
 }
-/** @returns {ApplicationResponseSchema} */
-declare function ApplicationResponseSchema(): ApplicationResponseSchema;
-type ApplicationResponseSchema = {
+/** @returns {ApplicationResponse} */
+declare function ApplicationResponse(): ApplicationResponse;
+type ApplicationResponse = {
     application?: Application;
     /**
      * - The unique identifier (24-digit Mongo Object ID)
@@ -372,9 +372,9 @@ type NotFound = {
      */
     message?: string;
 };
-/** @returns {BadRequestSchema} */
-declare function BadRequestSchema(): BadRequestSchema;
-type BadRequestSchema = {
+/** @returns {BadRequest} */
+declare function BadRequest(): BadRequest;
+type BadRequest = {
     /**
      * - Failure message (in a string format)
      */

package/sdk/platform/Common/CommonPlatformModel.js

@@ -1,7 +1,7 @@
 const Joi = require("joi");
 
 /**
- * @typedef ApplicationResponseSchema
+ * @typedef ApplicationResponse
  * @property {Application} [application]
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
  *   of the current sales channel supported currency
@@ -115,7 +115,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef BadRequestSchema
+ * @typedef BadRequest
  * @property {string} [message] - Failure message (in a string format)
  */
 
@@ -159,8 +159,8 @@ const Joi = require("joi");
  */
 
 class CommonPlatformModel {
-  /** @returns {ApplicationResponseSchema} */
-  static ApplicationResponseSchema() {
+  /** @returns {ApplicationResponse} */
+  static ApplicationResponse() {
     return Joi.object({
       application: CommonPlatformModel.Application(),
       _id: Joi.string().allow(""),
@@ -272,8 +272,8 @@ class CommonPlatformModel {
     });
   }
 
-  /** @returns {BadRequestSchema} */
-  static BadRequestSchema() {
+  /** @returns {BadRequest} */
+  static BadRequest() {
     return Joi.object({
       message: Joi.string().allow(""),
     });