@gofynd/fdk-client-javascript 3.17.1 → 3.17.2

package/README.md

@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.17.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.17.2' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "3.17.1",
+  "version": "3.17.2",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/common/Constant.d.ts

@@ -49,6 +49,7 @@ export namespace AVAILABLE_PAGE_TYPE {
     const LOCATE_US: string;
     const SINGLE_PAGE_CHECKOUT: string;
     const REQUEST_REATTEMPT: string;
+    const FILES: string;
 }
 export const NAVIGATORS: {
     "about-us": {
@@ -315,4 +316,12 @@ export const NAVIGATORS: {
             required: boolean;
         }[];
     };
+    files: {
+        name: string;
+        link: string;
+        params: {
+            key: string;
+            required: boolean;
+        }[];
+    };
 };

package/sdk/common/Constant.js

@@ -49,6 +49,7 @@ const AVAILABLE_PAGE_TYPE = {
   LOCATE_US: "locate-us",
   SINGLE_PAGE_CHECKOUT: "single-page-checkout",
   REQUEST_REATTEMPT: "request-reattempt",
+  FILES: "files",
 };
 
 Object.freeze(AVAILABLE_PAGE_TYPE);
@@ -350,6 +351,16 @@ const NAVIGATORS = {
       },
     ],
   },
+  files: {
+    name: "Files",
+    link: "/files/:file_name",
+    params: [
+      {
+        key: "file_name",
+        required: true,
+      },
+    ],
+  },
 };
 
 module.exports = {

package/sdk/partner/Theme/ThemePartnerModel.d.ts

@@ -675,7 +675,8 @@ export = ThemePartnerModel;
  *   | "order-status"
  *   | "locate-us"
  *   | "single-page-checkout"
- *   | "request-reattempt"} PageType
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 declare class ThemePartnerModel {
 }
@@ -1897,4 +1898,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/partner/Theme/ThemePartnerModel.js

@@ -767,7 +767,8 @@ const Joi = require("joi");
  *   | "order-status"
  *   | "locate-us"
  *   | "single-page-checkout"
- *   | "request-reattempt"} PageType
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 
 class ThemePartnerModel {
@@ -1780,7 +1781,9 @@ class ThemePartnerModel {
 
       "single-page-checkout",
 
-      "request-reattempt"
+      "request-reattempt",
+
+      "files"
     );
   }
 }

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

@@ -4930,7 +4930,8 @@ export = CatalogPlatformModel;
  *   | "order-status"
  *   | "locate-us"
  *   | "single-page-checkout"
- *   | "request-reattempt"} PageType
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 declare class CatalogPlatformModel {
 }
@@ -15437,4 +15438,4 @@ type HsTypeEnum = "HS" | "SAC";
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -5411,7 +5411,8 @@ const Joi = require("joi");
  *   | "order-status"
  *   | "locate-us"
  *   | "single-page-checkout"
- *   | "request-reattempt"} PageType
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 
 class CatalogPlatformModel {
@@ -11261,7 +11262,9 @@ class CatalogPlatformModel {
 
       "single-page-checkout",
 
-      "request-reattempt"
+      "request-reattempt",
+
+      "files"
     );
   }
 }

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

@@ -662,6 +662,8 @@ export = CommunicationPlatformModel;
  * @property {SendOtpCommsReqData} [data]
  * @property {SendOtpCommsReqSms} [sms]
  * @property {SendOtpCommsReqEmail} [email]
+ * @property {Object} [additional_variables] - Additional data in key-value
+ *   format where values can be of any type
  */
 /**
  * @typedef SendOtpCommsRes
@@ -1708,6 +1710,11 @@ type SendOtpCommsReq = {
     data?: SendOtpCommsReqData;
     sms?: SendOtpCommsReqSms;
     email?: SendOtpCommsReqEmail;
+    /**
+     * - Additional data in key-value
+     * format where values can be of any type
+     */
+    additional_variables?: any;
 };
 /** @returns {SendOtpCommsRes} */
 declare function SendOtpCommsRes(): SendOtpCommsRes;

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -757,6 +757,8 @@ const Joi = require("joi");
  * @property {SendOtpCommsReqData} [data]
  * @property {SendOtpCommsReqSms} [sms]
  * @property {SendOtpCommsReqEmail} [email]
