@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

package/sdk/application/Common/CommonApplicationModel.js

@@ -1,47 +1,28 @@
 const Joi = require("joi");
 
 /**
- * @typedef Application
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
+ * @typedef ApplicationResponse
+ * @property {Application} [application]
+ */
+
+/**
+ * @typedef Domain
+ * @property {boolean} [verified] - Indicates domain is verified or not. TXT and
+ *   A records should propagate correctly.
+ * @property {boolean} [is_primary] - Indicates domain is primary or not.
+ *   Primary domain is the default/main domain.
+ * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
- * @property {string} [app_type] - It shows whether application is live or in
- *   development mode
- * @property {ApplicationAuth} [auth]
- * @property {SecureUrl} [banner]
- * @property {number} [cache_ttl] - An integer value that specifies the number
- *   of seconds until the key expires
- * @property {string} [channel_type] - It indicates different channel types like
- *   store, website-and-mobile-apps. Default value is store.
- * @property {number} [company_id] - Numeric ID allotted to a business account
- *   where the sales channel exists
- * @property {ApplicationCors} [cors]
- * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
- * @property {string} [description] - It contains detailed information about the
- *   sales channel
- * @property {Domain} [domain]
- * @property {Domain[]} [domains]
- * @property {SecureUrl} [favicon]
- * @property {boolean} [is_active] - Indicates whether a sales channel is active
- *   or not active
- * @property {boolean} [is_internal] - Indicates whether a sales channel is
- *   internal or not
- * @property {SecureUrl} [logo]
- * @property {ApplicationMeta[]} [meta]
- * @property {SecureUrl} [mobile_logo]
- * @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 {ApplicationRedirections[]} [redirections]
- * @property {string} [token] - Randomly generated fixed-length string for sales
- *   channel. It is required and auto-generated.
- * @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
- * @property {ApplicationWebsite} [website]
+ *   of the domain
+ * @property {string} [name]
+ * @property {boolean} [is_predefined] - Domain is hosting domain or not
  */
 
 /**
- * @typedef ApplicationAuth
- * @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
+ * @typedef ApplicationWebsite
+ * @property {boolean} [enabled] - Shows whether sales channel website URL is
+ *   enabled or not
+ * @property {string} [basepath] - Base path for the current sales channel website
  */
 
 /**
@@ -50,9 +31,8 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ApplicationMeta
- * @property {string} [name] - Indicates the name of application meta
- * @property {string} [value] - Value related to application meta name
+ * @typedef ApplicationAuth
+ * @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
  */
 
 /**
@@ -66,15 +46,58 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef ApplicationResponse
- * @property {Application} [application]
+ * @typedef ApplicationMeta
+ * @property {string} [name] - Indicates the name of application meta
+ * @property {string} [value] - Value related to application meta name
  */
 
 /**
- * @typedef ApplicationWebsite
- * @property {string} [basepath] - Base path for the current sales channel website
- * @property {boolean} [enabled] - Shows whether sales channel website URL is
- *   enabled or not
+ * @typedef SecureUrl
+ * @property {string} [secure_url] - Hosted URL of the image
+ */
+
+/**
+ * @typedef Application
+ * @property {ApplicationWebsite} [website]
+ * @property {ApplicationCors} [cors]
+ * @property {ApplicationAuth} [auth]
+ * @property {string} [description] - It contains detailed information about the
+ *   sales channel
+ * @property {string} [channel_type] - It indicates different channel types like
+ *   store, website-and-mobile-apps. Default value is store.
+ * @property {number} [cache_ttl] - An integer value that specifies the number
+ *   of seconds until the key expires
+ * @property {boolean} [is_internal] - Indicates whether a sales channel is
+ *   internal or not
+ * @property {boolean} [is_active] - Indicates whether a sales channel is active
+ *   or not active
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
+ *   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 {number} [company_id] - Numeric ID allotted to a business account
+ *   where the sales channel exists
+ * @property {string} [token] - Randomly generated fixed-length string for sales
+ *   channel. It is required and auto-generated.
+ * @property {ApplicationRedirections[]} [redirections]
+ * @property {ApplicationMeta[]} [meta]
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
+ * @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
+ * @property {SecureUrl} [banner]
+ * @property {SecureUrl} [logo]
+ * @property {SecureUrl} [favicon]
+ * @property {Domain[]} [domains]
+ * @property {string} [app_type] - It shows whether application is live or in
+ *   development mode
+ * @property {SecureUrl} [mobile_logo]
+ * @property {Domain} [domain]
+ */
+
+/**
+ * @typedef NotFound
+ * @property {string} [message] - Response message for not found
  */
 
 /**
@@ -83,50 +106,37 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef Domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
- * @property {boolean} [is_predefined] - Domain is hosting domain or not
- * @property {boolean} [is_primary] - Indicates domain is primary or not.
- *   Primary domain is the default/main domain.
- * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
+ * @typedef LocationDefaultLanguage
  * @property {string} [name]
- * @property {boolean} [verified] - Indicates domain is verified or not. TXT and
- *   A records should propagate correctly.
+ * @property {string} [code]
+ */
+
+/**
+ * @typedef LocationDefaultCurrency
+ * @property {string} [name]
+ * @property {string} [symbol]
+ * @property {string} [code]
  */
 
 /**
  * @typedef LocationCountry
- * @property {number} [__v]
- * @property {string} [_id]
  * @property {string} [capital]
- * @property {string} [country_code]
  * @property {string} [currency]
- * @property {LocationDefaultCurrency} [default_currency]
- * @property {LocationDefaultLanguage} [default_language]
  * @property {string} [iso2]
  * @property {string} [iso3]
- * @property {string} [latitude]
- * @property {string} [longitude]
  * @property {string} [name]
  * @property {string} [parent]
  * @property {string} [phone_code]
- * @property {string} [state_code]
  * @property {string} [type]
  * @property {number} [uid]
- */
-
-/**
- * @typedef LocationDefaultCurrency
- * @property {string} [code]
- * @property {string} [name]
- * @property {string} [symbol]
- */
-
-/**
- * @typedef LocationDefaultLanguage
- * @property {string} [code]
- * @property {string} [name]
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {LocationDefaultCurrency} [default_currency]
+ * @property {LocationDefaultLanguage} [default_language]
+ * @property {string} [state_code]
+ * @property {string} [country_code]
+ * @property {string} [latitude]
+ * @property {string} [longitude]
  */
 
 /**
@@ -134,54 +144,31 @@ const Joi = require("joi");
  * @property {LocationCountry[]} [items]
  */
 
