@gofynd/fdk-client-javascript 1.4.6 → 1.4.8-beta.2

package/sdk/application/Lead/LeadApplicationModel.js

@@ -12,45 +12,6 @@ const Joi = require("joi");
  * @property {TicketAsset[]} [attachments] - List of all attachments related to the form
  */
 
-/**
- * @typedef GetTokenForVideoRoomResponse
- * @property {string} access_token - Access token to be used for video room
- */
-
-/**
- * @typedef GetParticipantsInsideVideoRoomResponse
- * @property {Participant[]} participants - List of participants of the video room
- */
-
-/**
- * @typedef Participant
- * @property {UserSchema} [user]
- * @property {string} [identity] - Unique identifier of participant
- * @property {string} [status] - Status of participant
- */
-
-/**
- * @typedef UserSchema
- * @property {string} [application_id]
- * @property {string} [user_id]
- * @property {string} [first_name]
- * @property {Object} [meta]
- * @property {string} [last_name]
- * @property {PhoneNumber[]} [phone_numbers]
- * @property {Email[]} [emails]
- * @property {string} [gender]
- * @property {string} [dob]
- * @property {boolean} [active]
- * @property {string} [profile_pic_url]
- * @property {string} [username]
- * @property {string} [account_type]
- * @property {string} [_id]
- * @property {string} [created_at]
- * @property {string} [updated_at]
- * @property {string} [external_id]
- * @property {string} [rr_id]
- */
-
 /**
  * @typedef SubmitCustomFormResponse
  * @property {string} message - Success message for form submission
@@ -195,23 +156,6 @@ const Joi = require("joi");
  * @property {string} [created_at] - Time when the ticket was created
  */
 
