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

package/sdk/platform/Configuration/ConfigurationPlatformModel.js

@@ -559,195 +559,6 @@ const Joi = require("joi");
  * @property {string} [message] - Success message shown to the user (in a string format)
  */
 
-/**
- * @typedef GetIntegrationsOptInsResponse
- * @property {IntegrationOptIn[]} [items]
- * @property {Page} [page]
- */
-
-/**
- * @typedef IntegrationOptIn
- * @property {Validators} [validators]
- * @property {string} [description] - Basic description about the opted integration
- * @property {string} [description_html] - Basic HTML description about the
- *   opted integration
- * @property {string} [constants]
- * @property {string[]} [companies]
- * @property {string[]} [support]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the opted integration
- * @property {string} [name] - Nmae of the opted integration, e.g. SAP RBL Integration
- * @property {string} [slug] - Slug of the opted integration, e.g. ginesys
- * @property {boolean} [hidden]
- * @property {IntegrationMeta[]} [meta]
- * @property {string} [icon] - Hosted URL of the icon image
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of the user who created the integration
- * @property {string} [created_at] - ISO 8601 timestamp of integration creation
- * @property {string} [modified_at] - ISO 8601 timestamp of integration updation
- * @property {string} [token] - Randomly generated fixed-length string for opted
- *   integration. It is auto-generated. It would never change once it is generated.
- * @property {string} [secret] - Randomly generated fixed-length string for
- *   opted integration. It is auto-generated. It would never change once it is generated.
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
- */
-
-/**
- * @typedef Validators
- * @property {CompanyValidator} [company]
- * @property {StoreValidator} [store]
- * @property {InventoryValidator} [inventory]
- * @property {OrderValidator} [order]
- */
-
-/**
- * @typedef CompanyValidator
- * @property {JsonSchema[]} [json_schema]
- * @property {string} [browser_script] - Browser script for the company validator
- */
-
-/**
- * @typedef JsonSchema
- * @property {string} [display] - Display text of the validator JSON schema. It
- *   will show in the UI.
- * @property {string} [key] - Key related to the display text of the validator JSON schema
- * @property {string} [type] - Indicates the type of form field, e.g. Text, Dropdown.
- * @property {string} [tooltip] - Tooltip text for the UI of the validator JSON
- *   schema. It will show in the UI.
- */
-
-/**
- * @typedef StoreValidator
- * @property {JsonSchema[]} [json_schema]
- * @property {string} [browser_script] - Browser script for the store validator
- */
-
-/**
- * @typedef InventoryValidator
- * @property {JsonSchema[]} [json_schema]
- * @property {string} [browser_script] - Browser script for the inventory validator
- */
-
-/**
- * @typedef OrderValidator
- * @property {JsonSchema[]} [json_schema]
- * @property {string} [browser_script] - Browser script for the order validator
- */
-
-/**
- * @typedef IntegrationMeta
- * @property {boolean} [is_public]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the integration meta
- * @property {string} [name] - Nmae of integration meta, e.g. price_level
- * @property {string} [value] - Value related to integration meta name, e.g. store
- */
-
-/**
- * @typedef Integration
- * @property {Validators} [validators]
- * @property {string} [description] - Basic description about the integration
- * @property {string} [description_html] - Basic HTML description about the integration
- * @property {Object} [constants]
- * @property {string[]} [companies]
- * @property {string[]} [support]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the integration
- * @property {string} [name] - Name of the integration, e.g. SAP RBL Integration
- * @property {string} [slug] - Name of the integration, e.g. SAP RBL Integration
- * @property {IntegrationMeta[]} [meta]
- * @property {string} [icon] - Hosted URL of the icon image
- * @property {boolean} [hidden]
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of the user who created the integration
- * @property {string} [created_at] - ISO 8601 timestamp of integration creation
- * @property {string} [modified_at] - ISO 8601 timestamp of integration updation
- * @property {string} [token] - Randomly generated fixed-length string for opted
- *   integration. It is auto-generated. It would never change once it is generated.
- * @property {string} [secret] - Randomly generated fixed-length string for
- *   opted integration. It is auto-generated. It would never change once it is generated.
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
- */
-
-/**
- * @typedef IntegrationConfigResponse
- * @property {IntegrationLevel[]} [items]
- */
-
-/**
- * @typedef IntegrationLevel
- * @property {boolean} [opted] - Shows this integration is opted or not opted
- *   for the current company
- * @property {Object[]} [permissions]
- * @property {LastPatch[]} [last_patch]
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the integration config
- * @property {string} [integration] - Integration id. Shows which integration
- *   you are enabling.
- * @property {string} [level] - Shows for what level the integration is set up.
- *   It can be company level or store level.
- * @property {number} [uid] - It can be store uid or company uid. Depends on the
- *   level of integration.
- * @property {number} [company_id] - Unique id of company.
- * @property {IntegrationMeta[]} [meta]
- * @property {string} [token] - Randomly generated fixed-length string for opted
- *   integration. It is auto-generated. It would never change once it is generated.
- * @property {string} [created_at] - ISO 8601 timestamp of integration config creation
- * @property {string} [modified_at] - ISO 8601 timestamp of integration config updation
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
- * @property {Object} [data] - Schema data of the integration stored in key-value pairs
- * @property {boolean} [success]
- * @property {string} [message]
- */
-
-/**
- * @typedef UpdateIntegrationLevelRequest
- * @property {IntegrationLevel[]} [items]
- */
-
-/**
- * @typedef OptedStoreIntegration
- * @property {boolean} [other_opted] - Allow user to opt same store in other integration
- * @property {IntegrationOptIn} [other_integration]
- * @property {OtherEntity} [other_entity]
- */
-
-/**
- * @typedef OtherEntity
- * @property {boolean} [opted] - Allow other entity opted in integration
- * @property {string[]} [permissions]
- * @property {LastPatch[]} [last_patch]
- * @property {string} [_id] - The unique identifier of the other entity for
- *   opted store integration
- * @property {string} [integration] - Integration ID. Shows which integration
- *   you are enabling.
- * @property {string} [level] - Indicates integration level. It can be company
- *   level or store level.
- * @property {number} [uid] - It can be store uid or company uid. Depends on the
- *   level of integration.
- * @property {OtherEntityData} [data]
- * @property {Object[]} [meta]
- * @property {string} [token] - Randomly generated fixed-length string for opted
- *   integration. It is auto-generated. It would never change once it is generated.
- * @property {string} [created_at] - ISO 8601 timestamp of other entity creation
- *   for opted store integration
- * @property {string} [modified_at] - ISO 8601 timestamp of other entity
- *   updation for opted store integration
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
- */
-
-/**
- * @typedef LastPatch
- * @property {string} [op]
- * @property {string} [path]
- * @property {string} [value] - It can be inventory level or order level
- */
-
-/**
- * @typedef OtherEntityData
- * @property {string} [article_identifier]
- */
-
 /**
  * @typedef App
  * @property {string} [company_id] - Numeric ID allotted to a business account
@@ -759,26 +570,6 @@ const Joi = require("joi");
  * @property {string} [desc] - Detailed description about the sales channel
  */
 
-/**
- * @typedef InventoryConfig
- * @property {InventoryBrandRule} [brand]
- * @property {InventoryStoreRule} [store]
- * @property {string[]} [image]
- * @property {boolean} [franchise_enabled] - Allow other businesses (companies)
- *   to consume the current sales channel's inventory and sell products
- * @property {boolean} [out_of_stock] - Indicates whether out of stock products
- *   are allowed to show up on the website.
- * @property {boolean} [only_verified_products] - Show only verified products
- *   (the ones whose data have been verified by the admin)
- */
-
-/**
- * @typedef AppInventory
- * @property {InventoryConfig} [inventory]
- * @property {InventoryPaymentConfig} [payment]
- * @property {InventoryArticleAssignment} [article_assignment]
- */
-
 /**
  * @typedef AppDomain
  * @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
@@ -1456,63 +1247,15 @@ const Joi = require("joi");
  * @property {boolean} [success] - Flag for required not successfull.
  */
 
-/**
- * @typedef InventoryBrandRule
- * @property {string} [criteria] - Whether all brands are enabled, or explicitly
- *   few brands in the inventory
- * @property {number[]} [brands]
- */
-
-/**
- * @typedef StoreCriteriaRule
- * @property {number[]} [companies] - List of company UID
- * @property {number[]} [brands] - List of brand UID
- */
-
-/**
- * @typedef InventoryStoreRule
- * @property {string} [criteria] - Whether all stores are enabled, or explicitly
- *   few stores in the inventory, or use brands and company filter.
- * @property {StoreCriteriaRule[]} [rules] - List of rules with company and
- *   brands uids. Used when critera is `filter`.
- * @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
- */
-
-/**
- * @typedef InventoryPaymentConfig
- * @property {string} [mode_of_payment] - Mode of payment for the inventory of
- *   sales channel. It is required and default value is null.
- * @property {string} [source] - Source of the payment mode for the inventory
- *   payment of sales channel. Default value is FYND.
- */
-
-/**
- * @typedef StorePriorityRule
- * @property {boolean} [enabled] - Shows store priority is enabled or not
- *   enabled for the article assignment.
- * @property {string[]} [storetype_order]
- */
-
-/**
- * @typedef ArticleAssignmentRule
- * @property {StorePriorityRule} [store_priority]
- */
-
-/**
- * @typedef InventoryArticleAssignment
- * @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
- * @property {ArticleAssignmentRule} [rules]
- */
-
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @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.
  */
 
 /**
@@ -2378,204 +2121,6 @@ class ConfigurationPlatformModel {
     });
   }
 
-  /** @returns {GetIntegrationsOptInsResponse} */
-  static GetIntegrationsOptInsResponse() {
-    return Joi.object({
-      items: Joi.array().items(ConfigurationPlatformModel.IntegrationOptIn()),
-      page: ConfigurationPlatformModel.Page(),
-    });
-  }
-
-  /** @returns {IntegrationOptIn} */
-  static IntegrationOptIn() {
-    return Joi.object({
-      validators: ConfigurationPlatformModel.Validators(),
-      description: Joi.string().allow(""),
-      description_html: Joi.string().allow(""),
-      constants: Joi.string().allow(""),
-      companies: Joi.array().items(Joi.string().allow("")),
-      support: Joi.array().items(Joi.string().allow("")),
-      _id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      slug: Joi.string().allow(""),
-      hidden: Joi.boolean(),
-      meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
-      icon: Joi.string().allow(""),
-      owner: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      token: Joi.string().allow(""),
-      secret: Joi.string().allow(""),
-      __v: Joi.number(),
-    });
-  }
-
-  /** @returns {Validators} */
-  static Validators() {
-    return Joi.object({
-      company: ConfigurationPlatformModel.CompanyValidator(),
-      store: ConfigurationPlatformModel.StoreValidator(),
-      inventory: ConfigurationPlatformModel.InventoryValidator(),
-      order: ConfigurationPlatformModel.OrderValidator(),
-    });
-  }
-
-  /** @returns {CompanyValidator} */
-  static CompanyValidator() {
-    return Joi.object({
-      json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
-      browser_script: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {JsonSchema} */
-  static JsonSchema() {
-    return Joi.object({
-      display: Joi.string().allow(""),
-      key: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      tooltip: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {StoreValidator} */
-  static StoreValidator() {
-    return Joi.object({
-      json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
-      browser_script: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {InventoryValidator} */
-  static InventoryValidator() {
-    return Joi.object({
-      json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
-      browser_script: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {OrderValidator} */
-  static OrderValidator() {
-    return Joi.object({
-      json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
-      browser_script: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {IntegrationMeta} */
-  static IntegrationMeta() {
-    return Joi.object({
-      is_public: Joi.boolean(),
-      _id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      value: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Integration} */
-  static Integration() {
-    return Joi.object({
-      validators: ConfigurationPlatformModel.Validators(),
-      description: Joi.string().allow(""),
-      description_html: Joi.string().allow(""),
-      constants: Joi.any(),
-      companies: Joi.array().items(Joi.string().allow("")),
-      support: Joi.array().items(Joi.string().allow("")),
-      _id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      slug: Joi.string().allow(""),
-      meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
-      icon: Joi.string().allow(""),
-      hidden: Joi.boolean(),
-      owner: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      token: Joi.string().allow(""),
-      secret: Joi.string().allow(""),
-      __v: Joi.number(),
-    });
-  }
-
-  /** @returns {IntegrationConfigResponse} */
-  static IntegrationConfigResponse() {
-    return Joi.object({
-      items: Joi.array().items(ConfigurationPlatformModel.IntegrationLevel()),
-    });
-  }
-
-  /** @returns {IntegrationLevel} */
-  static IntegrationLevel() {
-    return Joi.object({
-      opted: Joi.boolean(),
-      permissions: Joi.array().items(Joi.any()),
-      last_patch: Joi.array().items(ConfigurationPlatformModel.LastPatch()),
-      _id: Joi.string().allow(""),
-      integration: Joi.string().allow(""),
-      level: Joi.string().allow(""),
-      uid: Joi.number(),
-      company_id: Joi.number(),
-      meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
-      token: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      __v: Joi.number(),
-      data: Joi.any(),
-      success: Joi.boolean(),
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {UpdateIntegrationLevelRequest} */
-  static UpdateIntegrationLevelRequest() {
-    return Joi.object({
-      items: Joi.array().items(ConfigurationPlatformModel.IntegrationLevel()),
-    });
-  }
-
-  /** @returns {OptedStoreIntegration} */
-  static OptedStoreIntegration() {
-    return Joi.object({
-      other_opted: Joi.boolean(),
-      other_integration: ConfigurationPlatformModel.IntegrationOptIn(),
-      other_entity: ConfigurationPlatformModel.OtherEntity(),
-    });
-  }
-
-  /** @returns {OtherEntity} */
-  static OtherEntity() {
-    return Joi.object({
-      opted: Joi.boolean(),
-      permissions: Joi.array().items(Joi.string().allow("")),
-      last_patch: Joi.array().items(ConfigurationPlatformModel.LastPatch()),
-      _id: Joi.string().allow(""),
-      integration: Joi.string().allow(""),
-      level: Joi.string().allow(""),
-      uid: Joi.number(),
-      data: ConfigurationPlatformModel.OtherEntityData(),
-      meta: Joi.array().items(Joi.any()),
-      token: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
-      __v: Joi.number(),
-    });
-  }
-
-  /** @returns {LastPatch} */
-  static LastPatch() {
-    return Joi.object({
-      op: Joi.string().allow(""),
-      path: Joi.string().allow(""),
-      value: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {OtherEntityData} */
-  static OtherEntityData() {
-    return Joi.object({
-      article_identifier: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {App} */
   static App() {
     return Joi.object({
@@ -2587,27 +2132,6 @@ class ConfigurationPlatformModel {
     });
   }
 
-  /** @returns {InventoryConfig} */
-  static InventoryConfig() {
-    return Joi.object({
-      brand: ConfigurationPlatformModel.InventoryBrandRule(),
-      store: ConfigurationPlatformModel.InventoryStoreRule(),
-      image: Joi.array().items(Joi.string().allow("")),
-      franchise_enabled: Joi.boolean(),
-      out_of_stock: Joi.boolean(),
-      only_verified_products: Joi.boolean(),
-    });
-  }
-
-  /** @returns {AppInventory} */
-  static AppInventory() {
-    return Joi.object({
-      inventory: ConfigurationPlatformModel.InventoryConfig(),
-      payment: ConfigurationPlatformModel.InventoryPaymentConfig(),
-      article_assignment: ConfigurationPlatformModel.InventoryArticleAssignment(),
-    });
-  }
-
   /** @returns {AppDomain} */
   static AppDomain() {
     return Joi.object({
@@ -3343,62 +2867,6 @@ class ConfigurationPlatformModel {
     });
   }
 
-  /** @returns {InventoryBrandRule} */
-  static InventoryBrandRule() {
-    return Joi.object({
-      criteria: Joi.string().allow(""),
-      brands: Joi.array().items(Joi.number()),
-    });
-  }
-
-  /** @returns {StoreCriteriaRule} */
-  static StoreCriteriaRule() {
-    return Joi.object({
-      companies: Joi.array().items(Joi.number()),
-      brands: Joi.array().items(Joi.number()),
-    });
-  }
-
-  /** @returns {InventoryStoreRule} */
-  static InventoryStoreRule() {
-    return Joi.object({
-      criteria: Joi.string().allow(""),
-      rules: Joi.array().items(ConfigurationPlatformModel.StoreCriteriaRule()),
-      stores: Joi.array().items(Joi.number()),
-    });
-  }
-
-  /** @returns {InventoryPaymentConfig} */
-  static InventoryPaymentConfig() {
-    return Joi.object({
-      mode_of_payment: Joi.string().allow(""),
-      source: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {StorePriorityRule} */
-  static StorePriorityRule() {
-    return Joi.object({
-      enabled: Joi.boolean(),
-      storetype_order: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
-  /** @returns {ArticleAssignmentRule} */
-  static ArticleAssignmentRule() {
-    return Joi.object({
-      store_priority: ConfigurationPlatformModel.StorePriorityRule(),
-    });
-  }
-
-  /** @returns {InventoryArticleAssignment} */
-  static InventoryArticleAssignment() {
-    return Joi.object({
-      post_order_reassignment: Joi.boolean(),
-      rules: ConfigurationPlatformModel.ArticleAssignmentRule(),
-    });
-  }
-
   /** @returns {Page} */
   static Page() {
     return Joi.object({