-/**
- * @typedef NotFound
- * @property {string} [message] - Response message for not found
- */
-
-/**
- * @typedef SecureUrl
- * @property {string} [secure_url] - Hosted URL of the image
- */
-
 class CommonApplicationModel {
-  /** @returns {Application} */
-  static Application() {
+  /** @returns {ApplicationResponse} */
+  static ApplicationResponse() {
     return Joi.object({
-      __v: Joi.number(),
+      application: CommonApplicationModel.Application(),
+    });
+  }
+
+  /** @returns {Domain} */
+  static Domain() {
+    return Joi.object({
+      verified: Joi.boolean(),
+      is_primary: Joi.boolean(),
+      is_shortlink: Joi.boolean(),
       _id: Joi.string().allow(""),
-      app_type: Joi.string().allow(""),
-      auth: CommonApplicationModel.ApplicationAuth(),
-      banner: CommonApplicationModel.SecureUrl(),
-      cache_ttl: Joi.number(),
-      channel_type: Joi.string().allow(""),
-      company_id: Joi.number(),
-      cors: CommonApplicationModel.ApplicationCors(),
-      created_at: Joi.string().allow(""),
-      description: Joi.string().allow(""),
-      domain: CommonApplicationModel.Domain(),
-      domains: Joi.array().items(CommonApplicationModel.Domain()),
-      favicon: CommonApplicationModel.SecureUrl(),
-      is_active: Joi.boolean(),
-      is_internal: Joi.boolean(),
-      logo: CommonApplicationModel.SecureUrl(),
-      meta: Joi.array().items(CommonApplicationModel.ApplicationMeta()),
-      mobile_logo: CommonApplicationModel.SecureUrl(),
       name: Joi.string().allow(""),
-      owner: Joi.string().allow(""),
-      redirections: Joi.array().items(
-        CommonApplicationModel.ApplicationRedirections()
-      ),
-      token: Joi.string().allow(""),
-      updated_at: Joi.string().allow(""),
-      website: CommonApplicationModel.ApplicationWebsite(),
+      is_predefined: Joi.boolean(),
     });
   }
 
-  /** @returns {ApplicationAuth} */
-  static ApplicationAuth() {
+  /** @returns {ApplicationWebsite} */
+  static ApplicationWebsite() {
     return Joi.object({
       enabled: Joi.boolean(),
+      basepath: Joi.string().allow(""),
     });
   }
 
@@ -192,11 +179,10 @@ class CommonApplicationModel {
     });
   }
 
-  /** @returns {ApplicationMeta} */
-  static ApplicationMeta() {
+  /** @returns {ApplicationAuth} */
+  static ApplicationAuth() {
     return Joi.object({
-      name: Joi.string().allow(""),
-      value: Joi.string().allow(""),
+      enabled: Joi.boolean(),
     });
   }
 
@@ -209,77 +195,105 @@ class CommonApplicationModel {
     });
   }
 
