@gofynd/fdk-client-javascript 0.1.35

package/sdk/application/client/CommonApplicationClient.d.ts

@@ -0,0 +1,38 @@
+export = Common;
+declare class Common {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        searchApplication: string;
+        getLocations: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.authorization] -
+     * @param {string} [arg.query] - Provide application name
+     * @returns {Promise<ApplicationResponse>} - Success response
+     * @summary: Search Application
+     * @description: Provide application name or domain url
+     */
+    searchApplication({ authorization, query }?: {
+        authorization?: string;
+        query?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.locationType] - Provide location type to query on.
+     *   Possible values : country, state, city
+     * @param {string} [arg.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.
+     * @returns {Promise<Locations>} - Success response
+     * @summary: Get countries, states, cities
+     * @description:
+     */
+    getLocations({ locationType, id }?: {
+        locationType?: string;
+        id?: string;
+    }): Promise<any>;
+}

package/sdk/application/client/CommonApplicationClient.js

@@ -0,0 +1,105 @@
+const APIClient = require("../ApplicationAPIClient");
+const Paginator = require("../../common/Paginator");
+const constructUrl = require("../constructUrl");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const CommonValidator = require("../models/CommonValidator");
+
+class Common {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      searchApplication:
+        "/service/common/configuration/v1.0/application/search-application",
+      getLocations: "/service/common/configuration/v1.0/location",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.authorization] -
+   * @param {string} [arg.query] - Provide application name
+   * @returns {Promise<ApplicationResponse>} - Success response
+   * @summary: Search Application
+   * @description: Provide application name or domain url
+   */
+  searchApplication({ authorization, query } = {}) {
+    const { error } = CommonValidator.searchApplication().validate(
+      { authorization, query },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["query"] = query;
+
+    const xHeaders = {};
+    xHeaders["authorization"] = authorization;
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["searchApplication"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.locationType] - Provide location type to query on.
+   *   Possible values : country, state, city
+   * @param {string} [arg.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.
+   * @returns {Promise<Locations>} - Success response
+   * @summary: Get countries, states, cities
+   * @description:
+   */
+  getLocations({ locationType, id } = {}) {
+    const { error } = CommonValidator.getLocations().validate(
+      { locationType, id },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["location_type"] = locationType;
+    query_params["id"] = id;
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getLocations"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Common;

package/sdk/application/client/CommunicationApplicationClient.d.ts

@@ -0,0 +1,39 @@
+export = Communication;
+declare class Communication {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getCommunicationConsent: string;
+        upsertCommunicationConsent: string;
+        upsertAppPushtoken: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<CommunicationConsent>} - Success response
+     * @summary: Get communication consent
+     * @description: Use this API to retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
+     */
+    getCommunicationConsent({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CommunicationConsentReq} arg.body
+     * @returns {Promise<CommunicationConsentRes>} - Success response
+     * @summary: Upsert communication consent
+     * @description: Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
+     */
+    upsertCommunicationConsent({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PushtokenReq} arg.body
+     * @returns {Promise<PushtokenRes>} - Success response
+     * @summary: Upsert push token of a user
+     * @description: Use this API to update and insert the push token of the user.
+     */
+    upsertAppPushtoken({ body }?: {
+        body: any;
+    }): Promise<any>;
+}

package/sdk/application/client/CommunicationApplicationClient.js

@@ -0,0 +1,131 @@
+const APIClient = require("../ApplicationAPIClient");
+const Paginator = require("../../common/Paginator");
+const constructUrl = require("../constructUrl");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const CommunicationValidator = require("../models/CommunicationValidator");
+
+class Communication {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getCommunicationConsent:
+        "/service/application/communication/v1.0/consent",
+      upsertCommunicationConsent:
+        "/service/application/communication/v1.0/consent",
+      upsertAppPushtoken: "/service/application/communication/v1.0/pn-token",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @returns {Promise<CommunicationConsent>} - Success response
+   * @summary: Get communication consent
+   * @description: Use this API to retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
+   */
+  getCommunicationConsent({} = {}) {
+    const { error } = CommunicationValidator.getCommunicationConsent().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getCommunicationConsent"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {CommunicationConsentReq} arg.body
+   * @returns {Promise<CommunicationConsentRes>} - Success response
+   * @summary: Upsert communication consent
+   * @description: Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
+   */
+  upsertCommunicationConsent({ body } = {}) {
+    const {
+      error,
+    } = CommunicationValidator.upsertCommunicationConsent().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["upsertCommunicationConsent"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {PushtokenReq} arg.body
+   * @returns {Promise<PushtokenRes>} - Success response
+   * @summary: Upsert push token of a user
+   * @description: Use this API to update and insert the push token of the user.
+   */
+  upsertAppPushtoken({ body } = {}) {
+    const { error } = CommunicationValidator.upsertAppPushtoken().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["upsertAppPushtoken"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Communication;

package/sdk/application/client/ConfigurationApplicationClient.d.ts

@@ -0,0 +1,210 @@
+export = Configuration;
+declare class Configuration {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getApplication: string;
+        getOwnerInfo: string;
+        getBasicDetails: string;
+        getIntegrationTokens: string;
+        getOrderingStores: string;
+        getStoreDetailById: string;
+        getFeatures: string;
+        getContactInfo: string;
+        getCurrencies: string;
+        getCurrencyById: string;
+        getAppCurrencies: string;
+        getLanguages: string;
+        getOrderingStoreCookie: string;
+        removeOrderingStoreCookie: string;
+        getAppStaffList: string;
+        getAppStaffs: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<Application>} - Success response
+     * @summary: Get current application details
+     * @description: Use this API to get the current application details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc.
+     */
+    getApplication({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<ApplicationAboutResponse>} - Success response
+     * @summary: Get application, owner and seller information
+     * @description: Use this API to get the current application details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number.
+     */
+    getOwnerInfo({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<ApplicationDetail>} - Success response
+     * @summary: Get basic application details
+     * @description: Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc.
+     */
+    getBasicDetails({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<AppTokenResponse>} - Success response
+     * @summary: Get integration tokens
+     * @description: Use this API to retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. **Note** - Token values are encrypted with AES encryption using a secret key. Kindly reach out to the developers for obtaining the secret key.
+     */
+    getIntegrationTokens({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results. Default value is 1.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 10.
+     * @param {string} [arg.q] - Store code or name of the ordering store.
+     * @returns {Promise<OrderingStores>} - Success response
+     * @summary: Get deployment stores
+     * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
+     */
+    getOrderingStores({ pageNo, pageSize, q }?: {
+        pageNo?: number;
+        pageSize?: number;
+        q?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 10.
+     * @param {string} [arg.q] - Store code or name of the ordering store.
+     * @summary: Get deployment stores
+     * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
+     */
+    getOrderingStoresPaginator({ pageSize, q }?: {
+        pageSize?: number;
+        q?: string;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.storeId - Store uid
+     * @returns {Promise<OrderingStore>} - Success response
+     * @summary: Get ordering store details
+     * @description: Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders).
+     */
+    getStoreDetailById({ storeId }?: {
+        storeId: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<AppFeatureResponse>} - Success response
+     * @summary: Get features of application
+     * @description: Use this API to retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more.
+     */
+    getFeatures({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<ApplicationInformation>} - Success response
+     * @summary: Get application information
+     * @description: Use this API to retrieve information about the social links, address and contact information of the company/seller/brand operating the application.
+     */
+    getContactInfo({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<CurrenciesResponse>} - Success response
+     * @summary: Get all currencies list
+     * @description: Use this API to get a list of currencies available. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
+     */
+    getCurrencies({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Object ID assigned to the currency
+     * @returns {Promise<Currency>} - Success response
+     * @summary: Get currency by its ID
+     * @description: Use this API to retrieve a currency using its ID.
+     */
+    getCurrencyById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<AppCurrencyResponse>} - Success response
+     * @summary: Get currencies enabled in the application
+     * @description: Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
+     */
+    getAppCurrencies({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<LanguageResponse>} - Success response
+     * @summary: Get list of languages
+     * @description: Use this API to get a list of languages supported in the application.
+     */
+    getLanguages({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {OrderingStoreSelectRequest} arg.body
+     * @returns {Promise<SuccessMessageResponse>} - Success response
+     * @summary: Get an Ordering Store signed cookie on selection of ordering store.
+     * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart.
+     */
+    getOrderingStoreCookie({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<SuccessMessageResponse>} - Success response
+     * @summary: Unset the Ordering Store signed cookie.
+     * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
+     */
+    removeOrderingStoreCookie({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] -
+     * @param {number} [arg.pageSize] -
+     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
+     *   `true` to retrieve the staff members eligible for getting incentives on orders.
+     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
+     *   retrieving staff members working at a particular ordering store.
+     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
+     *   the details of a particular staff member.
+     * @returns {Promise<AppStaffListResponse>} - Success response
+     * @summary: Get a list of staff.
+     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
+     */
+    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user }?: {
+        pageNo?: number;
+        pageSize?: number;
+        orderIncent?: boolean;
+        orderingStore?: number;
+        user?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] -
+     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
+     *   `true` to retrieve the staff members eligible for getting incentives on orders.
+     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
+     *   retrieving staff members working at a particular ordering store.
+     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
+     *   the details of a particular staff member.
+     * @summary: Get a list of staff.
+     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
+     */
+    getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, }?: {
+        pageSize?: number;
+        orderIncent?: boolean;
+        orderingStore?: number;
+        user?: string;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
+     *   `true` to retrieve the staff members eligible for getting incentives on orders.
+     * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
+     *   retrieving staff members working at a particular ordering store.
+     * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
+     *   the details of a particular staff member.
+     * @returns {Promise<AppStaffResponse>} - Success response
+     * @summary: Get a list of staff.
+     * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
+     */
+    getAppStaffs({ orderIncent, orderingStore, user }?: {
+        orderIncent?: boolean;
+        orderingStore?: number;
+        user?: string;
+    }): Promise<any>;
+}
+import Paginator = require("../../common/Paginator");