@gofynd/fdk-client-javascript 2.0.2 → 3.0.0

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

@@ -40,8 +40,7 @@ export = ConfigurationPlatformModel;
  *   or not for sales channel inventory
  * @property {CommunicationConfig} [communication]
  * @property {string[]} [platforms]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel inventory
+ * @property {string} [_id] - The unique identifier of the sales channel inventory
  * @property {LoyaltyPointsConfig} [loyalty_points]
  * @property {string} [app] - Current sales channel ID
  * @property {string} [created_at] - ISO 8601 timestamp of sales channel
@@ -366,8 +365,7 @@ export = ConfigurationPlatformModel;
 /**
  * @typedef MobileAppConfiguration
  * @property {boolean} [is_active] - Indicates the availability of the mobile build
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   for mobile application configuration
+ * @property {string} [_id] - The unique identifier for mobile application configuration
  * @property {string} [app_name] - Name of the mobile app
  * @property {LandingImage} [landing_image]
  * @property {SplashImage} [splash_image]
@@ -407,7 +405,7 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef BuildVersion
- * @property {string} [_id] - 24-digit Mongo Object ID
+ * @property {string} [_id] - Primary Identifier of the build version.
  * @property {string} [application] - Application ID of the sales channel
  * @property {string} [platform_type] - Device platform for which the mobile app
  *   was built, e.g. android, ios.
@@ -425,8 +423,8 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef AppSupportedCurrency
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the currency configuration supported by the application
+ * @property {string} [_id] - The unique identifier of the currency
+ *   configuration supported by the application
  * @property {string[]} [supported_currency]
  * @property {string} [application] - Alphanumeric ID allotted to an application
  *   (sales channel website) created within a business account.
@@ -438,16 +436,14 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef DefaultCurrency
- * @property {string} [ref] - The unique identifier (24-digit Mongo Object ID)
- *   of the default currency
+ * @property {string} [ref] - The unique identifier of the default currency
  * @property {string} [code] - 3-character code of the default currency, e.g.
  *   INR, EUR, USD
  */
 /**
  * @typedef DomainAdd
  * @property {string} [name] - Full domain name, e.g. uniket.hostx0.de
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {boolean} [verified] - Domain is verified or not (indicates if A
  *   records and TXT records are correct)
  * @property {boolean} [is_primary] - Domain is primary or not (indicates if the
@@ -465,8 +461,7 @@ export = ConfigurationPlatformModel;
 /**
  * @typedef Domain
  * @property {string} [name] - Full domain name, e.g. newton.com
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel domain
+ * @property {string} [_id] - The unique identifier of the sales channel domain
  * @property {boolean} [verified] - Domain is verified or not. TXT and A records
  *   should propagate correctly.
  * @property {boolean} [is_primary] - Domain is primary or not. Primary domain
@@ -482,8 +477,7 @@ export = ConfigurationPlatformModel;
 /**
  * @typedef UpdateDomain
  * @property {string} [name] - Full domain name, e.g. zenz.com
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {boolean} [verified] - Domain is verified or not (indicates if A
  *   records and TXT records are correct)
  * @property {boolean} [is_primary] - Domain is primary or not (indicates if the
@@ -571,8 +565,8 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef AppInventoryStores
- * @property {string} [_id] - The unique identifier of the store (24-digit Mongo
- *   Object ID) in the sales channel inventory
+ * @property {string} [_id] - The unique identifier of the store in the sales
+ *   channel inventory
  * @property {string} [modified_on] - ISO 8601 timestamp of last known updation
  *   to the stores in sales channel inventory
  * @property {number} [uid] - Sales channel inventory store UID
@@ -603,8 +597,7 @@ export = ConfigurationPlatformModel;
  * @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
  *   type delivery, store selection is compulsory. For soft type, delivery store
  *   selection is optional.
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the ordering stores
+ * @property {string} [_id] - The unique identifier of the ordering stores
  * @property {string} [app] - Alphanumeric ID allotted to an application (sales
  *   channel website) created within a business account
  * @property {number} [__v]
@@ -630,8 +623,7 @@ export = ConfigurationPlatformModel;
  * @typedef OtherSellerApplication
  * @property {string} [name] - Name of the other seller's sales channel
  * @property {string} [description] - Basic details about the other seller's sales channel
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the other seller's sales channel
+ * @property {string} [_id] - The unique identifier of the other seller's sales channel
  * @property {string} [domain] - Domain URL of the other seller's sales channel
  * @property {OtherSellerCompany} [company]
  * @property {string} [opt_type] - Inventory opted by the other seller's sales
@@ -646,8 +638,7 @@ export = ConfigurationPlatformModel;
  * @typedef OptedApplicationResponseSchema
  * @property {string} [name] - Name of the other seller's sales channel
  * @property {string} [description] - Basic details about the other seller's sales channel
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the other seller's sales channel
+ * @property {string} [_id] - The unique identifier of the other seller's sales channel
  * @property {string} [domain] - Domain URL of the other seller's sales channel
  * @property {OptedCompany} [company]
  * @property {OptedInventory} [opted_inventory]
@@ -696,8 +687,7 @@ export = ConfigurationPlatformModel;
 /**
  * @typedef TokenResponseSchema
  * @property {Tokens} [tokens]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the token
+ * @property {string} [_id] - The unique identifier of the token
  * @property {string} [application] - Alphanumeric ID allotted to the current
  *   application created within the current business account
  * @property {string} [created_at] - ISO 8601 timestamp of token creation
@@ -905,8 +895,7 @@ export = ConfigurationPlatformModel;
  * @property {OrderFeature} [order]
  * @property {BuyboxFeature} [buybox]
  * @property {DeliveryStrategy} [delivery_strategy]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   for the sales channel features
+ * @property {string} [_id] - The unique identifier for the sales channel features
  * @property {string} [app] - Application ID of the sales channel
  * @property {string} [created_at] - ISO 8601 timestamp showing the date when
  *   the features were configured
@@ -1018,8 +1007,8 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef Currency
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the current sales channel supported currency
+ * @property {string} [_id] - The unique identifier of the current sales channel
+ *   supported currency
  * @property {boolean} [is_active] - Shows currency is enabled or not in current
  *   sales channel
  * @property {string} [name] - Name of the currency, e.g Indian Rupee
@@ -1081,11 +1070,9 @@ export = ConfigurationPlatformModel;
  * @property {boolean} [is_internal] - Indicates whether a sales channel is
  *   internal or not
  * @property {boolean} [is_active] - Indicates sales channel is active or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
  * @property {string} [token] - Random generated fix length string for sales
@@ -1122,11 +1109,9 @@ export = ConfigurationPlatformModel;
  * @property {boolean} [is_internal] - Indicates whether a sales channel is
  *   internal or not
  * @property {boolean} [is_active] - Indicates sales channel is active or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
  * @property {string} [token] - Random generated fix length string for sales
@@ -1185,8 +1170,7 @@ export = ConfigurationPlatformModel;
  * @property {Links[]} [links]
  * @property {string} [copyright_text] - Copyright statement usually seen at the
  *   site's footer
- * @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
- *   the application information
+ * @property {string} [_id] - Unique identifier of the application information
  * @property {BusinessHighlights[]} [business_highlights]
  * @property {string} [application] - Alphanumeric ID allotted to a sales
  *   channel application created within a business account
@@ -1305,8 +1289,7 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef BusinessHighlights
- * @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
- *   the related business
+ * @property {string} [_id] - Unique identifier of the related business
  * @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
  * @property {string} [icon] - Hosted URL of icon image representing the
  *   business highlight
@@ -1323,8 +1306,7 @@ export = ConfigurationPlatformModel;
  * @property {SecureUrl} [banner]
  * @property {Domain} [domain]
  * @property {Domain[]} [domains]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   for the sales channel details
+ * @property {string} [_id] - The unique identifier for the sales channel details
  * @property {string} [slug]
  * @property {number} [company_id]
  */