-  /** @returns {ApplicationResponse} */
-  static ApplicationResponse() {
+  /** @returns {ApplicationMeta} */
+  static ApplicationMeta() {
     return Joi.object({
-      application: CommonApplicationModel.Application(),
+      name: Joi.string().allow(""),
+      value: Joi.string().allow(""),
     });
   }
 
-  /** @returns {ApplicationWebsite} */
-  static ApplicationWebsite() {
+  /** @returns {SecureUrl} */
+  static SecureUrl() {
     return Joi.object({
-      basepath: Joi.string().allow(""),
-      enabled: Joi.boolean(),
+      secure_url: Joi.string().allow(""),
     });
   }
 
-  /** @returns {BadRequest} */
-  static BadRequest() {
+  /** @returns {Application} */
+  static Application() {
+    return Joi.object({
+      website: CommonApplicationModel.ApplicationWebsite(),
+      cors: CommonApplicationModel.ApplicationCors(),
+      auth: CommonApplicationModel.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(
+        CommonApplicationModel.ApplicationRedirections()
+      ),
+      meta: Joi.array().items(CommonApplicationModel.ApplicationMeta()),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      __v: Joi.number(),
+      banner: CommonApplicationModel.SecureUrl(),
+      logo: CommonApplicationModel.SecureUrl(),
+      favicon: CommonApplicationModel.SecureUrl(),
+      domains: Joi.array().items(CommonApplicationModel.Domain()),
+      app_type: Joi.string().allow(""),
+      mobile_logo: CommonApplicationModel.SecureUrl(),
+      domain: CommonApplicationModel.Domain(),
+    });
+  }
+
+  /** @returns {NotFound} */
+  static NotFound() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
 
-  /** @returns {Domain} */
-  static Domain() {
+  /** @returns {BadRequest} */
+  static BadRequest() {
     return Joi.object({
-      _id: Joi.string().allow(""),
-      is_predefined: Joi.boolean(),
-      is_primary: Joi.boolean(),
-      is_shortlink: Joi.boolean(),
-      name: Joi.string().allow(""),
-      verified: Joi.boolean(),
+      message: Joi.string().allow(""),
     });
   }
 
-  /** @returns {LocationCountry} */
-  static LocationCountry() {
+  /** @returns {LocationDefaultLanguage} */
+  static LocationDefaultLanguage() {
     return Joi.object({
-      __v: Joi.number(),
-      _id: Joi.string().allow(""),
-      capital: Joi.string().allow(""),
-      country_code: Joi.string().allow(""),
-      currency: Joi.string().allow(""),
-      default_currency: CommonApplicationModel.LocationDefaultCurrency(),
-      default_language: CommonApplicationModel.LocationDefaultLanguage(),
-      iso2: Joi.string().allow(""),
-      iso3: Joi.string().allow(""),
-      latitude: Joi.string().allow(""),
-      longitude: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      parent: Joi.string().allow(""),
-      phone_code: Joi.string().allow(""),
-      state_code: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      uid: Joi.number(),
+      code: Joi.string().allow(""),
     });
   }
 
   /** @returns {LocationDefaultCurrency} */
   static LocationDefaultCurrency() {
     return Joi.object({
-      code: Joi.string().allow(""),
       name: Joi.string().allow(""),
       symbol: Joi.string().allow(""),
+      code: Joi.string().allow(""),
     });
   }
 
-  /** @returns {LocationDefaultLanguage} */
-  static LocationDefaultLanguage() {
+  /** @returns {LocationCountry} */
+  static LocationCountry() {
     return Joi.object({
-      code: Joi.string().allow(""),
+      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: CommonApplicationModel.LocationDefaultCurrency(),
+      default_language: CommonApplicationModel.LocationDefaultLanguage(),
+      state_code: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
+      latitude: Joi.string().allow(""),
+      longitude: Joi.string().allow(""),
     });
   }
 
@@ -289,19 +303,5 @@ class CommonApplicationModel {
       items: Joi.array().items(CommonApplicationModel.LocationCountry()),
     });
   }
-
-  /** @returns {NotFound} */
-  static NotFound() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SecureUrl} */
-  static SecureUrl() {
-    return Joi.object({
-      secure_url: Joi.string().allow(""),
-    });
-  }
 }
 module.exports = CommonApplicationModel;

package/sdk/application/Communication/CommunicationApplicationModel.d.ts

@@ -1,136 +1,136 @@
 export = CommunicationApplicationModel;
 /**
- * @typedef BadRequestSchema
- * @property {string} [message] - Failure message.
- * @property {string} [status] - Response status.
+ * @typedef CommunicationConsentReq
+ * @property {string} [response]
+ * @property {string} [action]
+ * @property {string} [channel]
  */
 /**
- * @typedef CommunicationConsent
+ * @typedef CommunicationConsentRes
  * @property {string} [app_id]
- * @property {CommunicationConsentChannels} [channels]
  * @property {string} [user_id]
- */
-/**
- * @typedef CommunicationConsentChannels
- * @property {CommunicationConsentChannelsEmail} [email]
- * @property {CommunicationConsentChannelsSms} [sms]
- * @property {CommunicationConsentChannelsWhatsapp} [whatsapp]
+ * @property {CommunicationConsentChannels} [channels]
  */
 /**
  * @typedef CommunicationConsentChannelsEmail
- * @property {string} [display_name]
  * @property {string} [response]
+ * @property {string} [display_name]
  */
 /**
  * @typedef CommunicationConsentChannelsSms
- * @property {string} [display_name]
  * @property {string} [response]
+ * @property {string} [display_name]
  */
 /**
  * @typedef CommunicationConsentChannelsWhatsapp
- * @property {string} [country_code]
+ * @property {string} [response]
  * @property {string} [display_name]
+ * @property {string} [country_code]
  * @property {string} [phone_number]
- * @property {string} [response]
  */
 /**
- * @typedef CommunicationConsentReq
- * @property {string} [action]
- * @property {string} [channel]
- * @property {string} [response]
+ * @typedef CommunicationConsentChannels
+ * @property {CommunicationConsentChannelsEmail} [email]
+ * @property {CommunicationConsentChannelsSms} [sms]
+ * @property {CommunicationConsentChannelsWhatsapp} [whatsapp]
  */
 /**
- * @typedef CommunicationConsentRes
+ * @typedef CommunicationConsent
  * @property {string} [app_id]
- * @property {CommunicationConsentChannels} [channels]
  * @property {string} [user_id]
+ * @property {CommunicationConsentChannels} [channels]
+ */
+/**
+ * @typedef BadRequestSchema
+ * @property {string} [status] - Response status.
+ * @property {string} [message] - Failure message.
  */
 /**
  * @typedef PushtokenReq
  * @property {string} [action]
  * @property {string} [bundle_identifier]
  * @property {string} [push_token]
- * @property {string} [type]
  * @property {string} [unique_device_id]
+ * @property {string} [type]
  */
 /**
  * @typedef PushtokenRes
  * @property {string} [_id]
- * @property {string} [application_id]
  * @property {string} [bundle_identifier]
- * @property {string} [created_at]
- * @property {string} [expired_at]
- * @property {string} [platform]
  * @property {string} [push_token]
- * @property {string} [type]
  * @property {string} [unique_device_id]
- * @property {string} [updated_at]
+ * @property {string} [type]
+ * @property {string} [platform]
+ * @property {string} [application_id]
  * @property {string} [user_id]
+ * @property {string} [created_at]
+ * @property {string} [updated_at]
+ * @property {string} [expired_at]
  */
 declare class CommunicationApplicationModel {
 }
 declare namespace CommunicationApplicationModel {
-    export { BadRequestSchema, CommunicationConsent, CommunicationConsentChannels, CommunicationConsentChannelsEmail, CommunicationConsentChannelsSms, CommunicationConsentChannelsWhatsapp, CommunicationConsentReq, CommunicationConsentRes, PushtokenReq, PushtokenRes };
+    export { CommunicationConsentReq, CommunicationConsentRes, CommunicationConsentChannelsEmail, CommunicationConsentChannelsSms, CommunicationConsentChannelsWhatsapp, CommunicationConsentChannels, CommunicationConsent, BadRequestSchema, PushtokenReq, PushtokenRes };
 }
-/** @returns {BadRequestSchema} */
-declare function BadRequestSchema(): BadRequestSchema;
-type BadRequestSchema = {
-    /**
-     * - Failure message.
-     */
-    message?: string;
-    /**
-     * - Response status.
-     */
-    status?: string;
+/** @returns {CommunicationConsentReq} */
+declare function CommunicationConsentReq(): CommunicationConsentReq;
+type CommunicationConsentReq = {
+    response?: string;
+    action?: string;
+    channel?: string;
 };
-/** @returns {CommunicationConsent} */
-declare function CommunicationConsent(): CommunicationConsent;
-type CommunicationConsent = {
+/** @returns {CommunicationConsentRes} */
+declare function CommunicationConsentRes(): CommunicationConsentRes;
+type CommunicationConsentRes = {
     app_id?: string;
-    channels?: CommunicationConsentChannels;
     user_id?: string;
-};
-/** @returns {CommunicationConsentChannels} */
-declare function CommunicationConsentChannels(): CommunicationConsentChannels;
-type CommunicationConsentChannels = {
-    email?: CommunicationConsentChannelsEmail;
-    sms?: CommunicationConsentChannelsSms;
-    whatsapp?: CommunicationConsentChannelsWhatsapp;
+    channels?: CommunicationConsentChannels;
 };
 /** @returns {CommunicationConsentChannelsEmail} */
 declare function CommunicationConsentChannelsEmail(): CommunicationConsentChannelsEmail;
 type CommunicationConsentChannelsEmail = {
-    display_name?: string;
     response?: string;
+    display_name?: string;
 };
 /** @returns {CommunicationConsentChannelsSms} */
 declare function CommunicationConsentChannelsSms(): CommunicationConsentChannelsSms;
 type CommunicationConsentChannelsSms = {
-    display_name?: string;
     response?: string;
+    display_name?: string;
 };
 /** @returns {CommunicationConsentChannelsWhatsapp} */
 declare function CommunicationConsentChannelsWhatsapp(): CommunicationConsentChannelsWhatsapp;
 type CommunicationConsentChannelsWhatsapp = {
-    country_code?: string;
+    response?: string;
     display_name?: string;
+    country_code?: string;
     phone_number?: string;
-    response?: string;
 };
-/** @returns {CommunicationConsentReq} */
-declare function CommunicationConsentReq(): CommunicationConsentReq;
-type CommunicationConsentReq = {
-    action?: string;
-    channel?: string;
-    response?: string;
+/** @returns {CommunicationConsentChannels} */
+declare function CommunicationConsentChannels(): CommunicationConsentChannels;
+type CommunicationConsentChannels = {
+    email?: CommunicationConsentChannelsEmail;
+    sms?: CommunicationConsentChannelsSms;
+    whatsapp?: CommunicationConsentChannelsWhatsapp;
 };
-/** @returns {CommunicationConsentRes} */
-declare function CommunicationConsentRes(): CommunicationConsentRes;
-type CommunicationConsentRes = {
+/** @returns {CommunicationConsent} */
+declare function CommunicationConsent(): CommunicationConsent;
+type CommunicationConsent = {
     app_id?: string;
-    channels?: CommunicationConsentChannels;
     user_id?: string;
+    channels?: CommunicationConsentChannels;
+};
+/** @returns {BadRequestSchema} */
+declare function BadRequestSchema(): BadRequestSchema;
+type BadRequestSchema = {
+    /**
+     * - Response status.
+     */
+    status?: string;
+    /**
+     * - Failure message.
+     */
+    message?: string;
 };
 /** @returns {PushtokenReq} */
 declare function PushtokenReq(): PushtokenReq;
@@ -138,21 +138,21 @@ type PushtokenReq = {
     action?: string;
     bundle_identifier?: string;
     push_token?: string;
-    type?: string;
     unique_device_id?: string;
+    type?: string;
 };
 /** @returns {PushtokenRes} */
 declare function PushtokenRes(): PushtokenRes;
 type PushtokenRes = {
     _id?: string;
-    application_id?: string;
     bundle_identifier?: string;
-    created_at?: string;
-    expired_at?: string;
-    platform?: string;
     push_token?: string;
-    type?: string;
     unique_device_id?: string;
-    updated_at?: string;
+    type?: string;
+    platform?: string;
+    application_id?: string;
     user_id?: string;
+    created_at?: string;
+    updated_at?: string;
+    expired_at?: string;
 };