@gofynd/fdk-client-javascript 0.1.35

package/sdk/platform/client/CommonPlatformClient.d.ts

@@ -0,0 +1,30 @@
+export = Common;
+declare class Common {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.authorization] -
+     * @param {string} [arg.query] - Provide application name
+     * @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.
+     * @summary: Get countries, states, cities
+     * @description:
+     */
+    getLocations({ locationType, id }?: {
+        locationType?: string;
+        id?: string;
+    }): Promise<any>;
+}

package/sdk/platform/client/CommonPlatformClient.js

@@ -0,0 +1,84 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const CommonValidator = require("../models/CommonValidator");
+class Common {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.authorization] -
+   * @param {string} [arg.query] - Provide application name
+   * @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 PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/common/configuration/v1.0/application/search-application`,
+      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.
+   * @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 PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/common/configuration/v1.0/location`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Common;

package/sdk/platform/client/CommunicationPlatformClient.d.ts

@@ -0,0 +1,26 @@
+export = Communication;
+declare class Communication {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] -
+     * @param {number} [arg.pageSize] -
+     * @summary: Get system notifications
+     * @description: Get system notifications
+     */
+    getSystemNotifications({ pageNo, pageSize }?: {
+        pageNo?: number;
+        pageSize?: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] -
+     * @summary: Get system notifications
+     * @description: Get system notifications
+     */
+    getSystemNotificationsPaginator({ pageSize }?: {
+        pageSize?: number;
+    }): Paginator;
+}
+import Paginator = require("../../common/Paginator");

package/sdk/platform/client/CommunicationPlatformClient.js

@@ -0,0 +1,72 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const CommunicationValidator = require("../models/CommunicationValidator");
+class Communication {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] -
+   * @param {number} [arg.pageSize] -
+   * @summary: Get system notifications
+   * @description: Get system notifications
+   */
+  getSystemNotifications({ pageNo, pageSize } = {}) {
+    const { error } = CommunicationValidator.getSystemNotifications().validate(
+      {
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+
+    const xHeaders = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/communication/v1.0/company/${this.config.companyId}/notification/system-notifications/`,
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageSize] -
+   * @summary: Get system notifications
+   * @description: Get system notifications
+   */
+  getSystemNotificationsPaginator({ pageSize } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getSystemNotifications({
+        pageNo: pageNo,
+        pageSize: pageSize,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback);
+    return paginator;
+  }
+}
+
+module.exports = Communication;

package/sdk/platform/client/CompanyProfilePlatformClient.d.ts

@@ -0,0 +1,182 @@
+export = CompanyProfile;
+declare class CompanyProfile {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get company profile
+     * @description: This API allows to view the company profile of the seller account.
+     */
+    cbsOnboardGet({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {UpdateCompany} arg.body
+     * @summary: Edit company profile
+     * @description: This API allows to edit the company profile of the seller account.
+     */
+    updateCompany({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get company metrics
+     * @description: This API allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified.
+     */
+    getCompanyMetrics({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.brandId - Id of the brand to be viewed.
+     * @summary: Get a single brand.
+     * @description: This API helps to get data associated to a particular brand.
+     */
+    getBrand({ brandId }?: {
+        brandId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.brandId - Id of the brand to be viewed.
+     * @param {CreateUpdateBrandRequestSerializer} arg.body
+     * @summary: Edit a brand.
+     * @description: This API allows to edit meta of a brand.
+     */
+    editBrand({ brandId, body }?: {
+        brandId: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CreateUpdateBrandRequestSerializer} arg.body
+     * @summary: Create a Brand.
+     * @description: This API allows to create a brand associated to a company.
+     */
+    createBrand({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results
+     * @param {number} [arg.pageSize] - Number of items to retrieve in each
+     *   page. Default is 10.
+     * @param {string} [arg.q] - Search term for name.
+     * @summary: Get brands associated to a company
+     * @description: This API helps to get view brands associated to a particular company.
+     */
+    getBrands({ pageNo, pageSize, q }?: {
+        pageNo?: number;
+        pageSize?: number;
+        q?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - Number of items to retrieve in each
+     *   page. Default is 10.
+     * @param {string} [arg.q] - Search term for name.
+     * @summary: Get brands associated to a company
+     * @description: This API helps to get view brands associated to a particular company.
+     */
+    getBrandsPaginator({ pageSize, q }?: {
+        pageSize?: number;
+        q?: string;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CompanyBrandPostRequestSerializer} arg.body
+     * @summary: Create a company brand mapping.
+     * @description: This API allows to create a company brand mapping, for a already existing brand in the system.
+     */
+    createCompanyBrandMapping({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.storeType] - Helps to sort the location list on the
+     *   basis of location type.
+     * @param {string} [arg.q] - Query that is to be searched.
+     * @param {string} [arg.stage] - To filter companies on basis of verified or
+     *   unverified companies.
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results
+     * @param {number} [arg.pageSize] - Number of items to retrieve in each
+     *   page. Default is 10.
+     * @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
+     * @summary: Get list of locations
+     * @description: This API allows to view all the locations associated to a company.
+     */
+    getLocations({ storeType, q, stage, pageNo, pageSize, locationIds }?: {
+        storeType?: string;
+        q?: string;
+        stage?: string;
+        pageNo?: number;
+        pageSize?: number;
+        locationIds?: number[];
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.storeType] - Helps to sort the location list on the
+     *   basis of location type.
+     * @param {string} [arg.q] - Query that is to be searched.
+     * @param {string} [arg.stage] - To filter companies on basis of verified or
+     *   unverified companies.
+     * @param {number} [arg.pageSize] - Number of items to retrieve in each
+     *   page. Default is 10.
+     * @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
+     * @summary: Get list of locations
+     * @description: This API allows to view all the locations associated to a company.
+     */
+    getLocationsPaginator({ storeType, q, stage, pageSize, locationIds }?: {
+        storeType?: string;
+        q?: string;
+        stage?: string;
+        pageSize?: number;
+        locationIds?: number[];
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {LocationSerializer} arg.body
+     * @summary: Create a location associated to a company.
+     * @description: This API allows to edit a location associated to a company.
+     */
+    createLocation({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.locationId - Id of the location which you want to view.
+     * @summary: Get details of a specific location.
+     * @description: This API helps to get data associated to a specific location.
+     */
+    getLocationDetail({ locationId }?: {
+        locationId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.locationId - Id of the location which you want to edit.
+     * @param {LocationSerializer} arg.body
+     * @summary: Edit a location asscoiated to a company.
+     * @description: This API allows to edit a location associated to a company.
+     */
+    updateLocation({ locationId, body }?: {
+        locationId: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {BulkLocationSerializer} arg.body
+     * @summary: Create a location asscoiated to a company in bulk.
+     * @description: This API allows to create a location associated to a company.
+     */
+    createLocationBulk({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AssignStoreRequestValidator} arg.body
+     * @summary: Location Reassignment
+     * @description:
+     */
+    getOptimalLocations({ body }?: {
+        body: any;
+    }): Promise<any>;
+}
+import Paginator = require("../../common/Paginator");