@gofynd/fdk-client-javascript 0.1.36 → 1.0.0

package/sdk/platform/{client → Webhook}/WebhookPlatformClient.js

@@ -1,7 +1,7 @@
 const Paginator = require("../../common/Paginator");
-const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
-const WebhookValidator = require("../models/WebhookValidator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const WebhookValidator = require("./WebhookPlatformValidator");
 class Webhook {
   constructor(config) {
     this.config = config;

package/sdk/platform/Webhook/WebhookPlatformModel.d.ts

@@ -0,0 +1,17 @@
+export = WebhookModel;
+declare class WebhookModel {
+    static EventConfig(): any;
+    static EventConfigList(): any;
+    static EventConfigResponse(): any;
+    static SubscriberConfigList(): any;
+    static Page(): any;
+    static EventProcessedStatus(): any;
+    static EventPayload(): any;
+    static SubscriberConfig(): any;
+    static SubscriberResponse(): any;
+    static SubscriberEvent(): any;
+    static AuthMeta(): any;
+    static Association(): any;
+    static EventConfigBase(): any;
+    static SubscriberStatus(): any;
+}

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -0,0 +1,208 @@
+const Joi = require("joi");
+
+class WebhookModel {
+  static EventConfig() {
+    return Joi.object({
+      id: Joi.number(),
+
+      event_name: Joi.string().allow(""),
+
+      event_type: Joi.string().allow(""),
+
+      event_category: Joi.string().allow(""),
+
+      version: Joi.string().allow(""),
+
+      display_name: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      created_on: Joi.string().allow(""),
+    });
+  }
+
+  static EventConfigList() {
+    return Joi.object({
+      items: Joi.array().items(WebhookModel.EventConfig()),
+
+      page: WebhookModel.Page(),
+    });
+  }
+
+  static EventConfigResponse() {
+    return Joi.object({
+      event_configs: Joi.array().items(WebhookModel.EventConfig()),
+    });
+  }
+
+  static SubscriberConfigList() {
+    return Joi.object({
+      items: Joi.array().items(WebhookModel.SubscriberResponse()),
+
+      page: WebhookModel.Page(),
+    });
+  }
+
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+
+      has_next: Joi.boolean(),
+
+      current: Joi.number(),
+
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+    });
+  }
+
+  static EventProcessedStatus() {
+    return Joi.object({
+      id: Joi.number(),
+
+      subscriber_id: Joi.string().allow(""),
+
+      attempt: Joi.number(),
+
+      response_code: Joi.string().allow(""),
+
+      response_message: Joi.string().allow(""),
+
+      created_on: Joi.string().allow(""),
+
+      processed_on: Joi.string().allow(""),
+
+      status: Joi.boolean(),
+    });
+  }
+
+  static EventPayload() {
+    return Joi.object({
+      id: Joi.number(),
+
+      event_trace_id: Joi.string().allow(""),
+
+      message_id: Joi.string().allow(""),
+
+      event_name: Joi.string().allow(""),
+
+      event_type: Joi.string().allow(""),
+
+      version: Joi.string().allow(""),
+
+      status: Joi.boolean(),
+    });
+  }
+
+  static SubscriberConfig() {
+    return Joi.object({
+      id: Joi.number(),
+
+      name: Joi.string().allow(""),
+
+      webhook_url: Joi.string().allow(""),
+
+      association: WebhookModel.Association(),
+
+      custom_headers: Joi.any(),
+
+      status: WebhookModel.SubscriberStatus(),
+
+      email_id: Joi.string().allow(""),
+
+      auth_meta: WebhookModel.AuthMeta(),
+
+      event_id: Joi.array().items(Joi.number()),
+    });
+  }
+
+  static SubscriberResponse() {
+    return Joi.object({
+      id: Joi.number(),
+
+      name: Joi.string().allow(""),
+
+      webhook_url: Joi.string().allow(""),
+
+      association: WebhookModel.Association(),
+
+      custom_headers: Joi.any(),
+
+      email_id: Joi.string().allow(""),
+
+      status: WebhookModel.SubscriberStatus(),
+
+      auth_meta: WebhookModel.AuthMeta(),
+
+      created_on: Joi.string().allow(""),
+
+      updated_on: Joi.string().allow(""),
+
+      event_configs: Joi.array().items(WebhookModel.EventConfig()),
+    });
+  }
+
+  static SubscriberEvent() {
+    return Joi.object({
+      id: Joi.number(),
+
+      subscriber_id: Joi.number(),
+
+      event_id: Joi.number(),
+
+      created_date: Joi.string().allow(""),
+    });
+  }
+
+  static AuthMeta() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+
+      secret: Joi.string().allow(""),
+    });
+  }
+
+  static Association() {
+    return Joi.object({
+      company_id: Joi.number(),
+
+      application_id: Joi.array().items(Joi.string().allow("")),
+
+      extension_id: Joi.string().allow(""),
+
+      criteria: Joi.string().allow(""),
+    });
+  }
+
+  static EventConfigBase() {
+    return Joi.object({
+      event_name: Joi.string().allow(""),
+
+      event_type: Joi.string().allow(""),
+
+      event_category: Joi.string().allow(""),
+
+      version: Joi.string().allow(""),
+    });
+  }
+
+  /*
+        Enum: SubscriberStatus
+        Used By: Webhook
+    */
+  static SubscriberStatus() {
+    return Joi.string().valid(
+      "active",
+
+      "inactive",
+
+      "blocked"
+    );
+  }
+}
+module.exports = WebhookModel;

package/sdk/platform/{models/WebhookValidator.js → Webhook/WebhookPlatformValidator.js}

@@ -1,5 +1,6 @@
 const Joi = require("joi");
-const Validator = require("../PlatformModels");
+
+const WebhookModel = require("./WebhookPlatformModel");
 class WebhookValidator {
   static getSubscribersByCompany() {
     return Joi.object({
@@ -11,13 +12,13 @@ class WebhookValidator {
 
   static registerSubscriberToEvent() {
     return Joi.object({
-      body: Validator.SubscriberConfig().required(),
+      body: WebhookModel.SubscriberConfig().required(),
     }).required();
   }
 
   static updateSubscriberConfig() {
     return Joi.object({
-      body: Validator.SubscriberConfig().required(),
+      body: WebhookModel.SubscriberConfig().required(),
     }).required();
   }
 

package/sdk/platform/index.d.ts

@@ -1,2 +1,26 @@
 export const PlatformConfig: typeof import("./PlatformConfig");
 export const PlatformClient: typeof import("./PlatformClient");
+export namespace PlatformModel {
+    const CommonPlatformModel: typeof import("./Common/CommonPlatformModel");
+    const LeadPlatformModel: typeof import("./Lead/LeadPlatformModel");
+    const ThemePlatformModel: typeof import("./Theme/ThemePlatformModel");
+    const UserPlatformModel: typeof import("./User/UserPlatformModel");
+    const ContentPlatformModel: typeof import("./Content/ContentPlatformModel");
+    const BillingPlatformModel: typeof import("./Billing/BillingPlatformModel");
+    const CommunicationPlatformModel: typeof import("./Communication/CommunicationPlatformModel");
+    const PaymentPlatformModel: typeof import("./Payment/PaymentPlatformModel");
+    const OrderPlatformModel: typeof import("./Order/OrderPlatformModel");
+    const CatalogPlatformModel: typeof import("./Catalog/CatalogPlatformModel");
+    const CompanyProfilePlatformModel: typeof import("./CompanyProfile/CompanyProfilePlatformModel");
+    const FileStoragePlatformModel: typeof import("./FileStorage/FileStoragePlatformModel");
+    const SharePlatformModel: typeof import("./Share/SharePlatformModel");
+    const InventoryPlatformModel: typeof import("./Inventory/InventoryPlatformModel");
+    const ConfigurationPlatformModel: typeof import("./Configuration/ConfigurationPlatformModel");
+    const CartPlatformModel: typeof import("./Cart/CartPlatformModel");
+    const RewardsPlatformModel: typeof import("./Rewards/RewardsPlatformModel");
+    const AnalyticsPlatformModel: typeof import("./Analytics/AnalyticsPlatformModel");
+    const DiscountPlatformModel: typeof import("./Discount/DiscountPlatformModel");
+    const PartnerPlatformModel: typeof import("./Partner/PartnerPlatformModel");
+    const WebhookPlatformModel: typeof import("./Webhook/WebhookPlatformModel");
+    const AuditTrailPlatformModel: typeof import("./AuditTrail/AuditTrailPlatformModel");
+}

package/sdk/platform/index.js

@@ -1,4 +1,49 @@
 module.exports = {
   PlatformConfig: require("./PlatformConfig"),
   PlatformClient: require("./PlatformClient"),
+  PlatformModel: {
+    CommonPlatformModel: require("./Common/CommonPlatformModel"),
+
+    LeadPlatformModel: require("./Lead/LeadPlatformModel"),
+
+    ThemePlatformModel: require("./Theme/ThemePlatformModel"),
+
+    UserPlatformModel: require("./User/UserPlatformModel"),
+
+    ContentPlatformModel: require("./Content/ContentPlatformModel"),
+
+    BillingPlatformModel: require("./Billing/BillingPlatformModel"),
+
+    CommunicationPlatformModel: require("./Communication/CommunicationPlatformModel"),
+
+    PaymentPlatformModel: require("./Payment/PaymentPlatformModel"),
+
+    OrderPlatformModel: require("./Order/OrderPlatformModel"),
+
+    CatalogPlatformModel: require("./Catalog/CatalogPlatformModel"),
+
+    CompanyProfilePlatformModel: require("./CompanyProfile/CompanyProfilePlatformModel"),
+
+    FileStoragePlatformModel: require("./FileStorage/FileStoragePlatformModel"),
+
+    SharePlatformModel: require("./Share/SharePlatformModel"),
+
+    InventoryPlatformModel: require("./Inventory/InventoryPlatformModel"),
+
+    ConfigurationPlatformModel: require("./Configuration/ConfigurationPlatformModel"),
+
+    CartPlatformModel: require("./Cart/CartPlatformModel"),
+
+    RewardsPlatformModel: require("./Rewards/RewardsPlatformModel"),
+
+    AnalyticsPlatformModel: require("./Analytics/AnalyticsPlatformModel"),
+
+    DiscountPlatformModel: require("./Discount/DiscountPlatformModel"),
+
+    PartnerPlatformModel: require("./Partner/PartnerPlatformModel"),
+
+    WebhookPlatformModel: require("./Webhook/WebhookPlatformModel"),
+
+    AuditTrailPlatformModel: require("./AuditTrail/AuditTrailPlatformModel"),
+  },
 };

package/sdk/public/{client → Configuration}/ConfigurationPublicClient.js

@@ -1,7 +1,7 @@
 const PublicAPIClient = require("../PublicAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
-const ConfigurationValidator = require("../models/ConfigurationValidator");
+const ConfigurationValidator = require("./ConfigurationPublicValidator");
 class Configuration {
   constructor(_conf) {
     this._conf = _conf;

package/sdk/public/Configuration/ConfigurationPublicModel.d.ts

@@ -0,0 +1,20 @@
+export = ConfigurationModel;
+declare class ConfigurationModel {
+    static ApplicationResponse(): any;
+    static Currency(): any;
+    static Domain(): any;
+    static ApplicationWebsite(): any;
+    static ApplicationCors(): any;
+    static ApplicationAuth(): any;
+    static ApplicationRedirections(): any;
+    static ApplicationMeta(): any;
+    static SecureUrl(): any;
+    static Application(): any;
+    static NotFound(): any;
+    static BadRequest(): any;
+    static Page(): any;
+    static LocationDefaultLanguage(): any;
+    static LocationDefaultCurrency(): any;
+    static LocationCountry(): any;
+    static Locations(): any;
+}

package/sdk/public/Configuration/ConfigurationPublicModel.js

@@ -0,0 +1,230 @@
+const Joi = require("joi");
+
+class ConfigurationModel {
+  static ApplicationResponse() {
+    return Joi.object({
+      application: ConfigurationModel.Application(),
+    });
+  }
+
+  static Currency() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      is_active: Joi.boolean(),
+
+      name: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+
+      decimal_digits: Joi.number(),
+
+      symbol: Joi.string().allow(""),
+    });
+  }
+
+  static Domain() {
+    return Joi.object({
+      verified: Joi.boolean(),
+
+      is_primary: Joi.boolean(),
+
+      is_shortlink: Joi.boolean(),
+
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      is_predefined: Joi.boolean(),
+    });
+  }
+
+  static ApplicationWebsite() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+
+      basepath: Joi.string().allow(""),
+    });
+  }
+
+  static ApplicationCors() {
+    return Joi.object({
+      domains: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  static ApplicationAuth() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+    });
+  }
+
+  static ApplicationRedirections() {
+    return Joi.object({
+      redirect_from: Joi.string().allow(""),
+
+      redirect_to: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+    });
+  }
+
+  static ApplicationMeta() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+
+      value: Joi.string().allow(""),
+    });
+  }
+
+  static SecureUrl() {
+    return Joi.object({
+      secure_url: Joi.string().allow(""),
+    });
+  }
+
+  static Application() {
+    return Joi.object({
+      website: ConfigurationModel.ApplicationWebsite(),
+
+      cors: ConfigurationModel.ApplicationCors(),
+
+      auth: ConfigurationModel.ApplicationAuth(),
+
+      description: Joi.string().allow(""),
+
+      channel_type: Joi.string().allow(""),
+
+      cache_ttl: Joi.number(),
+
+      is_internal: Joi.boolean(),
+
+      is_active: Joi.boolean(),
+
+      _id: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      owner: Joi.string().allow(""),
+
+      company_id: Joi.number(),
+
+      token: Joi.string().allow(""),
+
+      redirections: Joi.array().items(
+        ConfigurationModel.ApplicationRedirections()
+      ),
+
+      meta: Joi.array().items(ConfigurationModel.ApplicationMeta()),
+
+      created_at: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+
+      __v: Joi.number(),
+
+      banner: ConfigurationModel.SecureUrl(),
+
+      logo: ConfigurationModel.SecureUrl(),
+
+      favicon: ConfigurationModel.SecureUrl(),
+
+      domains: Joi.array().items(ConfigurationModel.Domain()),
+
+      app_type: Joi.string().allow(""),
+
+      mobile_logo: ConfigurationModel.SecureUrl(),
+
+      domain: ConfigurationModel.Domain(),
+    });
+  }
+
+  static NotFound() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static BadRequest() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static Page() {
+    return Joi.object({
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+
+      current: Joi.number(),
+
+      has_next: Joi.boolean(),
+
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+    });
+  }
+
+  static LocationDefaultLanguage() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+    });
+  }
+
+  static LocationDefaultCurrency() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+
+      symbol: Joi.string().allow(""),
+
+      code: Joi.string().allow(""),
+    });
+  }
+
+  static LocationCountry() {
+    return Joi.object({
+      capital: Joi.string().allow(""),
+
+      currency: Joi.string().allow(""),
+
+      iso2: Joi.string().allow(""),
+
+      iso3: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      parent: Joi.string().allow(""),
+
+      phone_code: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      uid: Joi.number(),
+
+      __v: Joi.number(),
+
+      _id: Joi.string().allow(""),
+
+      default_currency: ConfigurationModel.LocationDefaultCurrency(),
+
+      default_language: ConfigurationModel.LocationDefaultLanguage(),
+    });
+  }
+
+  static Locations() {
+    return Joi.object({
+      items: Joi.array().items(Joi.any()),
+    });
+  }
+}
+module.exports = ConfigurationModel;

package/sdk/public/{models/ConfigurationValidator.js → Configuration/ConfigurationPublicValidator.js}

@@ -1,4 +1,4 @@
-const Validator = require("../PublicModels");
+const ConfigurationModel = require("./ConfigurationPublicModel");
 const Joi = require("joi");
 class ConfigurationValidator {
   static searchApplication() {

package/sdk/public/{client → Inventory}/InventoryPublicClient.js

@@ -1,7 +1,7 @@
 const PublicAPIClient = require("../PublicAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
-const InventoryValidator = require("../models/InventoryValidator");
+const InventoryValidator = require("./InventoryPublicValidator");
 class Inventory {
   constructor(_conf) {
     this._conf = _conf;

package/sdk/public/Inventory/InventoryPublicModel.d.ts

@@ -0,0 +1,22 @@
+export = InventoryModel;
+declare class InventoryModel {
+    static EmailJobMetrics(): any;
+    static Page(): any;
+    static ResponseEnvelopeEmailJobMetrics(): any;
+    static GCompany(): any;
+    static GStore(): any;
+    static Metum(): any;
+    static ResponseEnvelopeSlingshotConfigurationDetail(): any;
+    static SlingshotConfigurationDetail(): any;
+    static SlingshotIntegration(): any;
+    static StoreData(): any;
+    static ApikeyModel(): any;
+    static ResponseEnvelopeApikeyModel(): any;
+    static DataTresholdDTO(): any;
+    static GenericDTO(): any;
+    static JobConfigDTO(): any;
+    static ResponseEnvelopeJobConfigDTO(): any;
+    static TaskDTO(): any;
+    static ResponseEnvelopeListJobConfigDTO(): any;
+    static ResponseEnvelopeObject(): any;
+}