+ * @property {Object} [additional_variables] - Additional data in key-value
+ *   format where values can be of any type
  */
 
 /**
@@ -1992,6 +1994,7 @@ class CommunicationPlatformModel {
       data: CommunicationPlatformModel.SendOtpCommsReqData(),
       sms: CommunicationPlatformModel.SendOtpCommsReqSms(),
       email: CommunicationPlatformModel.SendOtpCommsReqEmail(),
+      additional_variables: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 

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

@@ -269,8 +269,8 @@ export = ContentPlatformApplicationValidator;
 /** @typedef GetDefaultNavigationsParam */
 /**
  * @typedef GetDefaultSEOMarkupSchemaParam
- * @property {string} [pageType] - The type of page against which schema
- *   template was created
+ * @property {ContentPlatformModel.PageType} [pageType] - The type of page
+ *   against which schema template was created
  */
 /**
  * @typedef GetFaqByIdOrSlugParam
@@ -1023,10 +1023,10 @@ type GetDataLoadersByServiceParam = {
 };
 type GetDefaultSEOMarkupSchemaParam = {
     /**
-     * - The type of page against which schema
-     * template was created
+     * - The type of page
+     * against which schema template was created
      */
-    pageType?: string;
+    pageType?: ContentPlatformModel.PageType;
 };
 type GetFaqByIdOrSlugParam = {
     /**

package/sdk/platform/Content/ContentPlatformApplicationValidator.js

@@ -330,8 +330,8 @@ const ContentPlatformModel = require("./ContentPlatformModel");
 
 /**
  * @typedef GetDefaultSEOMarkupSchemaParam
- * @property {string} [pageType] - The type of page against which schema
- *   template was created
+ * @property {ContentPlatformModel.PageType} [pageType] - The type of page
+ *   against which schema template was created
  */
 
 /**
@@ -1059,7 +1059,7 @@ class ContentPlatformApplicationValidator {
   /** @returns {GetDefaultSEOMarkupSchemaParam} */
   static getDefaultSEOMarkupSchema() {
     return Joi.object({
-      pageType: Joi.string().allow(""),
+      pageType: ContentPlatformModel.PageType(),
     }).required();
   }
 

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

@@ -86,7 +86,7 @@ export = ContentPlatformModel;
  * @typedef SEOSchemaMarkupTemplate
  * @property {string} [id]
  * @property {string} [title]
- * @property {string} [page_type]
+ * @property {PageType} [page_type]
  * @property {string} [schema]
  * @property {string} [description]
  * @property {boolean} [active]
@@ -98,7 +98,7 @@ export = ContentPlatformModel;
 /**
  * @typedef SEOSchemaMarkupTemplateRequestBody
  * @property {string} [title]
- * @property {string} [page_type]
+ * @property {PageType} [page_type]
  * @property {string} [schema]
  * @property {string} [description]
  * @property {Object} [target_json]
@@ -143,7 +143,7 @@ export = ContentPlatformModel;
  */
 /**
  * @typedef DefaultSEOSchemaMarkupTemplate
- * @property {string} [page_type]
+ * @property {PageType} [page_type]
  * @property {string} [schema]
  * @property {Object} [target_json]
  */
@@ -1623,7 +1623,8 @@ export = ContentPlatformModel;
  *   | "order-status"
  *   | "locate-us"
  *   | "single-page-checkout"
- *   | "request-reattempt"} PageType
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 declare class ContentPlatformModel {
 }
@@ -1736,7 +1737,7 @@ declare function SEOSchemaMarkupTemplate(): SEOSchemaMarkupTemplate;
 type SEOSchemaMarkupTemplate = {
     id?: string;
     title?: string;
-    page_type?: string;
+    page_type?: PageType;
     schema?: string;
     description?: string;
     active?: boolean;
@@ -1749,7 +1750,7 @@ type SEOSchemaMarkupTemplate = {
 declare function SEOSchemaMarkupTemplateRequestBody(): SEOSchemaMarkupTemplateRequestBody;
 type SEOSchemaMarkupTemplateRequestBody = {
     title?: string;
-    page_type?: string;
+    page_type?: PageType;
     schema?: string;
     description?: string;
     target_json?: any;
@@ -1800,7 +1801,7 @@ type DefaultSchemaComponent = {
 /** @returns {DefaultSEOSchemaMarkupTemplate} */
 declare function DefaultSEOSchemaMarkupTemplate(): DefaultSEOSchemaMarkupTemplate;
 type DefaultSEOSchemaMarkupTemplate = {
-    page_type?: string;
+    page_type?: PageType;
     schema?: string;
     target_json?: any;
 };
@@ -4649,4 +4650,4 @@ type GenerationEntityType = "title" | "description";
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/platform/Content/ContentPlatformModel.js

@@ -99,7 +99,7 @@ const Joi = require("joi");
  * @typedef SEOSchemaMarkupTemplate
  * @property {string} [id]
  * @property {string} [title]
- * @property {string} [page_type]
+ * @property {PageType} [page_type]
  * @property {string} [schema]
  * @property {string} [description]
  * @property {boolean} [active]
@@ -112,7 +112,7 @@ const Joi = require("joi");
 /**
  * @typedef SEOSchemaMarkupTemplateRequestBody
  * @property {string} [title]
- * @property {string} [page_type]
+ * @property {PageType} [page_type]
  * @property {string} [schema]
  * @property {string} [description]
  * @property {Object} [target_json]
@@ -163,7 +163,7 @@ const Joi = require("joi");
 
 /**
  * @typedef DefaultSEOSchemaMarkupTemplate
- * @property {string} [page_type]
+ * @property {PageType} [page_type]
  * @property {string} [schema]
  * @property {Object} [target_json]
  */
@@ -1825,7 +1825,8 @@ const Joi = require("joi");
  *   | "order-status"
  *   | "locate-us"
  *   | "single-page-checkout"
- *   | "request-reattempt"} PageType
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 
 class ContentPlatformModel {
@@ -1953,7 +1954,7 @@ class ContentPlatformModel {
     return Joi.object({
       id: Joi.string().allow(""),
       title: Joi.string().allow(""),
-      page_type: Joi.string().allow(""),
+      page_type: ContentPlatformModel.PageType(),
       schema: Joi.string().allow(""),
       description: Joi.string().allow(""),
       active: Joi.boolean(),
@@ -1968,7 +1969,7 @@ class ContentPlatformModel {
   static SEOSchemaMarkupTemplateRequestBody() {
     return Joi.object({
       title: Joi.string().allow(""),
-      page_type: Joi.string().allow(""),
+      page_type: ContentPlatformModel.PageType(),
       schema: Joi.string().allow(""),
       description: Joi.string().allow(""),
       target_json: Joi.object().pattern(/\S/, Joi.any()),
@@ -2033,7 +2034,7 @@ class ContentPlatformModel {
   /** @returns {DefaultSEOSchemaMarkupTemplate} */
   static DefaultSEOSchemaMarkupTemplate() {
     return Joi.object({
-      page_type: Joi.string().allow(""),
+      page_type: ContentPlatformModel.PageType(),
       schema: Joi.string().allow(""),
       target_json: Joi.object().pattern(/\S/, Joi.any()),
     });
@@ -4064,7 +4065,9 @@ class ContentPlatformModel {
 
       "single-page-checkout",
 
-      "request-reattempt"
+      "request-reattempt",
+
+      "files"
     );
   }
 }

package/sdk/platform/Order/OrderPlatformClient.d.ts

@@ -85,7 +85,7 @@ declare class Order {
      * @returns {Promise<Object>} - Success response
      * @name createOrder
      * @summary: Create Order
-     * @description: Creates an order in the OMS. Note: Use the Serviceability API (<a href='/commerce/sdk/latest/platform/company/serviceability#createShipments'>createShipments</a>) to determine shipments before creating an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
+     * @description: Creates an order in the OMS. Use the (<a href='https://docs.fynd.com/partners/commerce/sdk/latest/platform/application/serviceability#createShipments'>createShipments API</a>) to determine shipments before creating an order.  Click <a href='https://docs.fynd.com/partners/commerce/miscellaneous/createOrder-useCases'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
      */
     createOrder({ xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<any>;
     /**

package/sdk/platform/Order/OrderPlatformClient.js

@@ -604,7 +604,7 @@ class Order {
    * @returns {Promise<Object>} - Success response
    * @name createOrder
    * @summary: Create Order
-   * @description: Creates an order in the OMS. Note: Use the Serviceability API (<a href='/commerce/sdk/latest/platform/company/serviceability#createShipments'>createShipments</a>) to determine shipments before creating an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
+   * @description: Creates an order in the OMS. Use the (<a href='https://docs.fynd.com/partners/commerce/sdk/latest/platform/application/serviceability#createShipments'>createShipments API</a>) to determine shipments before creating an order.  Click <a href='https://docs.fynd.com/partners/commerce/miscellaneous/createOrder-useCases'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
    */
   async createOrder(
     { xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders } = {

package/sdk/platform/Theme/ThemePlatformModel.d.ts

@@ -603,7 +603,8 @@ export = ThemePlatformModel;
  *   | "order-status"
  *   | "locate-us"
  *   | "single-page-checkout"
- *   | "request-reattempt"} PageType
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 declare class ThemePlatformModel {
 }
@@ -1666,4 +1667,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -686,7 +686,8 @@ const Joi = require("joi");
  *   | "order-status"
  *   | "locate-us"
  *   | "single-page-checkout"
- *   | "request-reattempt"} PageType
+ *   | "request-reattempt"
+ *   | "files"} PageType
  */
 
 class ThemePlatformModel {
@@ -1598,7 +1599,9 @@ class ThemePlatformModel {
 
       "single-page-checkout",
 
-      "request-reattempt"
+      "request-reattempt",
+
+      "files"
     );
   }
 }