@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1

package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts

@@ -6,12 +6,14 @@ export = CompanyProfilePlatformModel;
  * @property {string} [address2]
  * @property {string} [city]
  * @property {string} [country]
- * @property {string} [country_code]
+ * @property {string} country_code
  * @property {string} [landmark]
  * @property {number} latitude
  * @property {number} longitude
  * @property {number} [pincode]
+ * @property {string} [sector]
  * @property {string} [state]
+ * @property {string} [state_code]
  */
 /**
  * @typedef AverageOrderProcessingTime
@@ -29,8 +31,10 @@ export = CompanyProfilePlatformModel;
  */
 /**
  * @typedef BusinessCountryInfo
- * @property {string} [country]
- * @property {string} [country_code]
+ * @property {string} country
+ * @property {string} country_code
+ * @property {CountryCurrencyInfo} currency
+ * @property {string} timezone
  */
 /**
  * @typedef BusinessDetails
@@ -110,6 +114,12 @@ export = CompanyProfilePlatformModel;
  * @property {string[]} [emails]
  * @property {SellerPhoneNumber[]} [phone]
  */
+/**
+ * @typedef CountryCurrencyInfo
+ * @property {string} code
+ * @property {string} name
+ * @property {string} symbol
+ */
 /**
  * @typedef CreateUpdateAddressSerializer
  * @property {string} address_type
@@ -169,7 +179,9 @@ export = CompanyProfilePlatformModel;
  * @property {number} latitude
  * @property {number} longitude
  * @property {number} [pincode]
+ * @property {string} [sector]
  * @property {string} [state]
+ * @property {string} [state_code]
  */
 /**
  * @typedef GetBrandResponseSerializer
@@ -239,6 +251,7 @@ export = CompanyProfilePlatformModel;
  * @typedef GetLocationSerializer
  * @property {Object} [_custom_json]
  * @property {GetAddressSerializer} address
+ * @property {boolean} [auto_assign_courier_partner]
  * @property {boolean} [auto_invoice]
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
  * @property {boolean} [bulk_shipment]
@@ -314,6 +327,7 @@ export = CompanyProfilePlatformModel;
  * @typedef LocationSerializer
  * @property {Object} [_custom_json]
  * @property {AddressSerializer} address
+ * @property {boolean} [auto_assign_courier_partner]
  * @property {boolean} [auto_invoice]
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
  * @property {boolean} [bulk_shipment]
@@ -324,7 +338,7 @@ export = CompanyProfilePlatformModel;
  * @property {boolean} [default_order_acceptance_timing] - Flag to set
  *   order_acceptance_timing as default timing
  * @property {string} display_name
- * @property {Document[]} [documents]
+ * @property {Document[]} documents
  * @property {InvoiceDetailsSerializer} [gst_credentials]
  * @property {HolidaySchemaSerializer[]} [holiday]
  * @property {LocationManagerSerializer} [manager]
@@ -416,7 +430,7 @@ export = CompanyProfilePlatformModel;
 declare class CompanyProfilePlatformModel {
 }
 declare namespace CompanyProfilePlatformModel {
-    export { AddressSerializer, AverageOrderProcessingTime, BrandBannerSerializer, BulkLocationSerializer, BusinessCountryInfo, BusinessDetails, CompanyBrandListSerializer, CompanyBrandPostRequestSerializer, CompanyBrandSerializer, CompanyDetails, CompanySerializer, CompanySocialAccounts, CompanyTaxesSerializer, CompanyTaxesSerializer1, ContactDetails, CreateUpdateAddressSerializer, CreateUpdateBrandRequestSerializer, Document, DocumentsObj, ErrorResponse, GetAddressSerializer, GetBrandResponseSerializer, GetCompanyProfileSerializerResponse, GetCompanySerializer, GetLocationSerializer, HolidayDateSerializer, HolidaySchemaSerializer, InvoiceCredSerializer, InvoiceDetailsSerializer, LocationDayWiseSerializer, LocationListSerializer, LocationManagerSerializer, LocationSerializer, LocationTimingSerializer, MetricsSerializer, Page, ProductReturnConfigSerializer, ProfileSuccessResponse, SellerPhoneNumber, StoreTagsResponseSchema, UpdateCompany, UserSerializer, Website };
+    export { AddressSerializer, AverageOrderProcessingTime, BrandBannerSerializer, BulkLocationSerializer, BusinessCountryInfo, BusinessDetails, CompanyBrandListSerializer, CompanyBrandPostRequestSerializer, CompanyBrandSerializer, CompanyDetails, CompanySerializer, CompanySocialAccounts, CompanyTaxesSerializer, CompanyTaxesSerializer1, ContactDetails, CountryCurrencyInfo, CreateUpdateAddressSerializer, CreateUpdateBrandRequestSerializer, Document, DocumentsObj, ErrorResponse, GetAddressSerializer, GetBrandResponseSerializer, GetCompanyProfileSerializerResponse, GetCompanySerializer, GetLocationSerializer, HolidayDateSerializer, HolidaySchemaSerializer, InvoiceCredSerializer, InvoiceDetailsSerializer, LocationDayWiseSerializer, LocationListSerializer, LocationManagerSerializer, LocationSerializer, LocationTimingSerializer, MetricsSerializer, Page, ProductReturnConfigSerializer, ProfileSuccessResponse, SellerPhoneNumber, StoreTagsResponseSchema, UpdateCompany, UserSerializer, Website };
 }
 /** @returns {AddressSerializer} */
 declare function AddressSerializer(): AddressSerializer;