-/**
- * @typedef PhoneNumber
- * @property {string} [phone] - Phone number
- * @property {number} [country_code] - Country code
- * @property {boolean} [active] - Is the phone number active
- * @property {boolean} [primary] - Is it a primary phone number
- * @property {boolean} [verified] - Is the phone number verified
- */
-
-/**
- * @typedef Email
- * @property {string} [email] - Email address
- * @property {boolean} [active] - Is the email active
- * @property {boolean} [primary] - Is it a primary email
- * @property {boolean} [verified] - Is the email verified
- */
-
 /** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
 
 /** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
@@ -247,55 +191,6 @@ class LeadApplicationModel {
     });
   }
 
-  /** @returns {GetTokenForVideoRoomResponse} */
-  static GetTokenForVideoRoomResponse() {
-    return Joi.object({
-      access_token: Joi.string().allow("").required(),
-    });
-  }
-
-  /** @returns {GetParticipantsInsideVideoRoomResponse} */
-  static GetParticipantsInsideVideoRoomResponse() {
-    return Joi.object({
-      participants: Joi.array()
-        .items(LeadApplicationModel.Participant())
-        .required(),
-    });
-  }
-
-  /** @returns {Participant} */
-  static Participant() {
-    return Joi.object({
-      user: LeadApplicationModel.UserSchema(),
-      identity: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {UserSchema} */
-  static UserSchema() {
-    return Joi.object({
-      application_id: Joi.string().allow(""),
-      user_id: Joi.string().allow(""),
-      first_name: Joi.string().allow(""),
-      meta: Joi.any(),
-      last_name: Joi.string().allow(""),
-      phone_numbers: Joi.array().items(LeadApplicationModel.PhoneNumber()),
-      emails: Joi.array().items(LeadApplicationModel.Email()),
-      gender: Joi.string().allow(""),
-      dob: Joi.string().allow(""),
-      active: Joi.boolean(),
-      profile_pic_url: Joi.string().allow(""),
-      username: Joi.string().allow(""),
-      account_type: Joi.string().allow(""),
-      _id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      updated_at: Joi.string().allow(""),
-      external_id: Joi.string().allow(""),
-      rr_id: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {SubmitCustomFormResponse} */
   static SubmitCustomFormResponse() {
     return Joi.object({
@@ -465,27 +360,6 @@ class LeadApplicationModel {
     });
   }
 
-  /** @returns {PhoneNumber} */
-  static PhoneNumber() {
-    return Joi.object({
-      phone: Joi.string().allow(""),
-      country_code: Joi.number(),
-      active: Joi.boolean(),
-      primary: Joi.boolean(),
-      verified: Joi.boolean(),
-    });
-  }
-
-  /** @returns {Email} */
-  static Email() {
-    return Joi.object({
-      email: Joi.string().allow(""),
-      active: Joi.boolean(),
-      primary: Joi.boolean(),
-      verified: Joi.boolean(),
-    });
-  }
-
   /**
    * Enum: PriorityEnum Used By: Lead
    *

package/sdk/application/Lead/LeadApplicationValidator.d.ts

@@ -12,18 +12,10 @@ export = LeadApplicationValidator;
  * @typedef GetCustomFormParam
  * @property {string} slug - Slug of form whose response is getting submitted
  */
-/**
- * @typedef GetParticipantsInsideVideoRoomParam
- * @property {string} uniqueName - Unique name of Video Room
- */
 /**
  * @typedef GetTicketParam
  * @property {string} id - ID of ticket to be retrieved
  */
-/**
- * @typedef GetTokenForVideoRoomParam
- * @property {string} uniqueName - Unique name of Video Room
- */
 /**
  * @typedef SubmitCustomFormParam
  * @property {string} slug - Slug of form whose response is getting submitted
@@ -36,17 +28,13 @@ declare class LeadApplicationValidator {
     static createTicket(): CreateTicketParam;
     /** @returns {GetCustomFormParam} */
     static getCustomForm(): GetCustomFormParam;
-    /** @returns {GetParticipantsInsideVideoRoomParam} */
-    static getParticipantsInsideVideoRoom(): GetParticipantsInsideVideoRoomParam;
     /** @returns {GetTicketParam} */
     static getTicket(): GetTicketParam;
-    /** @returns {GetTokenForVideoRoomParam} */
-    static getTokenForVideoRoom(): GetTokenForVideoRoomParam;
     /** @returns {SubmitCustomFormParam} */
     static submitCustomForm(): SubmitCustomFormParam;
 }
 declare namespace LeadApplicationValidator {
-    export { CreateHistoryParam, CreateTicketParam, GetCustomFormParam, GetParticipantsInsideVideoRoomParam, GetTicketParam, GetTokenForVideoRoomParam, SubmitCustomFormParam };
+    export { CreateHistoryParam, CreateTicketParam, GetCustomFormParam, GetTicketParam, SubmitCustomFormParam };
 }
 type CreateHistoryParam = {
     /**
@@ -64,24 +52,12 @@ type GetCustomFormParam = {
      */
     slug: string;
 };
-type GetParticipantsInsideVideoRoomParam = {
-    /**
-     * - Unique name of Video Room
-     */
-    uniqueName: string;
-};
 type GetTicketParam = {
     /**
      * - ID of ticket to be retrieved
      */
     id: string;
 };
-type GetTokenForVideoRoomParam = {
-    /**
-     * - Unique name of Video Room
-     */
-    uniqueName: string;
-};
 type SubmitCustomFormParam = {
     /**
      * - Slug of form whose response is getting submitted

package/sdk/application/Lead/LeadApplicationValidator.js

@@ -18,21 +18,11 @@ const LeadApplicationModel = require("./LeadApplicationModel");
  * @property {string} slug - Slug of form whose response is getting submitted
  */
 
-/**
- * @typedef GetParticipantsInsideVideoRoomParam
- * @property {string} uniqueName - Unique name of Video Room
- */
-
 /**
  * @typedef GetTicketParam
  * @property {string} id - ID of ticket to be retrieved
  */
 
-/**
- * @typedef GetTokenForVideoRoomParam
- * @property {string} uniqueName - Unique name of Video Room
- */
-
 /**
  * @typedef SubmitCustomFormParam
  * @property {string} slug - Slug of form whose response is getting submitted
@@ -62,13 +52,6 @@ class LeadApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetParticipantsInsideVideoRoomParam} */
-  static getParticipantsInsideVideoRoom() {
-    return Joi.object({
-      uniqueName: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {GetTicketParam} */
   static getTicket() {
     return Joi.object({
@@ -76,13 +59,6 @@ class LeadApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetTokenForVideoRoomParam} */
-  static getTokenForVideoRoom() {
-    return Joi.object({
-      uniqueName: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {SubmitCustomFormParam} */
   static submitCustomForm() {
     return Joi.object({

package/sdk/application/Logistic/LogisticApplicationClient.js

@@ -15,7 +15,7 @@ class Logistic {
     this._conf = _conf;
     this._relativeUrls = {
       getAllCountries: "/service/application/logistics/v1.0/country-list",
-      getCountries: "/service/application/logistics/v1.0/countries",
+      getCountries: "/service/application/logistics/v2.0/countries",
       getCountry:
         "/service/application/logistics/v1.0/countries/{country_iso_code}",
       getLocalities:

package/sdk/application/Logistic/LogisticApplicationModel.d.ts

@@ -379,6 +379,7 @@ export = LogisticApplicationModel;
 /**
  * @typedef ErrorResponse
  * @property {string} [error]
+ * @property {string} [message]
  */
 declare class LogisticApplicationModel {
 }
@@ -852,4 +853,5 @@ type GetLocality = {
 declare function ErrorResponse(): ErrorResponse;
 type ErrorResponse = {
     error?: string;
+    message?: string;
 };

package/sdk/application/Logistic/LogisticApplicationModel.js

@@ -430,6 +430,7 @@ const Joi = require("joi");
 /**
  * @typedef ErrorResponse
  * @property {string} [error]
+ * @property {string} [message]
  */
 
 class LogisticApplicationModel {
@@ -970,6 +971,7 @@ class LogisticApplicationModel {
   static ErrorResponse() {
     return Joi.object({
       error: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
 }

package/sdk/application/Order/OrderApplicationModel.d.ts

@@ -33,6 +33,20 @@ export = OrderApplicationModel;
  * @property {string} [logo]
  * @property {string} [display_name]
  */
+/**
+ * @typedef ShipmentPaymentInfo
+ * @property {string} [mop] - Stands for "Mode of Payment". This is a short code
+ *   (like "COD" for Cash On Delivery) that represents the payment method used.
+ * @property {string} [payment_mode] - Information about the payment mode,
+ *   indicates whether COD or PREPAID
+ * @property {string} [status] - Indicates the current status of the payment,
+ *   Paid or Unpaid
+ * @property {string} [mode] - Information about the payment source. For eg, NB_ICICI
+ * @property {string} [logo] - A URL to an image representing the payment method
+ * @property {string} [display_name] - The name of the payment method as it
+ *   should be displayed to the user
+ * @property {number} [amount] - Amount paid using this payment method
+ */
 /**
  * @typedef ShipmentUserInfo
  * @property {string} [first_name]
@@ -232,7 +246,7 @@ export = OrderApplicationModel;
  * @property {string[]} [tags]
  */
 /**
- * @typedef DeliveryAddress
+ * @typedef Address
  * @property {string} [pincode]
  * @property {string} [phone]
  * @property {number} [latitude]
@@ -260,7 +274,9 @@ export = OrderApplicationModel;
 /**
  * @typedef Shipments
  * @property {ShipmentPayment} [payment]
- * @property {ShipmentPayment[]} [payment_info]
+ * @property {ShipmentPaymentInfo[]} [payment_info] - "Array of objects
+ *   containing payment methods used for placing an order. Each object will
+ *   provide information about corresponding payment method with relevant details."
  * @property {string} [order_type]
  * @property {boolean} [show_download_invoice]
  * @property {boolean} [can_cancel]
@@ -291,7 +307,8 @@ export = OrderApplicationModel;
  * @property {boolean} [beneficiary_details]
  * @property {FulfillingCompany} [fulfilling_company]
  * @property {boolean} [can_return]
- * @property {DeliveryAddress} [delivery_address]
+ * @property {Address} [delivery_address]
+ * @property {Address} [billing_address]
  * @property {string} [track_url]
  * @property {string} [order_id]
  * @property {string} [need_help_url]
@@ -316,6 +333,7 @@ export = OrderApplicationModel;
 /**
  * @typedef OrderSchema
  * @property {number} [total_shipments_in_order]
+ * @property {string} [gstin_code]
  * @property {UserInfo} [user_info]
  * @property {BreakupValues[]} [breakup_values]
  * @property {string} [order_created_time]
@@ -323,6 +341,7 @@ export = OrderApplicationModel;
  * @property {string} [order_id]
  * @property {Shipments[]} [shipments]
  * @property {BagsForReorder[]} [bags_for_reorder]
+ * @property {Object} [meta]
  */
 /**
  * @typedef OrderStatuses
@@ -536,7 +555,7 @@ export = OrderApplicationModel;
 declare class OrderApplicationModel {
 }
 declare namespace OrderApplicationModel {
-    export { OrderPage, UserInfo, BreakupValues, ShipmentPayment, ShipmentUserInfo, FulfillingStore, ShipmentStatus, Invoice, NestedTrackingDetails, TrackingDetails, TimeStampData, Promise, ShipmentTotalDetails, Prices, ItemBrand, Item, AppliedFreeArticles, AppliedPromos, Identifiers, FinancialBreakup, CurrentStatus, Bags, FulfillingCompany, Article, DeliveryAddress, Shipments, BagsForReorderArticleAssignment, BagsForReorder, OrderSchema, OrderStatuses, OrderFilters, OrderList, ApefaceApiError, OrderById, ShipmentById, ResponseGetInvoiceShipment, Track, ShipmentTrack, CustomerDetailsResponse, SendOtpToCustomerResponse, VerifyOtp, VerifyOtpResponse, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentReason, ShipmentReasons, ProductsReasonsData, ProductsReasonsFilters, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, OrderRequest, UpdateShipmentStatusRequest, StatusesBodyResponse, ShipmentApplicationStatusResponse, ErrorResponse };
+    export { OrderPage, UserInfo, BreakupValues, ShipmentPayment, ShipmentPaymentInfo, ShipmentUserInfo, FulfillingStore, ShipmentStatus, Invoice, NestedTrackingDetails, TrackingDetails, TimeStampData, Promise, ShipmentTotalDetails, Prices, ItemBrand, Item, AppliedFreeArticles, AppliedPromos, Identifiers, FinancialBreakup, CurrentStatus, Bags, FulfillingCompany, Article, Address, Shipments, BagsForReorderArticleAssignment, BagsForReorder, OrderSchema, OrderStatuses, OrderFilters, OrderList, ApefaceApiError, OrderById, ShipmentById, ResponseGetInvoiceShipment, Track, ShipmentTrack, CustomerDetailsResponse, SendOtpToCustomerResponse, VerifyOtp, VerifyOtpResponse, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentReason, ShipmentReasons, ProductsReasonsData, ProductsReasonsFilters, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, OrderRequest, UpdateShipmentStatusRequest, StatusesBodyResponse, ShipmentApplicationStatusResponse, ErrorResponse };
 }
 /** @returns {OrderPage} */
 declare function OrderPage(): OrderPage;
@@ -576,6 +595,42 @@ type ShipmentPayment = {
     logo?: string;
     display_name?: string;
 };
+/** @returns {ShipmentPaymentInfo} */
+declare function ShipmentPaymentInfo(): ShipmentPaymentInfo;
+type ShipmentPaymentInfo = {
+    /**
+     * - Stands for "Mode of Payment". This is a short code
+     * (like "COD" for Cash On Delivery) that represents the payment method used.
+     */
+    mop?: string;
+    /**
+     * - Information about the payment mode,
+     * indicates whether COD or PREPAID
+     */
+    payment_mode?: string;
+    /**
+     * - Indicates the current status of the payment,
+     * Paid or Unpaid
+     */
+    status?: string;
+    /**
+     * - Information about the payment source. For eg, NB_ICICI
+     */
+    mode?: string;
+    /**
+     * - A URL to an image representing the payment method
+     */
+    logo?: string;
+    /**
+     * - The name of the payment method as it
+     * should be displayed to the user
+     */
+    display_name?: string;
+    /**
+     * - Amount paid using this payment method
+     */
+    amount?: number;
+};
 /** @returns {ShipmentUserInfo} */
 declare function ShipmentUserInfo(): ShipmentUserInfo;
 type ShipmentUserInfo = {
@@ -794,9 +849,9 @@ declare function Article(): Article;
 type Article = {
     tags?: string[];
 };
-/** @returns {DeliveryAddress} */
-declare function DeliveryAddress(): DeliveryAddress;
-type DeliveryAddress = {
+/** @returns {Address} */
+declare function Address(): Address;
+type Address = {
     pincode?: string;
     phone?: string;
     latitude?: number;
@@ -825,7 +880,12 @@ type DeliveryAddress = {
 declare function Shipments(): Shipments;
 type Shipments = {
     payment?: ShipmentPayment;
-    payment_info?: ShipmentPayment[];
+    /**
+     * - "Array of objects
+     * containing payment methods used for placing an order. Each object will
+     * provide information about corresponding payment method with relevant details."
+     */
+    payment_info?: ShipmentPaymentInfo[];
     order_type?: string;
     show_download_invoice?: boolean;
     can_cancel?: boolean;
@@ -856,7 +916,8 @@ type Shipments = {
     beneficiary_details?: boolean;
     fulfilling_company?: FulfillingCompany;
     can_return?: boolean;
-    delivery_address?: DeliveryAddress;
+    delivery_address?: Address;
+    billing_address?: Address;
     track_url?: string;
     order_id?: string;
     need_help_url?: string;
@@ -884,6 +945,7 @@ type BagsForReorder = {
 declare function OrderSchema(): OrderSchema;
 type OrderSchema = {
     total_shipments_in_order?: number;
+    gstin_code?: string;
     user_info?: UserInfo;
     breakup_values?: BreakupValues[];
     order_created_time?: string;
@@ -891,6 +953,7 @@ type OrderSchema = {
     order_id?: string;
     shipments?: Shipments[];
     bags_for_reorder?: BagsForReorder[];
+    meta?: any;
 };
 /** @returns {OrderStatuses} */
 declare function OrderStatuses(): OrderStatuses;

package/sdk/application/Order/OrderApplicationModel.js

@@ -38,6 +38,21 @@ const Joi = require("joi");
  * @property {string} [display_name]
  */
 
+/**
+ * @typedef ShipmentPaymentInfo
+ * @property {string} [mop] - Stands for "Mode of Payment". This is a short code
+ *   (like "COD" for Cash On Delivery) that represents the payment method used.
+ * @property {string} [payment_mode] - Information about the payment mode,
+ *   indicates whether COD or PREPAID
+ * @property {string} [status] - Indicates the current status of the payment,
+ *   Paid or Unpaid
+ * @property {string} [mode] - Information about the payment source. For eg, NB_ICICI
+ * @property {string} [logo] - A URL to an image representing the payment method
+ * @property {string} [display_name] - The name of the payment method as it
+ *   should be displayed to the user
+ * @property {number} [amount] - Amount paid using this payment method
+ */
+
 /**
  * @typedef ShipmentUserInfo
  * @property {string} [first_name]
@@ -257,7 +272,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef DeliveryAddress
+ * @typedef Address
  * @property {string} [pincode]
  * @property {string} [phone]
  * @property {number} [latitude]
@@ -286,7 +301,9 @@ const Joi = require("joi");
 /**
  * @typedef Shipments
  * @property {ShipmentPayment} [payment]
- * @property {ShipmentPayment[]} [payment_info]
+ * @property {ShipmentPaymentInfo[]} [payment_info] - "Array of objects
+ *   containing payment methods used for placing an order. Each object will
+ *   provide information about corresponding payment method with relevant details."
  * @property {string} [order_type]
  * @property {boolean} [show_download_invoice]
  * @property {boolean} [can_cancel]
@@ -317,7 +334,8 @@ const Joi = require("joi");
  * @property {boolean} [beneficiary_details]
  * @property {FulfillingCompany} [fulfilling_company]
  * @property {boolean} [can_return]
- * @property {DeliveryAddress} [delivery_address]
+ * @property {Address} [delivery_address]
+ * @property {Address} [billing_address]
  * @property {string} [track_url]
  * @property {string} [order_id]
  * @property {string} [need_help_url]
@@ -345,6 +363,7 @@ const Joi = require("joi");
 /**
  * @typedef OrderSchema
  * @property {number} [total_shipments_in_order]
+ * @property {string} [gstin_code]
  * @property {UserInfo} [user_info]
  * @property {BreakupValues[]} [breakup_values]
  * @property {string} [order_created_time]
@@ -352,6 +371,7 @@ const Joi = require("joi");
  * @property {string} [order_id]
  * @property {Shipments[]} [shipments]
  * @property {BagsForReorder[]} [bags_for_reorder]
+ * @property {Object} [meta]
  */
 
 /**
@@ -647,6 +667,19 @@ class OrderApplicationModel {
     });
   }
 
+  /** @returns {ShipmentPaymentInfo} */
+  static ShipmentPaymentInfo() {
+    return Joi.object({
+      mop: Joi.string().allow(""),
+      payment_mode: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      mode: Joi.string().allow(""),
+      logo: Joi.string().allow(""),
+      display_name: Joi.string().allow(""),
+      amount: Joi.number(),
+    });
+  }
+
   /** @returns {ShipmentUserInfo} */
   static ShipmentUserInfo() {
     return Joi.object({
@@ -911,8 +944,8 @@ class OrderApplicationModel {
     });
   }
 
-  /** @returns {DeliveryAddress} */
-  static DeliveryAddress() {
+  /** @returns {Address} */
+  static Address() {
     return Joi.object({
       pincode: Joi.string().allow(""),
       phone: Joi.string().allow(""),
@@ -944,7 +977,9 @@ class OrderApplicationModel {
   static Shipments() {
     return Joi.object({
       payment: OrderApplicationModel.ShipmentPayment(),
-      payment_info: Joi.array().items(OrderApplicationModel.ShipmentPayment()),
+      payment_info: Joi.array().items(
+        OrderApplicationModel.ShipmentPaymentInfo()
+      ),
       order_type: Joi.string().allow("").allow(null),
       show_download_invoice: Joi.boolean(),
       can_cancel: Joi.boolean(),
@@ -977,7 +1012,8 @@ class OrderApplicationModel {
       beneficiary_details: Joi.boolean(),
       fulfilling_company: OrderApplicationModel.FulfillingCompany(),
       can_return: Joi.boolean(),
-      delivery_address: OrderApplicationModel.DeliveryAddress(),
+      delivery_address: OrderApplicationModel.Address(),
+      billing_address: OrderApplicationModel.Address(),
       track_url: Joi.string().allow(""),
       order_id: Joi.string().allow(""),
       need_help_url: Joi.string().allow(""),
@@ -1011,6 +1047,7 @@ class OrderApplicationModel {
   static OrderSchema() {
     return Joi.object({
       total_shipments_in_order: Joi.number(),
+      gstin_code: Joi.string().allow(""),
       user_info: OrderApplicationModel.UserInfo(),
       breakup_values: Joi.array().items(OrderApplicationModel.BreakupValues()),
       order_created_time: Joi.string().allow(""),
@@ -1020,6 +1057,7 @@ class OrderApplicationModel {
       bags_for_reorder: Joi.array().items(
         OrderApplicationModel.BagsForReorder()
       ),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }