@gofynd/fdk-client-javascript 1.6.3 → 2.0.0

package/sdk/platform/Order/OrderPlatformModel.js

@@ -307,6 +307,12 @@ const Joi = require("joi");
  * @property {OrderDataUpdates[]} [order]
  */
 
+/**
+ * @typedef TransitionComments
+ * @property {string} title - Title for the transition message.
+ * @property {string} message - Message for the transition.
+ */
+
 /**
  * @typedef ShipmentsRequestSchema
  * @property {string} identifier - Unique identifier for the shipment.
@@ -314,6 +320,8 @@ const Joi = require("joi");
  * @property {Products[]} [products] - A list of products or bags that need to
  *   be updated as part of the shipment status change.
  * @property {DataUpdates} [data_updates]
+ * @property {TransitionComments[]} [transition_comments] - Comments or notes
+ *   associated with the transition of shipment status.
  */
 
 /**
@@ -726,8 +734,8 @@ const Joi = require("joi");
  * @property {string} [text] - A reason for the activity or change.
  * @property {string} [category] - Category of the reason for the status change.
  * @property {string} [state] - Current state related to the reason.
- * @property {string} [dislay_name] - Display name of the reason for better user
- *   understanding.
+ * @property {string} [display_name] - Display name of the reason for better
+ *   user understanding.
  * @property {number} [code] - Unique code identifying the reason.
  * @property {number} [quantity] - Quantity related to the reason, if applicable.
  */
@@ -2624,9 +2632,9 @@ const Joi = require("joi");
  *   met and optimizing logistics.
  * @property {QuestionSet[]} question_set - An array of question sets linked to
  *   the reason, defining the questions to be answered.
- * @property {Object} meta - Meta object of the reason. This contains any
+ * @property {Object} [meta] - Meta object of the reason. This contains any
  *   additional metadata that might be relevant to the reason.
- * @property {boolean} is_active - Indicates whether the reason is currently
+ * @property {boolean} [is_active] - Indicates whether the reason is currently
  *   active. Active reasons are those that are currently in use within the system.
  */
 
@@ -2783,6 +2791,7 @@ const Joi = require("joi");
  * @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.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -2941,6 +2950,7 @@ const Joi = require("joi");
  * @property {string} [uid] - A unique identifier for the user associated with
  *   the address.
  * @property {string} [user_id] - The unique identifier of the user in the system.
+ * @property {string} [code] - A unique identifier associated with store.
  */
 
 /**
@@ -3850,6 +3860,8 @@ const Joi = require("joi");
  *   at the ordering store.
  * @property {string} [state] - The state or region where the ordering store is situated.
  * @property {string} [city] - The city in which the ordering store is located.
+ * @property {string} [name] - The name of the ordering store.
+ * @property {string} [store_email] - The email address of the ordering store.
  */
 
 /**
@@ -4095,6 +4107,8 @@ const Joi = require("joi");
  * @property {string} [size] - The size of the article, which may be relevant
  *   for clothing.
  * @property {string[]} [tags] - An array of tags associated with the article.
+ * @property {Object} [_custom_json] - A custom JSON object containing
+ *   additional details or configurations specific to the article.
  */
 
 /**
@@ -4324,6 +4338,7 @@ const Joi = require("joi");
  *   with a fulfilling store.
  * @property {string} state - The state or region where the fulfilling store is located.
  * @property {string} city - The city in which the fulfilling store is situated.
+ * @property {string} [store_email] - The email address of the fulfilling store.
  */
 
 /**
@@ -5574,6 +5589,14 @@ class OrderPlatformModel {
     });
   }
 
+  /** @returns {TransitionComments} */
+  static TransitionComments() {
+    return Joi.object({
+      title: Joi.string().allow("").required(),
+      message: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {ShipmentsRequestSchema} */
   static ShipmentsRequestSchema() {
     return Joi.object({
@@ -5581,6 +5604,9 @@ class OrderPlatformModel {
       reasons: OrderPlatformModel.ReasonsData(),
       products: Joi.array().items(OrderPlatformModel.Products()),
       data_updates: OrderPlatformModel.DataUpdates(),
+      transition_comments: Joi.array().items(
+        OrderPlatformModel.TransitionComments()
+      ),
     });
   }
 
@@ -6013,7 +6039,7 @@ class OrderPlatformModel {
       text: Joi.string().allow("").allow(null),
       category: Joi.string().allow("").allow(null),
       state: Joi.string().allow("").allow(null),
-      dislay_name: Joi.string().allow("").allow(null),
+      display_name: Joi.string().allow("").allow(null),
       code: Joi.number().allow(null),
       quantity: Joi.number().allow(null),
     });
@@ -7708,8 +7734,8 @@ class OrderPlatformModel {
       question_set: Joi.array()
         .items(OrderPlatformModel.QuestionSet())
         .required(),
-      meta: Joi.object().pattern(/\S/, Joi.any()).required(),
-      is_active: Joi.boolean().required(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
+      is_active: Joi.boolean(),
     }).id("Reason");
   }
 
@@ -7856,6 +7882,7 @@ class OrderPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 
@@ -7966,6 +7993,7 @@ class OrderPlatformModel {
       state_code: Joi.string().allow(""),
       uid: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
+      code: Joi.string().allow("").allow(null),
     }).allow(null);
   }
 