@@ -426,12 +440,14 @@ type AddressSerializer = {
     address2?: string;
     city?: string;
     country?: string;
-    country_code?: string;
+    country_code: string;
     landmark?: string;
     latitude: number;
     longitude: number;
     pincode?: number;
+    sector?: string;
     state?: string;
+    state_code?: string;
 };
 /** @returns {AverageOrderProcessingTime} */
 declare function AverageOrderProcessingTime(): AverageOrderProcessingTime;
@@ -453,8 +469,10 @@ type BulkLocationSerializer = {
 /** @returns {BusinessCountryInfo} */
 declare function BusinessCountryInfo(): BusinessCountryInfo;
 type BusinessCountryInfo = {
-    country?: string;
-    country_code?: string;
+    country: string;
+    country_code: string;
+    currency: CountryCurrencyInfo;
+    timezone: string;
 };
 /** @returns {BusinessDetails} */
 declare function BusinessDetails(): BusinessDetails;
@@ -544,6 +562,13 @@ type ContactDetails = {
     emails?: string[];
     phone?: SellerPhoneNumber[];
 };
+/** @returns {CountryCurrencyInfo} */
+declare function CountryCurrencyInfo(): CountryCurrencyInfo;
+type CountryCurrencyInfo = {
+    code: string;
+    name: string;
+    symbol: string;
+};
 /** @returns {CreateUpdateAddressSerializer} */
 declare function CreateUpdateAddressSerializer(): CreateUpdateAddressSerializer;
 type CreateUpdateAddressSerializer = {
@@ -609,7 +634,9 @@ type GetAddressSerializer = {
     latitude: number;
     longitude: number;
     pincode?: number;
+    sector?: string;
     state?: string;
+    state_code?: string;
 };
 /** @returns {GetBrandResponseSerializer} */
 declare function GetBrandResponseSerializer(): GetBrandResponseSerializer;
@@ -683,6 +710,7 @@ declare function GetLocationSerializer(): GetLocationSerializer;
 type GetLocationSerializer = {
     _custom_json?: any;
     address: GetAddressSerializer;
+    auto_assign_courier_partner?: boolean;
     auto_invoice?: boolean;
     avg_order_processing_time?: AverageOrderProcessingTime;
     bulk_shipment?: boolean;
@@ -766,6 +794,7 @@ declare function LocationSerializer(): LocationSerializer;
 type LocationSerializer = {
     _custom_json?: any;
     address: AddressSerializer;
+    auto_assign_courier_partner?: boolean;
     auto_invoice?: boolean;
     avg_order_processing_time?: AverageOrderProcessingTime;
     bulk_shipment?: boolean;
@@ -779,7 +808,7 @@ type LocationSerializer = {
      */
     default_order_acceptance_timing?: boolean;
     display_name: string;
-    documents?: Document[];
+    documents: Document[];
     gst_credentials?: InvoiceDetailsSerializer;
     holiday?: HolidaySchemaSerializer[];
     manager?: LocationManagerSerializer;

package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js

@@ -7,12 +7,14 @@ const Joi = require("joi");
  * @property {string} [address2]
  * @property {string} [city]
  * @property {string} [country]
- * @property {string} [country_code]
+ * @property {string} country_code
  * @property {string} [landmark]
  * @property {number} latitude
  * @property {number} longitude
  * @property {number} [pincode]
+ * @property {string} [sector]
  * @property {string} [state]
+ * @property {string} [state_code]
  */
 
 /**
@@ -34,8 +36,10 @@ const Joi = require("joi");
 
 /**
  * @typedef BusinessCountryInfo
- * @property {string} [country]
- * @property {string} [country_code]
+ * @property {string} country
+ * @property {string} country_code
+ * @property {CountryCurrencyInfo} currency
+ * @property {string} timezone
  */
 
 /**
@@ -126,6 +130,13 @@ const Joi = require("joi");
  * @property {SellerPhoneNumber[]} [phone]
  */
 
+/**
+ * @typedef CountryCurrencyInfo
+ * @property {string} code
+ * @property {string} name
+ * @property {string} symbol
+ */
+
 /**
  * @typedef CreateUpdateAddressSerializer
  * @property {string} address_type
@@ -190,7 +201,9 @@ const Joi = require("joi");
  * @property {number} latitude
  * @property {number} longitude
  * @property {number} [pincode]
+ * @property {string} [sector]
  * @property {string} [state]
+ * @property {string} [state_code]
  */
 
 /**
@@ -264,6 +277,7 @@ const Joi = require("joi");
  * @typedef GetLocationSerializer
  * @property {Object} [_custom_json]
  * @property {GetAddressSerializer} address
+ * @property {boolean} [auto_assign_courier_partner]
  * @property {boolean} [auto_invoice]
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
  * @property {boolean} [bulk_shipment]
@@ -347,6 +361,7 @@ const Joi = require("joi");
  * @typedef LocationSerializer
  * @property {Object} [_custom_json]
  * @property {AddressSerializer} address
+ * @property {boolean} [auto_assign_courier_partner]
  * @property {boolean} [auto_invoice]
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
  * @property {boolean} [bulk_shipment]
@@ -357,7 +372,7 @@ const Joi = require("joi");
  * @property {boolean} [default_order_acceptance_timing] - Flag to set
  *   order_acceptance_timing as default timing
  * @property {string} display_name
- * @property {Document[]} [documents]
+ * @property {Document[]} documents
  * @property {InvoiceDetailsSerializer} [gst_credentials]
  * @property {HolidaySchemaSerializer[]} [holiday]
  * @property {LocationManagerSerializer} [manager]
@@ -466,12 +481,14 @@ class CompanyProfilePlatformModel {
       address2: Joi.string().allow(""),
       city: Joi.string().allow(""),
       country: Joi.string().allow(""),
-      country_code: Joi.string().allow(""),
+      country_code: Joi.string().allow("").required(),
       landmark: Joi.string().allow(""),
       latitude: Joi.number().required(),
       longitude: Joi.number().required(),
       pincode: Joi.number(),
+      sector: Joi.string().allow(""),
       state: Joi.string().allow(""),
+      state_code: Joi.string().allow(""),
     });
   }
 
@@ -501,8 +518,10 @@ class CompanyProfilePlatformModel {
   /** @returns {BusinessCountryInfo} */
   static BusinessCountryInfo() {
     return Joi.object({
-      country: Joi.string().allow(""),
-      country_code: Joi.string().allow(""),
+      country: Joi.string().allow("").required(),
+      country_code: Joi.string().allow("").required(),
+      currency: CompanyProfilePlatformModel.CountryCurrencyInfo().required(),
+      timezone: Joi.string().allow("").required(),
     });
   }
 
@@ -620,6 +639,15 @@ class CompanyProfilePlatformModel {
     });
   }
 
+  /** @returns {CountryCurrencyInfo} */
+  static CountryCurrencyInfo() {
+    return Joi.object({
+      code: Joi.string().allow("").required(),
+      name: Joi.string().allow("").required(),
+      symbol: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {CreateUpdateAddressSerializer} */
   static CreateUpdateAddressSerializer() {
     return Joi.object({
@@ -695,7 +723,9 @@ class CompanyProfilePlatformModel {
       latitude: Joi.number().required(),
       longitude: Joi.number().required(),
       pincode: Joi.number(),
+      sector: Joi.string().allow(""),
       state: Joi.string().allow(""),
+      state_code: Joi.string().allow(""),
     });
   }
 
@@ -783,6 +813,7 @@ class CompanyProfilePlatformModel {
     return Joi.object({
       _custom_json: Joi.any(),
       address: CompanyProfilePlatformModel.GetAddressSerializer().required(),
+      auto_assign_courier_partner: Joi.boolean(),
       auto_invoice: Joi.boolean(),
       avg_order_processing_time: CompanyProfilePlatformModel.AverageOrderProcessingTime(),
       bulk_shipment: Joi.boolean(),
@@ -892,6 +923,7 @@ class CompanyProfilePlatformModel {
     return Joi.object({
       _custom_json: Joi.any(),
       address: CompanyProfilePlatformModel.AddressSerializer().required(),
+      auto_assign_courier_partner: Joi.boolean(),
       auto_invoice: Joi.boolean(),
       avg_order_processing_time: CompanyProfilePlatformModel.AverageOrderProcessingTime(),
       bulk_shipment: Joi.boolean(),
@@ -903,7 +935,9 @@ class CompanyProfilePlatformModel {
       credit_note: Joi.boolean(),
       default_order_acceptance_timing: Joi.boolean(),
       display_name: Joi.string().allow("").required(),
-      documents: Joi.array().items(CompanyProfilePlatformModel.Document()),
+      documents: Joi.array()
+        .items(CompanyProfilePlatformModel.Document())
+        .required(),
       gst_credentials: CompanyProfilePlatformModel.InvoiceDetailsSerializer(),
       holiday: Joi.array().items(
         CompanyProfilePlatformModel.HolidaySchemaSerializer()

package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts

@@ -51,6 +51,10 @@ export = CompanyProfilePlatformValidator;
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
  * @property {number[]} [locationIds] - Helps to filter stores on the basis of uids.
+ * @property {string[]} [types] - Helps to get the location list on the basis of
+ *   multiple location type.
+ * @property {string[]} [tags] - Helps to get the location list on the basis of
+ *   multiple location tag.
  */
 /**
  * @typedef UpdateCompanyParam
@@ -170,6 +174,16 @@ type GetLocationsParam = {
      * - Helps to filter stores on the basis of uids.
      */
     locationIds?: number[];
+    /**
+     * - Helps to get the location list on the basis of
+     * multiple location type.
+     */
+    types?: string[];
+    /**
+     * - Helps to get the location list on the basis of
+     * multiple location tag.
+     */
+    tags?: string[];
 };
 type UpdateCompanyParam = {
     body: CompanyProfilePlatformModel.UpdateCompany;

package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js

@@ -65,6 +65,10 @@ const CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 10.
  * @property {number[]} [locationIds] - Helps to filter stores on the basis of uids.
+ * @property {string[]} [types] - Helps to get the location list on the basis of
+ *   multiple location type.
+ * @property {string[]} [tags] - Helps to get the location list on the basis of
+ *   multiple location tag.
  */
 
 /**
@@ -162,6 +166,8 @@ class CompanyProfilePlatformValidator {
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       locationIds: Joi.array().items(Joi.number()),
+      types: Joi.array().items(Joi.string().allow("")),
+      tags: Joi.array().items(Joi.string().allow("")),
     }).required();
   }
 

package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts

@@ -63,7 +63,7 @@ declare class Configuration {
     getAppCompanies({ uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppCompaniesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CompaniesResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.companyId - Numeric ID allotted to a business account
+     * @param {number} arg.companyId - Numeric ID allotted to a business account
      *   on Fynd Platform
      * @param {string} arg.applicationId - Alphanumeric ID allotted to an
      *   application (sales channel website) created within a business account
@@ -75,7 +75,7 @@ declare class Configuration {
      * @description: Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
      */
     getAppCompaniesPaginator({ companyId, applicationId, uid, pageSize }?: {
-        companyId: string;
+        companyId: number;
         applicationId: string;
         uid?: number;
         pageSize?: number;
@@ -133,7 +133,7 @@ declare class Configuration {
     getAppStores({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoresResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.companyId - Numeric ID allotted to a business account
+     * @param {number} arg.companyId - Numeric ID allotted to a business account
      *   on Fynd Platform
      * @param {string} arg.applicationId - Alphanumeric ID allotted to an
      *   application (sales channel website) created within a business account
@@ -144,7 +144,7 @@ declare class Configuration {
      * @description: Fetch info of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application
      */
     getAppStoresPaginator({ companyId, applicationId, pageSize }?: {
-        companyId: string;
+        companyId: number;
         applicationId: string;
         pageSize?: number;
     }): Paginator<ConfigurationPlatformModel.StoresResponse>;
@@ -262,7 +262,7 @@ declare class Configuration {
     getOrderingStoresByFilter({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStores>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.companyId - Numeric ID allotted to a business account
+     * @param {number} arg.companyId - Numeric ID allotted to a business account
      *   on Fynd Platform
      * @param {string} arg.applicationId - Alphanumeric ID allotted to an
      *   application (sales channel website) created within a business account
@@ -274,7 +274,7 @@ declare class Configuration {
      * @description: Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
      */
     getOrderingStoresByFilterPaginator({ companyId, applicationId, pageSize, body, }?: {
-        companyId: string;
+        companyId: number;
         applicationId: string;
         pageSize?: number;
         body: ConfigurationPlatformModel.FilterOrderingStoreRequest;
@@ -307,7 +307,7 @@ declare class Configuration {
     getStaffOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoresResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.companyId - Numeric ID allotted to a business account
+     * @param {number} arg.companyId - Numeric ID allotted to a business account
      *   on Fynd Platform
      * @param {string} arg.applicationId - Alphanumeric ID allotted to an
      *   application (sales channel website) created within a business account
@@ -319,7 +319,7 @@ declare class Configuration {
      * @description: Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders).
      */
     getStaffOrderingStoresPaginator({ companyId, applicationId, pageSize, q, }?: {
-        companyId: string;
+        companyId: number;
         applicationId: string;
         pageSize?: number;
         q?: string;

package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js

@@ -416,7 +416,7 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Numeric ID allotted to a business account
+   * @param {number} arg.companyId - Numeric ID allotted to a business account
    *   on Fynd Platform
    * @param {string} arg.applicationId - Alphanumeric ID allotted to an
    *   application (sales channel website) created within a business account
@@ -771,7 +771,7 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Numeric ID allotted to a business account
+   * @param {number} arg.companyId - Numeric ID allotted to a business account
    *   on Fynd Platform
    * @param {string} arg.applicationId - Alphanumeric ID allotted to an
    *   application (sales channel website) created within a business account
@@ -1524,7 +1524,7 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Numeric ID allotted to a business account
+   * @param {number} arg.companyId - Numeric ID allotted to a business account
    *   on Fynd Platform
    * @param {string} arg.applicationId - Alphanumeric ID allotted to an
    *   application (sales channel website) created within a business account
@@ -1736,7 +1736,7 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Numeric ID allotted to a business account
+   * @param {number} arg.companyId - Numeric ID allotted to a business account
    *   on Fynd Platform
    * @param {string} arg.applicationId - Alphanumeric ID allotted to an
    *   application (sales channel website) created within a business account