@gofynd/fdk-client-javascript 0.1.37 → 1.0.1

package/sdk/public/{models/InventoryValidator.js → Inventory/InventoryPublicValidator.js}

@@ -1,5 +1,6 @@
-const Validator = require("../PublicModels");
 const Joi = require("joi");
+
+const InventoryModel = require("./InventoryPublicModel");
 class InventoryValidator {
   static getJobCodesMetrics() {
     return Joi.object({
@@ -10,7 +11,7 @@ class InventoryValidator {
 
   static saveJobCodesMetrics() {
     return Joi.object({
-      body: Validator.EmailJobMetrics().required(),
+      body: InventoryModel.EmailJobMetrics().required(),
     }).required();
   }
 
@@ -40,4 +41,5 @@ class InventoryValidator {
     }).required();
   }
 }
+
 module.exports = InventoryValidator;

package/sdk/public/PublicClient.d.ts

@@ -7,6 +7,6 @@ declare class PublicClient {
     inventory: Inventory;
     setExtraHeaders(header: any): void;
 }
-import Configuration = require("./client/ConfigurationPublicClient");
-import Webhook = require("./client/WebhookPublicClient");
-import Inventory = require("./client/InventoryPublicClient");
+import Configuration = require("./Configuration/ConfigurationPublicClient");
+import Webhook = require("./Webhook/WebhookPublicClient");
+import Inventory = require("./Inventory/InventoryPublicClient");

package/sdk/public/PublicClient.js

@@ -1,14 +1,19 @@
-const Configuration = require("./client/ConfigurationPublicClient");
-const Webhook = require("./client/WebhookPublicClient");
-const Inventory = require("./client/InventoryPublicClient");
+const Configuration = require("./Configuration/ConfigurationPublicClient");
+
+const Webhook = require("./Webhook/WebhookPublicClient");
+
+const Inventory = require("./Inventory/InventoryPublicClient");
 
 const { FDKClientValidationError } = require("../common/FDKError");
 
 class PublicClient {
   constructor(config) {
     this.config = config;
+
     this.configuration = new Configuration(config);
+
     this.webhook = new Webhook(config);
+
     this.inventory = new Inventory(config);
   }
 

package/sdk/public/{client → Webhook}/WebhookPublicClient.js

@@ -1,7 +1,8 @@
 const PublicAPIClient = require("../PublicAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
-const WebhookValidator = require("../models/WebhookValidator");
+const Paginator = require("../../common/Paginator");
+const WebhookValidator = require("./WebhookPublicValidator");
 class Webhook {
   constructor(_conf) {
     this._conf = _conf;
@@ -40,6 +41,19 @@ class Webhook {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.fetchAllWebhookEvents().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for fetchAllWebhookEvents");
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};
@@ -72,6 +86,21 @@ class Webhook {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.queryWebhookEventDetails().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log(
+        "Parameter Validation warrnings for queryWebhookEventDetails"
+      );
+      console.log(warrning);
+    }
+
     const query_params = {};
 
     const xHeaders = {};

package/sdk/public/Webhook/WebhookPublicModel.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/public/Webhook/WebhookPublicModel.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/public/{models/WebhookValidator.js → Webhook/WebhookPublicValidator.js}

@@ -1,5 +1,6 @@
-const Validator = require("../PublicModels");
 const Joi = require("joi");
+
+const WebhookModel = require("./WebhookPublicModel");
 class WebhookValidator {
   static fetchAllWebhookEvents() {
     return Joi.object({});
@@ -7,8 +8,9 @@ class WebhookValidator {
 
   static queryWebhookEventDetails() {
     return Joi.object({
-      body: Joi.array().items(Validator.EventConfigBase()).required(),
+      body: Joi.array().items(WebhookModel.EventConfigBase()).required(),
     }).required();
   }
 }
+
 module.exports = WebhookValidator;

package/sdk/public/index.d.ts

@@ -1,2 +1,7 @@
 export const PublicConfig: typeof import("./PublicConfig");
 export const PublicClient: typeof import("./PublicClient");
+export namespace PublicModel {
+    const ConfigurationPublicModel: typeof import("./Configuration/ConfigurationPublicModel");
+    const WebhookPublicModel: typeof import("./Webhook/WebhookPublicModel");
+    const InventoryPublicModel: typeof import("./Inventory/InventoryPublicModel");
+}

package/sdk/public/index.js

@@ -1,4 +1,11 @@
 module.exports = {
   PublicConfig: require("./PublicConfig"),
   PublicClient: require("./PublicClient"),
+  PublicModel: {
+    ConfigurationPublicModel: require("./Configuration/ConfigurationPublicModel"),
+
+    WebhookPublicModel: require("./Webhook/WebhookPublicModel"),
+
+    InventoryPublicModel: require("./Inventory/InventoryPublicModel"),
+  },
 };

package/sdk/platform/PlatformApplicationModels.d.ts

@@ -1,328 +0,0 @@
-export class LeadValidator {
-    static getTickets(): any;
-    static getTicket(): any;
-    static editTicket(): any;
-    static createHistory(): any;
-    static getTicketHistory(): any;
-    static getCustomForm(): any;
-    static editCustomForm(): any;
-    static getCustomForms(): any;
-    static createCustomForm(): any;
-    static getTokenForVideoRoom(): any;
-    static getVideoParticipants(): any;
-    static openVideoRoom(): any;
-    static closeVideoRoom(): any;
-}
-export class ThemeValidator {
-    static getAllPages(): any;
-    static createPage(): any;
-    static updateMultiplePages(): any;
-    static getPage(): any;
-    static updatePage(): any;
-    static deletePage(): any;
-    static getThemeLibrary(): any;
-    static addToThemeLibrary(): any;
-    static applyTheme(): any;
-    static isUpgradable(): any;
-    static upgradeTheme(): any;
-    static getPublicThemes(): any;
-    static createTheme(): any;
-    static getAppliedTheme(): any;
-    static getFonts(): any;
-    static getThemeById(): any;
-    static updateTheme(): any;
-    static deleteTheme(): any;
-    static getThemeForPreview(): any;
-    static publishTheme(): any;
-    static unpublishTheme(): any;
-    static archiveTheme(): any;
-    static unarchiveTheme(): any;
-    static getThemeLastModified(): any;
-}
-export class UserValidator {
-    static getCustomers(): any;
-    static searchUsers(): any;
-    static createUser(): any;
-    static blockOrUnblockUsers(): any;
-    static archiveUser(): any;
-    static unDeleteUser(): any;
-    static updateUser(): any;
-    static createUserSession(): any;
-    static getActiveSessions(): any;
-    static deleteActiveSessions(): any;
-    static getPlatformConfig(): any;
-    static updatePlatformConfig(): any;
-}
-export class ContentValidator {
-    static getAnnouncementsList(): any;
-    static createAnnouncement(): any;
-    static getAnnouncementById(): any;
-    static updateAnnouncement(): any;
-    static updateAnnouncementSchedule(): any;
-    static deleteAnnouncement(): any;
-    static createBlog(): any;
-    static getBlogs(): any;
-    static updateBlog(): any;
-    static deleteBlog(): any;
-    static getComponentById(): any;
-    static addDataLoader(): any;
-    static getDataLoaders(): any;
-    static deleteDataLoader(): any;
-    static editDataLoader(): any;
-    static selectDataLoader(): any;
-    static resetDataLoader(): any;
-    static getFaqCategories(): any;
-    static getFaqCategoryBySlugOrId(): any;
-    static createFaqCategory(): any;
-    static updateFaqCategory(): any;
-    static deleteFaqCategory(): any;
-    static getFaqsByCategoryIdOrSlug(): any;
-    static addFaq(): any;
-    static updateFaq(): any;
-    static deleteFaq(): any;
-    static getFaqByIdOrSlug(): any;
-    static getLandingPages(): any;
-    static createLandingPage(): any;
-    static updateLandingPage(): any;
-    static deleteLandingPage(): any;
-    static getLegalInformation(): any;
-    static updateLegalInformation(): any;
-    static getNavigations(): any;
-    static createNavigation(): any;
-    static getDefaultNavigations(): any;
-    static getNavigationBySlug(): any;
-    static updateNavigation(): any;
-    static deleteNavigation(): any;
-    static getPageMeta(): any;
-    static getPageSpec(): any;
-    static createPagePreview(): any;
-    static updatePagePreview(): any;
-    static deletePage(): any;
-    static addPathRedirectionRules(): any;
-    static getPathRedirectionRules(): any;
-    static getPathRedirectionRule(): any;
-    static updatePathRedirectionRules(): any;
-    static deletePathRedirectionRules(): any;
-    static getSEOConfiguration(): any;
-    static updateSEOConfiguration(): any;
-    static getSlideshows(): any;
-    static createSlideshow(): any;
-    static getSlideshowBySlug(): any;
-    static updateSlideshow(): any;
-    static deleteSlideshow(): any;
-    static getSupportInformation(): any;
-    static updateSupportInformation(): any;
-    static updateInjectableTag(): any;
-    static deleteAllInjectableTags(): any;
-    static getInjectableTags(): any;
-    static addInjectableTag(): any;
-    static removeInjectableTag(): any;
-    static editInjectableTag(): any;
-    static createPage(): any;
-    static getPages(): any;
-    static updatePage(): any;
-    static getPageBySlug(): any;
-}
-export class CommunicationValidator {
-    static getCampaigns(): any;
-    static createCampaign(): any;
-    static getCampaignById(): any;
-    static updateCampaignById(): any;
-    static getStatsOfCampaignById(): any;
-    static getAudiences(): any;
-    static createAudience(): any;
-    static getBigqueryHeaders(): any;
-    static getAudienceById(): any;
-    static updateAudienceById(): any;
-    static getNSampleRecordsFromCsv(): any;
-    static getEmailProviders(): any;
-    static createEmailProvider(): any;
-    static getEmailProviderById(): any;
-    static updateEmailProviderById(): any;
-    static getEmailTemplates(): any;
-    static createEmailTemplate(): any;
-    static getSystemEmailTemplates(): any;
-    static getEmailTemplateById(): any;
-    static updateEmailTemplateById(): any;
-    static deleteEmailTemplateById(): any;
-    static sendCommunicationSynchronously(): any;
-    static sendCommunicationAsynchronously(): any;
-    static getEventSubscriptions(): any;
-    static getJobs(): any;
-    static triggerCampaignJob(): any;
-    static getJobLogs(): any;
-    static getCommunicationLogs(): any;
-    static sendOtp(): any;
-    static verfiyOtp(): any;
-    static getSmsProviders(): any;
-    static createSmsProvider(): any;
-    static getSmsProviderById(): any;
-    static updateSmsProviderById(): any;
-    static getSmsTemplates(): any;
-    static createSmsTemplate(): any;
-    static getSmsTemplateById(): any;
-    static updateSmsTemplateById(): any;
-    static deleteSmsTemplateById(): any;
-    static getSystemSystemTemplates(): any;
-}
-export class PaymentValidator {
-    static getBrandPaymentGatewayConfig(): any;
-    static saveBrandPaymentGatewayConfig(): any;
-    static updateBrandPaymentGatewayConfig(): any;
-    static getPaymentModeRoutes(): any;
-    static getBankAccountDetailsOpenAPI(): any;
-    static addRefundBankAccountUsingOTP(): any;
-    static getUserOrderBeneficiaries(): any;
-    static getUserBeneficiaries(): any;
-    static confirmPayment(): any;
-    static getUserCODlimitRoutes(): any;
-    static setUserCODlimitRoutes(): any;
-}
-export class OrderValidator {
-    static getApplicationShipments(): any;
-    static getAppOrderShipmentDetails(): any;
-    static trackPlatformShipment(): any;
-}
-export class CatalogValidator {
-    static deleteSearchKeywords(): any;
-    static updateSearchKeywords(): any;
-    static getSearchKeywords(): any;
-    static createCustomKeyword(): any;
-    static getAllSearchKeyword(): any;
-    static deleteAutocompleteKeyword(): any;
-    static updateAutocompleteKeyword(): any;
-    static getAutocompleteKeywordDetail(): any;
-    static createCustomAutocompleteRule(): any;
-    static getAutocompleteConfig(): any;
-    static getAppProduct(): any;
-    static updateAppProduct(): any;
-    static getConfigurationMetadata(): any;
-    static createGroupConfiguration(): any;
-    static getGroupConfigurations(): any;
-    static deleteGroupConfiguration(): any;
-    static updateGroupConfiguration(): any;
-    static createListingConfiguration(): any;
-    static getListingConfigurations(): any;
-    static deleteListingConfiguration(): any;
-    static updateListingConfiguration(): any;
-    static updateAllowSingle(): any;
-    static updateDefaultSort(): any;
-    static getCatalogConfiguration(): any;
-    static createConfigurationProductListing(): any;
-    static getConfigurations(): any;
-    static createConfigurationByType(): any;
-    static getConfigurationByType(): any;
-    static getQueryFilters(): any;
-    static createCollection(): any;
-    static getAllCollections(): any;
-    static getCollectionDetail(): any;
-    static deleteCollection(): any;
-    static updateCollection(): any;
-    static addCollectionItems(): any;
-    static getCollectionItems(): any;
-    static getCatalogInsights(): any;
-    static getDiscountedInventoryBySizeIdentifier(): any;
-    static getApplicationBrands(): any;
-    static getDepartments(): any;
-    static getCategories(): any;
-    static getAppicationProducts(): any;
-    static getProductDetailBySlug(): any;
-    static getAppProducts(): any;
-    static getAppInventory(): any;
-    static getAppLocations(): any;
-    static getApplicationBrandListing(): any;
-    static updateAppBrand(): any;
-    static getApplicationCategoryListing(): any;
-    static updateAppCategory(): any;
-    static getApplicationDepartmentListing(): any;
-    static updateAppDepartment(): any;
-    static updateAppLocation(): any;
-}
-export class FileStorageValidator {
-    static appStartUpload(): any;
-    static appCompleteUpload(): any;
-    static appCopyFiles(): any;
-    static browse(): any;
-}
-export class ShareValidator {
-    static createShortLink(): any;
-    static getShortLinks(): any;
-    static getShortLinkByHash(): any;
-    static updateShortLinkById(): any;
-}
-export class ConfigurationValidator {
-    static getBuildConfig(): any;
-    static updateBuildConfig(): any;
-    static getPreviousVersions(): any;
-    static getAppFeatures(): any;
-    static updateAppFeatures(): any;
-    static getAppBasicDetails(): any;
-    static updateAppBasicDetails(): any;
-    static getAppContactInfo(): any;
-    static updateAppContactInfo(): any;
-    static getAppApiTokens(): any;
-    static updateAppApiTokens(): any;
-    static getAppCompanies(): any;
-    static getAppStores(): any;
-    static getInventoryConfig(): any;
-    static updateInventoryConfig(): any;
-    static partiallyUpdateInventoryConfig(): any;
-    static getAppCurrencyConfig(): any;
-    static updateAppCurrencyConfig(): any;
-    static getAppSupportedCurrency(): any;
-    static getOrderingStoresByFilter(): any;
-    static updateOrderingStoreConfig(): any;
-    static getStaffOrderingStores(): any;
-    static getDomains(): any;
-    static addDomain(): any;
-    static removeDomainById(): any;
-    static changeDomainType(): any;
-    static getDomainStatus(): any;
-    static getApplicationById(): any;
-}
-export class CartValidator {
-    static getCoupons(): any;
-    static createCoupon(): any;
-    static getCouponById(): any;
-    static updateCoupon(): any;
-    static updateCouponPartially(): any;
-    static getPromotions(): any;
-    static createPromotion(): any;
-    static getPromotionById(): any;
-    static updatePromotion(): any;
-    static updatePromotionPartially(): any;
-    static fetchAndvalidateCartItems(): any;
-    static checkCartServiceability(): any;
-    static checkoutCart(): any;
-    static getAbandonedCart(): any;
-    static getAbandonedCartDetails(): any;
-    static addItems(): any;
-    static updateCart(): any;
-}
-export class RewardsValidator {
-    static showGiveaways(): any;
-    static saveGiveAway(): any;
-    static getGiveawayById(): any;
-    static updateGiveAway(): any;
-    static getGiveawayAudienceStatus(): any;
-    static showOffers(): any;
-    static getOfferByName(): any;
-    static updateOfferByName(): any;
-    static updateUserStatus(): any;
-    static user(): any;
-    static getUserPointsHistory(): any;
-}
-export class AnalyticsValidator {
-    static getStatiscticsGroups(): any;
-    static getStatiscticsGroupComponents(): any;
-    static getComponentStatsCSV(): any;
-    static getComponentStatsPDF(): any;
-    static getComponentStats(): any;
-    static getAbandonCartList(): any;
-    static getAbandonCartsCSV(): any;
-    static getAbandonCartDetail(): any;
-}
-export class PartnerValidator {
-    static addProxyPath(): any;
-    static removeProxyPath(): any;
-}