@@ -1334,8 +1316,8 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef AppCurrencyResponseSchema
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the currency configuration supported by the application
+ * @property {string} [_id] - The unique identifier of the currency
+ *   configuration supported by the application
  * @property {string} [application] - Alphanumeric ID allotted to an application
  *   (sales channel website) created within a business account
  * @property {DefaultCurrency} [default_currency]
@@ -1366,8 +1348,7 @@ export = ConfigurationPlatformModel;
 /**
  * @typedef OrderingStore
  * @property {OptedStoreAddress} [address]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the ordering store
+ * @property {string} [_id] - The unique identifier of the ordering store
  * @property {number} [uid] - Ordering store UID
  * @property {string} [name] - Store name of the ordering store
  * @property {string} [display_name] - Display name of the ordering store
@@ -1386,8 +1367,7 @@ export = ConfigurationPlatformModel;
  * @property {boolean} [enabled] - Allow ordering stores for current sales channel
  * @property {string} [type] - For hard type delivery, store selection is
  *   compulsory. For soft type, delivery store selection is optional.
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the ordering store
+ * @property {string} [_id] - The unique identifier of the ordering store
  * @property {string} [app] - Alphanumeric ID allotted to an application (sales
  *   channel website) created within a business account
  * @property {number} [__v] - Version key for tracking ordering stores. Default
@@ -1400,7 +1380,7 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef ValidationErrors
- * @property {ValidationError[]} errors
+ * @property {ValidationError[]} errors - A list of validation errors in the request.
  */
 /**
  * @typedef ValidationError
@@ -1502,8 +1482,7 @@ type ApplicationInventory = {
     communication?: CommunicationConfig;
     platforms?: string[];
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel inventory
+     * - The unique identifier of the sales channel inventory
      */
     _id?: string;
     loyalty_points?: LoyaltyPointsConfig;
@@ -2119,8 +2098,7 @@ type MobileAppConfiguration = {
      */
     is_active?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * for mobile application configuration
+     * - The unique identifier for mobile application configuration
      */
     _id?: string;
     /**
@@ -2210,7 +2188,7 @@ type BuildVersionHistory = {
 declare function BuildVersion(): BuildVersion;
 type BuildVersion = {
     /**
-     * - 24-digit Mongo Object ID
+     * - Primary Identifier of the build version.
      */
     _id?: string;
     /**
@@ -2256,8 +2234,8 @@ type BuildVersion = {
 declare function AppSupportedCurrency(): AppSupportedCurrency;
 type AppSupportedCurrency = {
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the currency configuration supported by the application
+     * - The unique identifier of the currency
+     * configuration supported by the application
      */
     _id?: string;
     supported_currency?: string[];
@@ -2282,8 +2260,7 @@ type AppSupportedCurrency = {
 declare function DefaultCurrency(): DefaultCurrency;
 type DefaultCurrency = {
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the default currency
+     * - The unique identifier of the default currency
      */
     ref?: string;
     /**
@@ -2300,8 +2277,7 @@ type DomainAdd = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the domain
+     * - The unique identifier of the domain
      */
     _id?: string;
     /**
@@ -2339,8 +2315,7 @@ type Domain = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel domain
+     * - The unique identifier of the sales channel domain
      */
     _id?: string;
     /**
@@ -2376,8 +2351,7 @@ type UpdateDomain = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the domain
+     * - The unique identifier of the domain
      */
     _id?: string;
     /**
@@ -2560,8 +2534,8 @@ type StoresResponseSchema = {
 declare function AppInventoryStores(): AppInventoryStores;
 type AppInventoryStores = {
     /**
-     * - The unique identifier of the store (24-digit Mongo
-     * Object ID) in the sales channel inventory
+     * - The unique identifier of the store in the sales
+     * channel inventory
      */
     _id?: string;
     /**
@@ -2633,8 +2607,7 @@ type DeploymentMeta = {
      */
     type?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the ordering stores
+     * - The unique identifier of the ordering stores
      */
     _id?: string;
     /**
@@ -2686,8 +2659,7 @@ type OtherSellerApplication = {
      */
     description?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the other seller's sales channel
+     * - The unique identifier of the other seller's sales channel
      */
     _id?: string;
     /**
@@ -2719,8 +2691,7 @@ type OptedApplicationResponseSchema = {
      */
     description?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the other seller's sales channel
+     * - The unique identifier of the other seller's sales channel
      */
     _id?: string;
     /**
@@ -2826,8 +2797,7 @@ declare function TokenResponseSchema(): TokenResponseSchema;
 type TokenResponseSchema = {
     tokens?: Tokens;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the token
+     * - The unique identifier of the token
      */
     _id?: string;
     /**
@@ -3215,8 +3185,7 @@ type AppFeature = {
     buybox?: BuyboxFeature;
     delivery_strategy?: DeliveryStrategy;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * for the sales channel features
+     * - The unique identifier for the sales channel features
      */
     _id?: string;
     /**
@@ -3429,8 +3398,8 @@ type AppFeatureResponseSchema = {
 declare function Currency(): Currency;
 type Currency = {
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the current sales channel supported currency
+     * - The unique identifier of the current sales channel
+     * supported currency
      */
     _id?: string;
     /**
@@ -3565,8 +3534,7 @@ type Application = {
      */
     is_active?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel
+     * - The unique identifier of the sales channel
      */
     _id?: string;
     /**
@@ -3574,8 +3542,7 @@ type Application = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of owner who owns the application
+     * - The unique identifier of owner who owns the application
      */
     owner?: string;
     /**
@@ -3649,8 +3616,7 @@ type ApplicationById = {
      */
     is_active?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel
+     * - The unique identifier of the sales channel
      */
     _id?: string;
     /**
@@ -3658,8 +3624,7 @@ type ApplicationById = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of owner who owns the application
+     * - The unique identifier of owner who owns the application
      */
     owner?: string;
     /**
@@ -3783,8 +3748,7 @@ type ApplicationInformation = {
      */
     copyright_text?: string;
     /**
-     * - Unique identifier (24-digit Mongo Object ID) of
-     * the application information
+     * - Unique identifier of the application information
      */
     _id?: string;
     business_highlights?: BusinessHighlights[];
@@ -4059,8 +4023,7 @@ type Links = {
 declare function BusinessHighlights(): BusinessHighlights;
 type BusinessHighlights = {
     /**
-     * - Unique identifier (24-digit Mongo Object ID) of
-     * the related business
+     * - Unique identifier of the related business
      */
     _id?: string;
     /**
@@ -4096,8 +4059,7 @@ type ApplicationDetail = {
     domain?: Domain;
     domains?: Domain[];
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * for the sales channel details
+     * - The unique identifier for the sales channel details
      */
     _id?: string;
     slug?: string;
@@ -4112,8 +4074,8 @@ type CurrenciesResponseSchema = {
 declare function AppCurrencyResponseSchema(): AppCurrencyResponseSchema;
 type AppCurrencyResponseSchema = {
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the currency configuration supported by the application
+     * - The unique identifier of the currency
+     * configuration supported by the application
      */
     _id?: string;
     /**
@@ -4189,8 +4151,7 @@ declare function OrderingStore(): OrderingStore;
 type OrderingStore = {
     address?: OptedStoreAddress;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the ordering store
+     * - The unique identifier of the ordering store
      */
     _id?: string;
     /**
@@ -4243,8 +4204,7 @@ type OrderingStores = {
      */
     type?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the ordering store
+     * - The unique identifier of the ordering store
      */
     _id?: string;
     /**
@@ -4267,6 +4227,9 @@ type OrderingStoresResponseSchema = {
 /** @returns {ValidationErrors} */
 declare function ValidationErrors(): ValidationErrors;
 type ValidationErrors = {
+    /**
+     * - A list of validation errors in the request.
+     */
     errors: ValidationError[];
 };
 /** @returns {ValidationError} */