@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

package/sdk/application/Configuration/ConfigurationApplicationClient.js

@@ -25,10 +25,10 @@ class Configuration {
       getOrderingStoreCookie:
         "/service/application/configuration/v1.0/ordering-store/select",
       getOrderingStores:
-        "/service/application/configuration/v1.0/ordering-store/stores",
-      getOwnerInfo: "/service/application/configuration/v1.0/about",
+        "/service/application/configuration/v2.0/ordering-store/stores",
+      getOwnerInfo: "/service/application/configuration/v2.0/about",
       getStoreDetailById:
-        "/service/application/configuration/v1.0/ordering-store/stores/{store_id}",
+        "/service/application/configuration/v2.0/ordering-store/stores/{store_id}",
       removeOrderingStoreCookie:
         "/service/application/configuration/v1.0/ordering-store/select",
     };
@@ -51,9 +51,9 @@ class Configuration {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<AppCurrencyResponseSchema>} - Success response
+   * @returns {Promise<AppCurrencyResponse>} - Success response
    * @name getAppCurrencies
-   * @summary: Get currency configuration
+   * @summary: Retrieves app-specific currencies.
    * @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
    */
   async getAppCurrencies(
@@ -96,9 +96,9 @@ class Configuration {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<AppStaffListResponseSchema>} - Success response
+   * @returns {Promise<AppStaffListResponse>} - Success response
    * @name getAppStaffList
-   * @summary: List staff members
+   * @summary: Lists app staff members.
    * @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
    */
   async getAppStaffList(
@@ -152,12 +152,56 @@ class Configuration {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+   * @param {boolean} [arg.orderIncent] - 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] - ID of the staff. Helps in retrieving the
+   *   details of a particular staff member.
+   * @param {string} [arg.userName] - Username of the member.
+   * @returns {Paginator<AppStaffListResponse>}
+   * @summary: Lists app staff members.
+   * @description: List all staff members of the sales channel.
+   */
+  getAppStaffListPaginator({
+    pageSize,
+    orderIncent,
+    orderingStore,
+    user,
+    userName,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getAppStaffList({
+        pageNo: pageNo,
+        pageSize: pageSize,
+        orderIncent: orderIncent,
+        orderingStore: orderingStore,
+        user: user,
+        userName: userName,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<AppStaffResponseSchema>} - Success response
+   * @returns {Promise<AppStaffResponse>} - Success response
    * @name getAppStaffs
-   * @summary: Get staff member
+   * @summary: Fetches detailed staff info.
    * @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
    */
   async getAppStaffs(
@@ -207,7 +251,7 @@ class Configuration {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<Application>} - Success response
    * @name getApplication
-   * @summary: Get sales channel
+   * @summary: Fetches application details.
    * @description: Get details of the current sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
    */
   async getApplication(
@@ -252,7 +296,7 @@ class Configuration {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ApplicationDetail>} - Success response
    * @name getBasicDetails
-   * @summary: Get Sales channel
+   * @summary: Retrieves basic app info.
    * @description: Get basic details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
    */
   async getBasicDetails(
@@ -297,7 +341,7 @@ class Configuration {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ApplicationInformation>} - Success response
    * @name getContactInfo
-   * @summary: Get sales channel contact
+   * @summary: Retrieves contact details.
    * @description: Get contact details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
    */
   async getContactInfo(
@@ -340,9 +384,9 @@ class Configuration {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CurrenciesResponseSchema>} - Success response
+   * @returns {Promise<CurrenciesResponse>} - Success response
    * @name getCurrencies
-   * @summary: List currencies
+   * @summary: Lists supported currencies.
    * @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
    */
   async getCurrencies(
@@ -387,7 +431,7 @@ class Configuration {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<Currency>} - Success response
    * @name getCurrencyById
-   * @summary: Get a currency
+   * @summary: Fetches currency by ID.
    * @description: Get details of the currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
    */
   async getCurrencyById(
@@ -437,9 +481,9 @@ class Configuration {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<AppFeatureResponseSchema>} - Success response
+   * @returns {Promise<AppFeatureResponse>} - Success response
    * @name getFeatures
-   * @summary: Get sales channel features
+   * @summary: Fetches app features.
    * @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
    */
   async getFeatures(
@@ -482,9 +526,9 @@ class Configuration {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<AppTokenResponseSchema>} - Success response
+   * @returns {Promise<AppTokenResponse>} - Success response
    * @name getIntegrationTokens
-   * @summary: Get API tokens
+   * @summary: Fetches API tokens.
    * @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
    */
   async getIntegrationTokens(
@@ -527,9 +571,9 @@ class Configuration {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<LanguageResponseSchema>} - Success response
+   * @returns {Promise<LanguageResponse>} - Success response
    * @name getLanguages
-   * @summary: List languages
+   * @summary: Lists available languages.
    * @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
    */
   async getLanguages(
@@ -572,9 +616,9 @@ class Configuration {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<SuccessMessageResponseSchema>} - Success response
+   * @returns {Promise<SuccessMessageResponse>} - Success response
    * @name getOrderingStoreCookie
-   * @summary: Create cookies
+   * @summary: Retrieves store selection cookie.
    * @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
    */
   async getOrderingStoreCookie(
@@ -619,7 +663,7 @@ class Configuration {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderingStores>} - Success response
    * @name getOrderingStores
-   * @summary: List order-enabled selling locations
+   * @summary: Get all deployment stores
    * @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
    */
   async getOrderingStores(
@@ -662,12 +706,42 @@ class Configuration {
     return response;
   }
 
+  /**
+   * @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.
+   * @returns {Paginator<OrderingStores>}
+   * @summary: Get all deployment stores
+   * @description: Get details of all the deployment store locations where the sales channel will be used for order placement.
+   */
+  getOrderingStoresPaginator({ pageSize, q } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getOrderingStores({
+        pageNo: pageNo,
+        pageSize: pageSize,
+        q: q,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ApplicationAboutResponseSchema>} - Success response
+   * @returns {Promise<ApplicationAboutResponse>} - Success response
    * @name getOwnerInfo
-   * @summary: Get sales channel owner
+   * @summary: Get sales channel, owner and seller information
    * @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
    */
   async getOwnerInfo(
@@ -712,7 +786,7 @@ class Configuration {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<OrderingStore>} - Success response
    * @name getStoreDetailById
-   * @summary: Get a selling location
+   * @summary: Get ordering store details
    * @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
    */
   async getStoreDetailById(
@@ -762,9 +836,9 @@ class Configuration {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<SuccessMessageResponseSchema>} - Success response
+   * @returns {Promise<SuccessMessageResponse>} - Success response
    * @name removeOrderingStoreCookie
-   * @summary: Delete store cookie
+   * @summary: Deletes store cookie.
    * @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
    */
   async removeOrderingStoreCookie(

package/sdk/application/Content/ContentApplicationClient.d.ts

@@ -6,8 +6,11 @@ declare class Content {
         getAnnouncements: string;
         getBlog: string;
         getBlogs: string;
-        getCustomFieldsByResourceId: string;
-        getCustomObjectBySlug: string;
+        getCustomFieldDefinition: string;
+        getCustomFieldDefinitions: string;
+        getCustomFields: string;
+        getCustomObject: string;
+        getCustomObjects: string;
         getDataLoaders: string;
         getFaqBySlug: string;
         getFaqCategories: string;
@@ -23,6 +26,7 @@ declare class Content {
         getSEOMarkupSchemas: string;
         getSupportInformation: string;
         getTags: string;
+        getWellKnownUrl: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
@@ -43,34 +47,61 @@ declare class Content {
      * @summary: Get a blog
      * @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
      */
-    getBlog({ slug, rootId, preview, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogSchema>;
+    getBlog({ slug, rootId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<BlogGetDetails>} - Success response
+     * @returns {Promise<BlogGetResponse>} - Success response
      * @name getBlogs
      * @summary: List blogs
      * @description: List all the blogs against an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
      */
-    getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogGetDetails>;
+    getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogGetResponse>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<CustomFieldDefinitionDetailResSchema>} - Success response
+     * @name getCustomFieldDefinition
+     * @summary: Get custom fields definition by id
+     * @description: Use this API to retrieve the definitions of custom fields using definition_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFieldDefinition/).
+     */
+    getCustomFieldDefinition({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomFieldDefinitionDetailResSchema>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<CustomFieldDefinitionsSchema>} - Success response
+     * @name getCustomFieldDefinitions
+     * @summary: Get custom fields definitions
+     * @description: Use this API to retrieve the definitions of custom fields. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFieldDefinitions/).
+     */
+    getCustomFieldDefinitions({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomFieldDefinitionsSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
-     * @name getCustomFieldsByResourceId
-     * @summary: Get list of custom fields of given resource and resource slug
-     * @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFieldsByResourceId/).
+     * @name getCustomFields
+     * @summary: Get list of custom fields of given resource
+     * @description: Use this API to retrieve the custom fields for given resource and resource_ids in param - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
      */
-    getCustomFieldsByResourceId({ resource, resourceSlug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomFieldsResponseByResourceIdSchema>;
+    getCustomFields({ resource, resourceIds, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomFieldsResponseByResourceIdSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<CustomObjectByIdSchema>} - Success response
-     * @name getCustomObjectBySlug
-     * @summary: Get custom object details
-     * @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObjectBySlug/).
+     * @name getCustomObject
+     * @summary: Get custom object
+     * @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
      */
-    getCustomObjectBySlug({ definitionSlug, slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomObjectByIdSchema>;
+    getCustomObject({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomObjectByIdSchema>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<CustomObjectsSchema>} - Success response
+     * @name getCustomObjects
+     * @summary: Get list of custom objects
+     * @description: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObjects/).
+     */
+    getCustomObjects({ pageNo, pageSize, definitionId, type, ids, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomObjectsSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -131,7 +162,7 @@ declare class Content {
      * @returns {Promise<LandingPageSchema>} - Success response
      * @name getLandingPage
      * @summary: Get a landing page
-     * @description: Get content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
+     * @description: Gets the content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
      */
     getLandingPage({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LandingPageSchema>;
     /**
@@ -146,30 +177,30 @@ declare class Content {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<NavigationGetDetails>} - Success response
+     * @returns {Promise<NavigationGetResponse>} - Success response
      * @name getNavigations
      * @summary: List navigation items
      * @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
      */
-    getNavigations({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<NavigationGetDetails>;
+    getNavigations({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<NavigationGetResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<PageSchema>} - Success response
      * @name getPage
-     * @summary: Get a page
-     * @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
+     * @summary: Get page by slug
+     * @description: Get detailed information about a specific page using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
      */
     getPage({ slug, rootId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PageSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<PageGetDetails>} - Success response
+     * @returns {Promise<PageGetResponse>} - Success response
      * @name getPages
      * @summary: Lists pages
-     * @description: Lists all Custom Pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
+     * @description: Lists all Custom Pages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
      */
-    getPages({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PageGetDetails>;
+    getPages({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PageGetResponse>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -206,4 +237,13 @@ declare class Content {
      * @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getTags/).
      */
     getTags({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TagsSchema>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<WellKnownResponse>} - Success response
+     * @name getWellKnownUrl
+     * @summary: Get a specific well-known URL
+     * @description: Retrieves the details of a specific well-known URL by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getWellKnownUrl/).
+     */
+    getWellKnownUrl({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<WellKnownResponse>;
 }