@@ -8601,6 +8629,8 @@ class OrderPlatformModel {
       contact_person: Joi.string().allow("").allow(null),
       state: Joi.string().allow("").allow(null),
       city: Joi.string().allow("").allow(null),
+      name: Joi.string().allow("").allow(null),
+      store_email: Joi.string().allow("").allow(null),
     });
   }
 
@@ -8788,6 +8818,7 @@ class OrderPlatformModel {
       uid: Joi.string().allow("").allow(null),
       size: Joi.string().allow("").allow(null),
       tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
+      _custom_json: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
     });
   }
 
@@ -8973,6 +9004,7 @@ class OrderPlatformModel {
       contact_person: Joi.string().allow("").required(),
       state: Joi.string().allow("").required(),
       city: Joi.string().allow("").required(),
+      store_email: Joi.string().allow("").allow(null),
     });
   }
 

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

@@ -55,6 +55,14 @@ export = OrderPlatformValidator;
  * @typedef FailedOrderLogDetailsParam
  * @property {string} logId - Log Error ID
  */
+/**
+ * @typedef FailedOrderLogsParam
+ * @property {string} [applicationId] - Application ID
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {string} [searchType] - Search type for filter
+ * @property {string} [searchValue] - Search value for filter
+ */
 /**
  * @typedef FetchRefundModeConfigParam
  * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
@@ -476,6 +484,8 @@ declare class OrderPlatformValidator {
     static eInvoiceRetry(): EInvoiceRetryParam;
     /** @returns {FailedOrderLogDetailsParam} */
     static failedOrderLogDetails(): FailedOrderLogDetailsParam;
+    /** @returns {FailedOrderLogsParam} */
+    static failedOrderLogs(): FailedOrderLogsParam;
     /** @returns {FetchRefundModeConfigParam} */
     static fetchRefundModeConfig(): FetchRefundModeConfigParam;
     /** @returns {GenerateInvoiceIDParam} */
