@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15-beta.3

package/sdk/application/Common/CommonApplicationModel.js

@@ -1,308 +0,0 @@
-const Joi = require("joi");
-
-/**
- * @typedef ApplicationResponse
- * @property {Application} [application]
- */
-
-/**
- * @typedef Domain
- * @property {boolean} [verified] - Whether domain is verified or not. TXT and A
- *   records should propagate correctly.
- * @property {boolean} [is_primary] - Whether domain is primary or not. Primary
- *   domain is the default/main domain.
- * @property {boolean} [is_shortlink] - Whether shortlink is present or not for
- *   the domain.
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain.
- * @property {string} [name] - The name of the domain.
- * @property {boolean} [is_predefined] - Whether domain is hosting domain or not.
- */
-
-/**
- * @typedef ApplicationWebsite
- * @property {boolean} [enabled] - Whether sales channel website URL is enabled or not.
- * @property {string} [basepath] - Base path for the current sales channel website.
- */
-
-/**
- * @typedef ApplicationCors
- * @property {string[]} [domains] - List of all domains added to the sales channel.
- */
-
-/**
- * @typedef ApplicationAuth
- * @property {boolean} [enabled] - Whether sales channel auth is enabled or not enabled.
- */
-
-/**
- * @typedef ApplicationRedirections
- * @property {string} [redirect_from] - Old domain URL of the sales channel.
- * @property {string} [redirect_to] - New domain URL of the sales channel. Users
- *   will be automatically redirected from old domain to new domain.
- * @property {string} [type] - It shows domain redirection type. Permanent
- *   redirection is for long time period redirection, and temporary redirection
- *   for a short time period.
- */
-
-/**
- * @typedef ApplicationMeta
- * @property {string} [name] - Indicates the name of application meta.
- * @property {string} [value] - Value related to application meta name.
- */
-
-/**
- * @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] - 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] - Number of seconds until the key expires.
- * @property {boolean} [is_internal] - Whether a sales channel is internal or not.
- * @property {boolean} [is_active] - 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] - List of redirection
- *   configurations for the sales channel.
- * @property {ApplicationMeta[]} [meta] - List of metadata associated with the
- *   sales channel.
- * @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] - List of domains associated with the sales channel.
- * @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.
- */
-
-/**
- * @typedef BadRequest
- * @property {string} [message] - Failure message (in a string format).
- */
-
-/**
- * @typedef LocationDefaultLanguage
- * @property {string} [name] - Name of the language.
- * @property {string} [code] - Code of the language.
- */
-
-/**
- * @typedef LocationDefaultCurrency
- * @property {string} [name] - The name of the currency.
- * @property {string} [symbol] - The symbol representing the currency.
- * @property {string} [code] - The ISO 4217 code for the currency.
- */
-
-/**
- * @typedef LocationCountry
- * @property {string} [capital] - The capital of the country.
- * @property {string} [currency] - The currency code used in the country.
- * @property {string} [iso2] - The ISO 3166-1 alpha-2 code for the country.
- * @property {string} [iso3] - The ISO 3166-1 alpha-3 code for the country.
- * @property {string} [name] - The name of the country.
- * @property {string} [parent] - The parent country if this is a subnational
- *   entity (e.g., a territory or region).
- * @property {string} [phone_code] - The international dialing code for the country.
- * @property {string} [type] - The type of location, which is a country in this context.
- * @property {number} [uid] - A unique identifier for the country.
- * @property {number} [__v] - Version key for tracking revisions.
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   for the country.
- * @property {LocationDefaultCurrency} [default_currency]
- * @property {LocationDefaultLanguage} [default_language]
- * @property {string} [state_code] - The code representing the state or region
- *   within the country, if applicable.
- * @property {string} [country_code] - The country code used for the country.
- * @property {string} [latitude] - The latitude of the store's location.
- * @property {string} [longitude] - The longitude of the store's location.
- */
-
-/**
- * @typedef Locations
- * @property {LocationCountry[]} [items] - A list of country location details.
- */
-
-class CommonApplicationModel {
-  /** @returns {ApplicationResponse} */
-  static ApplicationResponse() {
-    return Joi.object({
-      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(""),
-      name: Joi.string().allow(""),
-      is_predefined: Joi.boolean(),
-    });
-  }
-
-  /** @returns {ApplicationWebsite} */
-  static ApplicationWebsite() {
-    return Joi.object({
-      enabled: Joi.boolean(),
-      basepath: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ApplicationCors} */
-  static ApplicationCors() {
-    return Joi.object({
-      domains: Joi.array().items(Joi.string().allow("")),
-    });
-  }
-
-  /** @returns {ApplicationAuth} */
-  static ApplicationAuth() {
-    return Joi.object({
-      enabled: Joi.boolean(),
-    });
-  }
-
-  /** @returns {ApplicationRedirections} */
-  static ApplicationRedirections() {
-    return Joi.object({
-      redirect_from: Joi.string().allow(""),
-      redirect_to: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ApplicationMeta} */
-  static ApplicationMeta() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      value: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SecureUrl} */
-  static SecureUrl() {
-    return Joi.object({
-      secure_url: Joi.string().allow(""),
-    });
-  }
-
-  /** @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 {BadRequest} */
-  static BadRequest() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {LocationDefaultLanguage} */
-  static LocationDefaultLanguage() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {LocationDefaultCurrency} */
-  static LocationDefaultCurrency() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      symbol: Joi.string().allow(""),
-      code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {LocationCountry} */
-  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: CommonApplicationModel.LocationDefaultCurrency(),
-      default_language: CommonApplicationModel.LocationDefaultLanguage(),
-      state_code: Joi.string().allow(""),
-      country_code: Joi.string().allow(""),
-      latitude: Joi.string().allow(""),
-      longitude: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Locations} */
-  static Locations() {
-    return Joi.object({
-      items: Joi.array().items(CommonApplicationModel.LocationCountry()),
-    });
-  }
-}
-module.exports = CommonApplicationModel;

package/sdk/application/Common/CommonApplicationValidator.d.ts

@@ -1,46 +0,0 @@
-export = CommonApplicationValidator;
-/**
- * @typedef GetLocationsParam
- * @property {string} [locationType] - Provide location type to query on.
- *   Possible values : country, state, city.
- * @property {string} [id] - Field is optional when location_type is country. If
- *   querying for state, provide id of country. If querying for city, provide id
- *   of state.
- */
-/**
- * @typedef SearchApplicationParam
- * @property {string} [authorization] - Basic auth string to access the api endpoint.
- * @property {string} [query] - Provide application name.
- */
-declare class CommonApplicationValidator {
-    /** @returns {GetLocationsParam} */
-    static getLocations(): GetLocationsParam;
-    /** @returns {SearchApplicationParam} */
-    static searchApplication(): SearchApplicationParam;
-}
-declare namespace CommonApplicationValidator {
-    export { GetLocationsParam, SearchApplicationParam };
-}
-type GetLocationsParam = {
-    /**
-     * - Provide location type to query on.
-     * Possible values : country, state, city.
-     */
-    locationType?: string;
-    /**
-     * - Field is optional when location_type is country. If
-     * querying for state, provide id of country. If querying for city, provide id
-     * of state.
-     */
-    id?: string;
-};
-type SearchApplicationParam = {
-    /**
-     * - Basic auth string to access the api endpoint.
-     */
-    authorization?: string;
-    /**
-     * - Provide application name.
-     */
-    query?: string;
-};

package/sdk/application/Common/CommonApplicationValidator.js

@@ -1,38 +0,0 @@
-const Joi = require("joi");
-
-const CommonApplicationModel = require("./CommonApplicationModel");
-
-/**
- * @typedef GetLocationsParam
- * @property {string} [locationType] - Provide location type to query on.
- *   Possible values : country, state, city.
- * @property {string} [id] - Field is optional when location_type is country. If
- *   querying for state, provide id of country. If querying for city, provide id
- *   of state.
- */
-
-/**
- * @typedef SearchApplicationParam
- * @property {string} [authorization] - Basic auth string to access the api endpoint.
- * @property {string} [query] - Provide application name.
- */
-
-class CommonApplicationValidator {
-  /** @returns {GetLocationsParam} */
-  static getLocations() {
-    return Joi.object({
-      locationType: Joi.string().allow(""),
-      id: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {SearchApplicationParam} */
-  static searchApplication() {
-    return Joi.object({
-      authorization: Joi.string().allow(""),
-      query: Joi.string().allow(""),
-    });
-  }
-}
-
-module.exports = CommonApplicationValidator;

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

@@ -1,293 +0,0 @@
-export = CommunicationApplicationModel;
-/**
- * @typedef CommunicationConsentReq
- * @property {string} [response] - Whether the user has responded to the inquiry
- *   regarding their preference for opting in or out of receiving communications.
- * @property {string} [action] - The user's choice to opt in or opt out of
- *   receiving communications.
- * @property {string} [channel] - The channel of communication the user has
- *   agreed to receive messages through.
- */
-/**
- * @typedef CommunicationConsentRes
- * @property {string} [app_id] - The ID of the sales channel where the user has
- *   given their consent.
- * @property {string} [user_id] - Identifier which can uniquely identify the user.
- * @property {CommunicationConsentChannels} [channels]
- */
-/**
- * @typedef CommunicationConsentChannelsEmail
- * @property {string} [response] - The user's choice to opt in or opt out of
- *   receiving communications.
- * @property {string} [display_name] - Name of the channel of communication the
- *   user has agreed to receive messages through.
- */
-/**
- * @typedef CommunicationConsentChannelsSms
- * @property {string} [response] - The user's choice to opt in or opt out of
- *   receiving communications.
- * @property {string} [display_name] - Name of the channel of communication the
- *   user has agreed to receive messages through.
- */
-/**
- * @typedef CommunicationConsentChannelsWhatsapp
- * @property {string} [response] - The user's choice to opt in or opt out of
- *   receiving communications.
- * @property {string} [display_name] - Name of the channel of communication the
- *   user has agreed to receive messages through.
- * @property {string} [country_code] - Alphanumeric identification code for the
- *   users country.
- * @property {string} [phone_number] - Phone number of the user that the user
- *   has accepted to receive communication through WhatsApp.
- */
-/**
- * @typedef CommunicationConsentChannels
- * @property {CommunicationConsentChannelsEmail} [email]
- * @property {CommunicationConsentChannelsSms} [sms]
- * @property {CommunicationConsentChannelsWhatsapp} [whatsapp]
- */
-/**
- * @typedef CommunicationConsent
- * @property {string} [app_id] - The ID of the sales channel where the user has
- *   given their consent.
- * @property {string} [user_id] - Identifier which can uniquely identify the user.
- * @property {CommunicationConsentChannels} [channels]
- */
-/**
- * @typedef BadRequestSchema
- * @property {string} [status] - Error code indicating the type of issue.
- * @property {string} [message] - Error message providing details about the error.
- */
-/**
- * @typedef PushtokenReq
- * @property {string} [action] - The type of operation to perform with the push
- *   token, such as create, update, or reset.
- * @property {string} [bundle_identifier] - Unique identifier used to identify a bundle.
- * @property {string} [push_token] - A string of codes containing comprehensive
- *   data that identifies a identity of requester.
- * @property {string} [unique_device_id] - Unique identifier used to identify a device.
- * @property {string} [type] - Source address of the requestee.
- */
-/**
- * @typedef PushtokenRes
- * @property {string} [_id] - Key used to uniquely identify document that
- *   contains push token credentials.
- * @property {string} [bundle_identifier] - Unique identifier used to identify a bundle.
- * @property {string} [push_token] - A string of codes containing comprehensive
- *   data that identifies a identity of requester.
- * @property {string} [unique_device_id] - Unique identifier used to identify a device.
- * @property {string} [type] - Source address of the requester.
- * @property {string} [platform] - Source address of the requester.
- * @property {string} [application_id] - The ID of the sales channel associated
- *   with the push token.
- * @property {string} [user_id] - Identifier which can uniquely identify the user.
- * @property {string} [created_at] - The timestamp indicating when a record was
- *   initially created.
- * @property {string} [updated_at] - The timestamp indicating when a record was
- *   last modified or updated.
- * @property {string} [expired_at] - The timestamp indicating when a record is
- *   set to expire or become invalid.
- */
-declare class CommunicationApplicationModel {
-}
-declare namespace CommunicationApplicationModel {
-    export { CommunicationConsentReq, CommunicationConsentRes, CommunicationConsentChannelsEmail, CommunicationConsentChannelsSms, CommunicationConsentChannelsWhatsapp, CommunicationConsentChannels, CommunicationConsent, BadRequestSchema, PushtokenReq, PushtokenRes };
-}
-/** @returns {CommunicationConsentReq} */
-declare function CommunicationConsentReq(): CommunicationConsentReq;
-type CommunicationConsentReq = {
-    /**
-     * - Whether the user has responded to the inquiry
-     * regarding their preference for opting in or out of receiving communications.
-     */
-    response?: string;
-    /**
-     * - The user's choice to opt in or opt out of
-     * receiving communications.
-     */
-    action?: string;
-    /**
-     * - The channel of communication the user has
-     * agreed to receive messages through.
-     */
-    channel?: string;
-};
-/** @returns {CommunicationConsentRes} */
-declare function CommunicationConsentRes(): CommunicationConsentRes;
-type CommunicationConsentRes = {
-    /**
-     * - The ID of the sales channel where the user has
-     * given their consent.
-     */
-    app_id?: string;
-    /**
-     * - Identifier which can uniquely identify the user.
-     */
-    user_id?: string;
-    channels?: CommunicationConsentChannels;
-};
-/** @returns {CommunicationConsentChannelsEmail} */
-declare function CommunicationConsentChannelsEmail(): CommunicationConsentChannelsEmail;
-type CommunicationConsentChannelsEmail = {
-    /**
-     * - The user's choice to opt in or opt out of
-     * receiving communications.
-     */
-    response?: string;
-    /**
-     * - Name of the channel of communication the
-     * user has agreed to receive messages through.
-     */
-    display_name?: string;
-};
-/** @returns {CommunicationConsentChannelsSms} */
-declare function CommunicationConsentChannelsSms(): CommunicationConsentChannelsSms;
-type CommunicationConsentChannelsSms = {
-    /**
-     * - The user's choice to opt in or opt out of
-     * receiving communications.
-     */
-    response?: string;
-    /**
-     * - Name of the channel of communication the
-     * user has agreed to receive messages through.
-     */
-    display_name?: string;
-};
-/** @returns {CommunicationConsentChannelsWhatsapp} */
-declare function CommunicationConsentChannelsWhatsapp(): CommunicationConsentChannelsWhatsapp;
-type CommunicationConsentChannelsWhatsapp = {
-    /**
-     * - The user's choice to opt in or opt out of
-     * receiving communications.
-     */
-    response?: string;
-    /**
-     * - Name of the channel of communication the
-     * user has agreed to receive messages through.
-     */
-    display_name?: string;
-    /**
-     * - Alphanumeric identification code for the
-     * users country.
-     */
-    country_code?: string;
-    /**
-     * - Phone number of the user that the user
-     * has accepted to receive communication through WhatsApp.
-     */
-    phone_number?: string;
-};
-/** @returns {CommunicationConsentChannels} */
-declare function CommunicationConsentChannels(): CommunicationConsentChannels;
-type CommunicationConsentChannels = {
-    email?: CommunicationConsentChannelsEmail;
-    sms?: CommunicationConsentChannelsSms;
-    whatsapp?: CommunicationConsentChannelsWhatsapp;
-};
-/** @returns {CommunicationConsent} */
-declare function CommunicationConsent(): CommunicationConsent;
-type CommunicationConsent = {
-    /**
-     * - The ID of the sales channel where the user has
-     * given their consent.
-     */
-    app_id?: string;
-    /**
-     * - Identifier which can uniquely identify the user.
-     */
-    user_id?: string;
-    channels?: CommunicationConsentChannels;
-};
-/** @returns {BadRequestSchema} */
-declare function BadRequestSchema(): BadRequestSchema;
-type BadRequestSchema = {
-    /**
-     * - Error code indicating the type of issue.
-     */
-    status?: string;
-    /**
-     * - Error message providing details about the error.
-     */
-    message?: string;
-};
-/** @returns {PushtokenReq} */
-declare function PushtokenReq(): PushtokenReq;
-type PushtokenReq = {
-    /**
-     * - The type of operation to perform with the push
-     * token, such as create, update, or reset.
-     */
-    action?: string;
-    /**
-     * - Unique identifier used to identify a bundle.
-     */
-    bundle_identifier?: string;
-    /**
-     * - A string of codes containing comprehensive
-     * data that identifies a identity of requester.
-     */
-    push_token?: string;
-    /**
-     * - Unique identifier used to identify a device.
-     */
-    unique_device_id?: string;
-    /**
-     * - Source address of the requestee.
-     */
-    type?: string;
-};
-/** @returns {PushtokenRes} */
-declare function PushtokenRes(): PushtokenRes;
-type PushtokenRes = {
-    /**
-     * - Key used to uniquely identify document that
-     * contains push token credentials.
-     */
-    _id?: string;
-    /**
-     * - Unique identifier used to identify a bundle.
-     */
-    bundle_identifier?: string;
-    /**
-     * - A string of codes containing comprehensive
-     * data that identifies a identity of requester.
-     */
-    push_token?: string;
-    /**
-     * - Unique identifier used to identify a device.
-     */
-    unique_device_id?: string;
-    /**
-     * - Source address of the requester.
-     */
-    type?: string;
-    /**
-     * - Source address of the requester.
-     */
-    platform?: string;
-    /**
-     * - The ID of the sales channel associated
-     * with the push token.
-     */
-    application_id?: string;
-    /**
-     * - Identifier which can uniquely identify the user.
-     */
-    user_id?: string;
-    /**
-     * - The timestamp indicating when a record was
-     * initially created.
-     */
-    created_at?: string;
-    /**
-     * - The timestamp indicating when a record was
-     * last modified or updated.
-     */
-    updated_at?: string;
-    /**
-     * - The timestamp indicating when a record is
-     * set to expire or become invalid.
-     */
-    expired_at?: string;
-};