@@ -568,7 +578,7 @@ declare class OrderPlatformValidator {
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace OrderPlatformValidator {
-    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
+    export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
 }
 type AddStateManagerConfigParam = {
     body: OrderPlatformModel.TransitionConfigPayload;
@@ -641,6 +651,28 @@ type FailedOrderLogDetailsParam = {
      */
     logId: string;
 };
+type FailedOrderLogsParam = {
+    /**
+     * - Application ID
+     */
+    applicationId?: string;
+    /**
+     * - Page Number
+     */
+    pageNo?: number;
+    /**
+     * - Page Size
+     */
+    pageSize?: number;
+    /**
+     * - Search type for filter
+     */
+    searchType?: string;
+    /**
+     * - Search value for filter
+     */
+    searchValue?: string;
+};
 type FetchRefundModeConfigParam = {
     body: OrderPlatformModel.RefundModeConfigRequestPayload;
 };

package/sdk/platform/Order/OrderPlatformValidator.js

@@ -70,6 +70,15 @@ const OrderPlatformModel = require("./OrderPlatformModel");
  * @property {string} logId - Log Error ID
  */
 
+/**
+ * @typedef FailedOrderLogsParam
+ * @property {string} [applicationId] - Application ID
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {string} [searchType] - Search type for filter
+ * @property {string} [searchValue] - Search value for filter
+ */
+
 /**
  * @typedef FetchRefundModeConfigParam
  * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
@@ -602,6 +611,17 @@ class OrderPlatformValidator {
     }).required();
   }
 
+  /** @returns {FailedOrderLogsParam} */
+  static failedOrderLogs() {
+    return Joi.object({
+      applicationId: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      searchType: Joi.string().allow(""),
+      searchValue: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {FetchRefundModeConfigParam} */
   static fetchRefundModeConfig() {
     return Joi.object({

package/sdk/platform/Partner/PartnerPlatformModel.d.ts

@@ -7,19 +7,28 @@ export = PartnerPlatformModel;
  */
 /**
  * @typedef ExtensionProxyPathCreation
- * @property {string} [_id]
- * @property {string} [attached_path]
- * @property {string} [proxy_url]
- * @property {string} [company_id]
- * @property {string} [application_id]
- * @property {string} [extension_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
+ * @property {string} [_id] - Unique identifier for the proxy URL entry in the database.
+ * @property {string} [attached_path] - The slug path appended to the base URL
+ *   for creating the proxy endpoint.
+ * @property {string} [proxy_url] - The external URL that the proxy endpoint
+ *   will forward requests to.
+ * @property {string} [company_id] - Unique identifier of the company that owns
+ *   the proxy URL.
+ * @property {string} [application_id] - Unique identifier of the application
+ *   associated with the proxy URL.
+ * @property {string} [extension_id] - Unique identifier of the extension where
+ *   the proxy URL is configured.
+ * @property {string} [created_at] - The timestamp indicating when the proxy URL
+ *   configuration was created.
+ * @property {string} [modified_at] - The timestamp indicating the last update
+ *   made to the proxy URL configuration.
  */
 /**
  * @typedef ExtensionProxyPathDelete
- * @property {string} [message]
- * @property {Object} [data]
+ * @property {string} [message] - Descriptive message indicating the status or
+ *   result of the deletion operation.
+ * @property {Object} [data] - Additional information or metadata about the
+ *   deleted proxy configuration.
  */
 /**
  * @typedef APIError
@@ -50,19 +59,58 @@ type AddProxyReq = {
 /** @returns {ExtensionProxyPathCreation} */
 declare function ExtensionProxyPathCreation(): ExtensionProxyPathCreation;
 type ExtensionProxyPathCreation = {
+    /**
+     * - Unique identifier for the proxy URL entry in the database.
+     */
     _id?: string;
+    /**
+     * - The slug path appended to the base URL
+     * for creating the proxy endpoint.
+     */
     attached_path?: string;
+    /**
+     * - The external URL that the proxy endpoint
+     * will forward requests to.
+     */
     proxy_url?: string;
+    /**
+     * - Unique identifier of the company that owns
+     * the proxy URL.
+     */
     company_id?: string;
+    /**
+     * - Unique identifier of the application
+     * associated with the proxy URL.
+     */
     application_id?: string;
+    /**
+     * - Unique identifier of the extension where
+     * the proxy URL is configured.
+     */
     extension_id?: string;
+    /**
+     * - The timestamp indicating when the proxy URL
+     * configuration was created.
+     */
     created_at?: string;
+    /**
+     * - The timestamp indicating the last update
+     * made to the proxy URL configuration.
+     */
     modified_at?: string;
 };
 /** @returns {ExtensionProxyPathDelete} */
 declare function ExtensionProxyPathDelete(): ExtensionProxyPathDelete;
 type ExtensionProxyPathDelete = {
+    /**
+     * - Descriptive message indicating the status or
+     * result of the deletion operation.
+     */
     message?: string;
+    /**
+     * - Additional information or metadata about the
+     * deleted proxy configuration.
+     */
     data?: any;
 };
 /** @returns {APIError} */

package/sdk/platform/Partner/PartnerPlatformModel.js

@@ -9,20 +9,29 @@ const Joi = require("joi");
 
 /**
  * @typedef ExtensionProxyPathCreation
- * @property {string} [_id]
- * @property {string} [attached_path]
- * @property {string} [proxy_url]
- * @property {string} [company_id]
- * @property {string} [application_id]
- * @property {string} [extension_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
+ * @property {string} [_id] - Unique identifier for the proxy URL entry in the database.
+ * @property {string} [attached_path] - The slug path appended to the base URL
+ *   for creating the proxy endpoint.
+ * @property {string} [proxy_url] - The external URL that the proxy endpoint
+ *   will forward requests to.
+ * @property {string} [company_id] - Unique identifier of the company that owns
+ *   the proxy URL.
+ * @property {string} [application_id] - Unique identifier of the application
+ *   associated with the proxy URL.
+ * @property {string} [extension_id] - Unique identifier of the extension where
+ *   the proxy URL is configured.
+ * @property {string} [created_at] - The timestamp indicating when the proxy URL
+ *   configuration was created.
+ * @property {string} [modified_at] - The timestamp indicating the last update
+ *   made to the proxy URL configuration.
  */
 
 /**
  * @typedef ExtensionProxyPathDelete
- * @property {string} [message]
- * @property {Object} [data]
+ * @property {string} [message] - Descriptive message indicating the status or
+ *   result of the deletion operation.
+ * @property {Object} [data] - Additional information or metadata about the
+ *   deleted proxy configuration.
  */
 
 /**

package/sdk/platform/Payment/PaymentPlatformModel.d.ts

@@ -542,6 +542,7 @@ export = PaymentPlatformModel;
  * @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.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef EdcDeviceListDetails
@@ -1230,6 +1231,7 @@ export = PaymentPlatformModel;
  * @property {string} aggregator - Aggregator name of the payment gateway.
  * @property {number} transaction_amount - Payable amount
  * @property {string} [cart_id] - Unique identifier for the shopping cart.
+ * @property {string} [user_id] - The unique identifier of the user.
  */
 /**
  * @typedef UserCreditSchema
@@ -1246,7 +1248,7 @@ export = PaymentPlatformModel;
  *   it is ACTIVE, INACTIVE, or UNREGISTERED.
  * @property {UserCreditSchema} [redeemable_balance]
  * @property {UserCreditSchema} [available_balance]
- * @property {UserCreditSchema} [amount_on_hold]
+ * @property {UserCreditSchema[]} [amount_on_hold]
  */
 /**
  * @typedef ValidateCustomerCreditSchema
@@ -2699,6 +2701,10 @@ type Page = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The number of items per page.
+     */
+    page_size?: number;
 };
 /** @returns {EdcDeviceListDetails} */
 declare function EdcDeviceListDetails(): EdcDeviceListDetails;
@@ -4518,6 +4524,10 @@ type CustomerValidationSchema = {
      * - Unique identifier for the shopping cart.
      */
     cart_id?: string;
+    /**
+     * - The unique identifier of the user.
+     */
+    user_id?: string;
 };
 /** @returns {UserCreditSchema} */
 declare function UserCreditSchema(): UserCreditSchema;
@@ -4551,7 +4561,7 @@ type CreditAccountSummary = {
     status: string;
     redeemable_balance?: UserCreditSchema;
     available_balance?: UserCreditSchema;
-    amount_on_hold?: UserCreditSchema;
+    amount_on_hold?: UserCreditSchema[];
 };
 /** @returns {ValidateCustomerCreditSchema} */
 declare function ValidateCustomerCreditSchema(): ValidateCustomerCreditSchema;

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -611,6 +611,7 @@ const Joi = require("joi");
  * @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.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -1374,6 +1375,7 @@ const Joi = require("joi");
  * @property {string} aggregator - Aggregator name of the payment gateway.
  * @property {number} transaction_amount - Payable amount
  * @property {string} [cart_id] - Unique identifier for the shopping cart.
+ * @property {string} [user_id] - The unique identifier of the user.
  */
 
 /**
@@ -1392,7 +1394,7 @@ const Joi = require("joi");
  *   it is ACTIVE, INACTIVE, or UNREGISTERED.
  * @property {UserCreditSchema} [redeemable_balance]
  * @property {UserCreditSchema} [available_balance]
- * @property {UserCreditSchema} [amount_on_hold]
+ * @property {UserCreditSchema[]} [amount_on_hold]
  */
 
 /**
@@ -2164,6 +2166,7 @@ class PaymentPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 
@@ -3050,6 +3053,7 @@ class PaymentPlatformModel {
       aggregator: Joi.string().allow("").required(),
       transaction_amount: Joi.number().required(),
       cart_id: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
     });
   }
 
@@ -3069,7 +3073,9 @@ class PaymentPlatformModel {
       status: Joi.string().allow("").required(),
       redeemable_balance: PaymentPlatformModel.UserCreditSchema(),
       available_balance: PaymentPlatformModel.UserCreditSchema(),
-      amount_on_hold: PaymentPlatformModel.UserCreditSchema(),
+      amount_on_hold: Joi.array().items(
+        PaymentPlatformModel.UserCreditSchema()
+      ),
     });
   }
 

package/sdk/platform/Rewards/RewardsPlatformModel.d.ts

@@ -57,6 +57,7 @@ export = RewardsPlatformModel;
  * @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.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef Offer
@@ -254,6 +255,10 @@ type Page = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The number of items per page.
+     */
+    page_size?: number;
 };
 /** @returns {Offer} */
 declare function Offer(): Offer;

package/sdk/platform/Rewards/RewardsPlatformModel.js

@@ -65,6 +65,7 @@ const Joi = require("joi");
  * @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.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -264,6 +265,7 @@ class RewardsPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }