@gofynd/fdk-client-javascript 1.4.12 → 1.4.14

package/sdk/application/Content/ContentApplicationClient.js

@@ -16,11 +16,11 @@ class Content {
     this._relativeUrls = {
       getAnnouncements: "/service/application/content/v1.0/announcements",
       getBlog: "/service/application/content/v1.0/blogs/{slug}",
-      getBlogs: "/service/application/content/v1.0/blogs/",
-      getCustomFields:
-        "/service/application/content/v1.0/metafields/{resource}/{resource_id}",
-      getCustomObject:
-        "/service/application/content/v1.0/metaobjects/{metaobject_id}",
+      getBlogs: "/service/application/content/v1.0/blogs",
+      getCustomFieldsByResourceId:
+        "/service/application/content/v2.0/customfields/resource/{resource}/{resource_slug}",
+      getCustomObjectBySlug:
+        "/service/application/content/v2.0/customobjects/definition/{definition_slug}/entries/{slug}",
       getDataLoaders: "/service/application/content/v1.0/data-loader",
       getFaqBySlug: "/service/application/content/v1.0/faq/{slug}",
       getFaqCategories: "/service/application/content/v1.0/faq/categories",
@@ -31,13 +31,13 @@ class Content {
         "/service/application/content/v1.0/faq/category/{slug}/faqs",
       getLandingPage: "/service/application/content/v1.0/landing-page",
       getLegalInformation: "/service/application/content/v1.0/legal",
-      getNavigations: "/service/application/content/v1.0/navigations/",
+      getNavigations: "/service/application/content/v1.0/navigations",
       getPage: "/service/application/content/v2.0/pages/{slug}",
-      getPages: "/service/application/content/v2.0/pages/",
+      getPages: "/service/application/content/v2.0/pages",
       getSEOConfiguration: "/service/application/content/v1.0/seo",
       getSEOMarkupSchemas: "/service/application/content/v1.0/seo/schema",
       getSlideshow: "/service/application/content/v1.0/slideshow/{slug}",
-      getSlideshows: "/service/application/content/v1.0/slideshow/",
+      getSlideshows: "/service/application/content/v1.0/slideshow",
       getSupportInformation: "/service/application/content/v1.0/support",
       getTags: "/service/application/content/v1.0/tags",
     };
@@ -147,11 +147,11 @@ class Content {
    * @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/).
    */
   async getBlog(
-    { slug, rootId, requestHeaders } = { requestHeaders: {} },
+    { slug, rootId, preview, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = ContentApplicationValidator.getBlog().validate(
-      { slug, rootId },
+      { slug, rootId, preview },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -160,7 +160,7 @@ class Content {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = ContentApplicationValidator.getBlog().validate(
-      { slug, rootId },
+      { slug, rootId, preview },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -172,6 +172,7 @@ class Content {
 
     const query_params = {};
     query_params["root_id"] = rootId;
+    query_params["preview"] = preview;
 
     const xHeaders = {};
 
@@ -218,7 +219,7 @@ class Content {
    * @param {ContentApplicationValidator.GetBlogsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
+   * @returns {Promise<ContentApplicationModel.BlogGetDetails>} - 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/).
@@ -275,7 +276,7 @@ class Content {
 
     const {
       error: res_error,
-    } = ContentApplicationModel.BlogGetResponse().validate(responseData, {
+    } = ContentApplicationModel.BlogGetDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -295,22 +296,26 @@ class Content {
   }
 
   /**
-   * @param {ContentApplicationValidator.GetCustomFieldsParam} arg - Arg object.
+   * @param {ContentApplicationValidator.GetCustomFieldsByResourceIdParam} arg
+   *   - Arg object.
+   *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ContentApplicationModel.CustomFieldsResponseByResourceIdSchema>}
    *   - Success response
    *
-   * @name getCustomFields
-   * @summary: Get list of custom fields
-   * @description: List custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
+   * @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/).
    */
-  async getCustomFields(
-    { resource, resourceId, requestHeaders } = { requestHeaders: {} },
+  async getCustomFieldsByResourceId(
+    { resource, resourceSlug, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const { error } = ContentApplicationValidator.getCustomFields().validate(
-      { resource, resourceId },
+    const {
+      error,
+    } = ContentApplicationValidator.getCustomFieldsByResourceId().validate(
+      { resource, resourceSlug },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -320,14 +325,14 @@ class Content {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = ContentApplicationValidator.getCustomFields().validate(
-      { resource, resourceId },
+    } = ContentApplicationValidator.getCustomFieldsByResourceId().validate(
+      { resource, resourceSlug },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for application > Content > getCustomFields \n ${warrning}`,
+        message: `Parameter Validation warrnings for application > Content > getCustomFieldsByResourceId \n ${warrning}`,
       });
     }
 
@@ -339,8 +344,8 @@ class Content {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getCustomFields"],
-        params: { resource, resourceId },
+        url: this._urls["getCustomFieldsByResourceId"],
+        params: { resource, resourceSlug },
       }),
       query_params,
       undefined,
@@ -366,7 +371,7 @@ class Content {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for application > Content > getCustomFields \n ${res_error}`,
+          message: `Response Validation Warnings for application > Content > getCustomFieldsByResourceId \n ${res_error}`,
         });
       }
     }
@@ -375,21 +380,23 @@ class Content {
   }
 
   /**
-   * @param {ContentApplicationValidator.GetCustomObjectParam} arg - Arg object.
+   * @param {ContentApplicationValidator.GetCustomObjectBySlugParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<ContentApplicationModel.CustomObjectByIdSchema>} -
    *   Success response
-   * @name getCustomObject
-   * @summary: Get custom object
-   * @description: Get 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/).
+   * @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/).
    */
-  async getCustomObject(
-    { metaobjectId, requestHeaders } = { requestHeaders: {} },
+  async getCustomObjectBySlug(
+    { definitionSlug, slug, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const { error } = ContentApplicationValidator.getCustomObject().validate(
-      { metaobjectId },
+    const {
+      error,
+    } = ContentApplicationValidator.getCustomObjectBySlug().validate(
+      { definitionSlug, slug },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -399,14 +406,14 @@ class Content {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = ContentApplicationValidator.getCustomObject().validate(
-      { metaobjectId },
+    } = ContentApplicationValidator.getCustomObjectBySlug().validate(
+      { definitionSlug, slug },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for application > Content > getCustomObject \n ${warrning}`,
+        message: `Parameter Validation warrnings for application > Content > getCustomObjectBySlug \n ${warrning}`,
       });
     }
 
@@ -418,8 +425,8 @@ class Content {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getCustomObject"],
-        params: { metaobjectId },
+        url: this._urls["getCustomObjectBySlug"],
+        params: { definitionSlug, slug },
       }),
       query_params,
       undefined,
@@ -445,7 +452,7 @@ class Content {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for application > Content > getCustomObject \n ${res_error}`,
+          message: `Response Validation Warnings for application > Content > getCustomObjectBySlug \n ${res_error}`,
         });
       }
     }
@@ -1087,8 +1094,7 @@ class Content {
    * @param {ContentApplicationValidator.GetNavigationsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ContentApplicationModel.NavigationGetResponse>} -
-   *   Success response
+   * @returns {Promise<ContentApplicationModel.NavigationGetDetails>} - 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/).
@@ -1145,7 +1151,7 @@ class Content {
 
     const {
       error: res_error,
-    } = ContentApplicationModel.NavigationGetResponse().validate(responseData, {
+    } = ContentApplicationModel.NavigationGetDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1245,7 +1251,7 @@ class Content {
    * @param {ContentApplicationValidator.GetPagesParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
+   * @returns {Promise<ContentApplicationModel.PageGetDetails>} - 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/).
@@ -1300,7 +1306,7 @@ class Content {
 
     const {
       error: res_error,
-    } = ContentApplicationModel.PageGetResponse().validate(responseData, {
+    } = ContentApplicationModel.PageGetDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1563,7 +1569,7 @@ class Content {
    * @param {ContentApplicationValidator.GetSlideshowsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ContentApplicationModel.SlideshowGetResponse>} - Success response
+   * @returns {Promise<ContentApplicationModel.SlideshowGetDetails>} - Success response
    * @name getSlideshows
    * @summary: List Slideshows
    * @description: List slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
@@ -1620,7 +1626,7 @@ class Content {
 
     const {
       error: res_error,
-    } = ContentApplicationModel.SlideshowGetResponse().validate(responseData, {
+    } = ContentApplicationModel.SlideshowGetDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1639,33 +1645,6 @@ class Content {
     return response;
   }
 
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-   * @returns {Paginator<ContentApplicationModel.SlideshowGetResponse>}
-   * @summary: List Slideshows
-   * @description: List slideshows along with their details.
-   */
-  getSlideshowsPaginator({ pageSize } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "number";
-      const data = await this.getSlideshows({
-        pageNo: pageNo,
-        pageSize: pageSize,
-      });
-      paginator.setPaginator({
-        hasNext: data.page.has_next ? true : false,
-        nextId: data.page.next_id,
-      });
-      return data;
-    };
-    paginator.setCallback(callback.bind(this));
-    return paginator;
-  }
-
   /**
    * @param {ContentApplicationValidator.GetSupportInformationParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

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

@@ -22,6 +22,11 @@ export = ContentApplicationModel;
  * @typedef SeoComponent
  * @property {SeoSchema} [seo]
  */
+/**
+ * @typedef ValidationError
+ * @property {string} message - A brief description of the error encountered.
+ * @property {string} field - The field in the request that caused the error.
+ */
 /**
  * @typedef SeoSchema
  * @property {string} [app] - Application ID - Identifier for a Sales channel.
@@ -98,7 +103,7 @@ export = ContentApplicationModel;
  * @property {string} [end] - End time of schedule.
  */
 /**
- * @typedef BlogGetResponse
+ * @typedef BlogGetDetails
  * @property {BlogSchema[]} [items] - List of blogs with details.
  * @property {Page} [page]
  * @property {BlogFilters} [filters]
@@ -366,7 +371,7 @@ export = ContentApplicationModel;
  * @property {Object} [_custom_json] - Custom JSON object for specific use cases.
  */
 /**
- * @typedef NavigationGetResponse
+ * @typedef NavigationGetDetails
  * @property {NavigationSchema[]} [items] - List of navigation items.
  * @property {Page} [page]
  */
@@ -395,7 +400,7 @@ export = ContentApplicationModel;
  *   links and relevant details.
  */
 /**
- * @typedef PageGetResponse
+ * @typedef PageGetDetails
  * @property {PageSchema[]} [items] - List of details of custom pages.
  * @property {Page} [page]
  */
@@ -433,7 +438,7 @@ export = ContentApplicationModel;
  * @property {string} [id] - Details containing the creator of custom page.
  */
 /**
- * @typedef SlideshowGetResponse
+ * @typedef SlideshowGetDetails
  * @property {SlideshowSchema[]} [items] - Details related to slideshow/screensaver.
  * @property {Page} [page]
  */
@@ -525,7 +530,7 @@ export = ContentApplicationModel;
 /**
  * @typedef CustomObjectFieldSchema
  * @property {string} [_id] - Unique identifier of an entry.
- * @property {string} [key] - Key of custom field inside custom object.
+ * @property {string} [slug] - Slug of custom field inside custom object.
  * @property {CustomObjectFieldValue[]} [value] - Value of custom field inside
  *   custom object.
  * @property {string} [type] - Data type of custom field inside custom object.
@@ -534,7 +539,7 @@ export = ContentApplicationModel;
  */
 /**
  * @typedef CustomObjectByIdSchema
- * @property {string} [_id] - Unique identifier of an entry.
+ * @property {string} [id] - Unique identifier of an entry.
  * @property {string} [status] - String denoting whether custom object is active
  *   or inactive.
  * @property {string} [display_name] - Unique Display name of a custom object
@@ -553,10 +558,8 @@ export = ContentApplicationModel;
  * @typedef CustomFieldSchema
  * @property {string} [_id] - Unique identifier of an entry.
  * @property {string} [namespace] - Namespace under which custom field is present.
- * @property {string} [key] - Unique identifier for a custom field.
+ * @property {string} [slug] - Unique identifier for a custom field in a given namespace.
  * @property {string} [resource] - Type of an entity under which custom field is defined.
- * @property {string} [creator] - Denotes where the custom field has been
- *   defined - within a company or within a sales channel.
  * @property {CustomFieldValue[]} [value] - Array containing values of custom field.
  * @property {string} [resource_id] - Unique identifier for the entity under
  *   which custom field is defined.
@@ -569,7 +572,6 @@ export = ContentApplicationModel;
  * @property {boolean} [has_invalid_values] - Whether the custom field has invalid values.
  * @property {Object[]} [invalid_value_errors] - Array denoting if there's a
  *   validation failure on a custom field inside a custom object.
- * @property {string} [created_by] - Details of the owner of custom field creator.
  * @property {boolean} [is_deleted] - Whether the custom field definition is deleted.
  * @property {string} [created_at] - Timestamp which represent the time when
  *   data was created.
@@ -580,6 +582,23 @@ export = ContentApplicationModel;
  * @typedef CustomFieldsResponseByResourceIdSchema
  * @property {CustomFieldSchema[]} [items] - List of custom fields against a resource.
  */
+/**
+ * @typedef CustomObjectListItemSchema
+ * @property {string} [_id] - Unique system generated if for a custom object
+ * @property {string} [definition_id] - Unique system generated id for a custom
+ *   object definition
+ * @property {string} [status] - Flag to denote whether custom object is active or not
+ * @property {string} [updated_at] - Updation time of custom object entry
+ * @property {string} [display_name] - A custom field inside custom object used
+ *   to display the entry of custom object in listing
+ * @property {CustomObjectListItemDefinationSchema} [definition]
+ * @property {number} [references]
+ */
+/**
+ * @typedef CustomObjectsSchema
+ * @property {CustomObjectListItemSchema[]} [items]
+ * @property {Page} [page]
+ */
 /**
  * @typedef ActionPage
  * @property {Object} [params] - Parameters that should be considered in path.
@@ -634,12 +653,13 @@ export = ContentApplicationModel;
  *   | "register"
  *   | "shipping-policy"
  *   | "return-policy"
- *   | "order-status"} PageType
+ *   | "order-status"
+ *   | "locate-us"} PageType
  */
 declare class ContentApplicationModel {
 }
 declare namespace ContentApplicationModel {
-    export { ApplicationLegal, ApplicationLegalFAQ, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, AnnouncementSchema, ScheduleStartSchema, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, LocaleLanguage, Language, Action, NavigationReference, ConfigurationSchema, SlideshowMedia, AnnouncementsResponseSchema, FaqResponseSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, FAQCategorySchema, FaqSchema, GetFaqSchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageSchema, NavigationGetResponse, Orientation, NavigationSchema, PageGetResponse, PageSchema, CreatedBySchema, SlideshowGetResponse, SlideshowSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, CustomObjectFieldValue, CustomObjectListItemDefinationSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseByResourceIdSchema, ActionPage, PageType };
+    export { ApplicationLegal, ApplicationLegalFAQ, SeoComponent, ValidationError, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, AnnouncementSchema, ScheduleStartSchema, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, LocaleLanguage, Language, Action, NavigationReference, ConfigurationSchema, SlideshowMedia, AnnouncementsResponseSchema, FaqResponseSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, FAQCategorySchema, FaqSchema, GetFaqSchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageSchema, NavigationGetDetails, Orientation, NavigationSchema, PageGetDetails, PageSchema, CreatedBySchema, SlideshowGetDetails, SlideshowSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, CustomObjectFieldValue, CustomObjectListItemDefinationSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseByResourceIdSchema, CustomObjectListItemSchema, CustomObjectsSchema, ActionPage, PageType };
 }
 /** @returns {ApplicationLegal} */
 declare function ApplicationLegal(): ApplicationLegal;
@@ -700,6 +720,18 @@ declare function SeoComponent(): SeoComponent;
 type SeoComponent = {
     seo?: SeoSchema;
 };
+/** @returns {ValidationError} */
+declare function ValidationError(): ValidationError;
+type ValidationError = {
+    /**
+     * - A brief description of the error encountered.
+     */
+    message: string;
+    /**
+     * - The field in the request that caused the error.
+     */
+    field: string;
+};
 /** @returns {SeoSchema} */
 declare function SeoSchema(): SeoSchema;
 type SeoSchema = {
@@ -889,9 +921,9 @@ type ScheduleStartSchema = {
      */
     end?: string;
 };
-/** @returns {BlogGetResponse} */
-declare function BlogGetResponse(): BlogGetResponse;
-type BlogGetResponse = {
+/** @returns {BlogGetDetails} */
+declare function BlogGetDetails(): BlogGetDetails;
+type BlogGetDetails = {
     /**
      * - List of blogs with details.
      */
@@ -1561,9 +1593,9 @@ type LandingPageSchema = {
      */
     _custom_json?: any;
 };
-/** @returns {NavigationGetResponse} */
-declare function NavigationGetResponse(): NavigationGetResponse;
-type NavigationGetResponse = {
+/** @returns {NavigationGetDetails} */
+declare function NavigationGetDetails(): NavigationGetDetails;
+type NavigationGetDetails = {
     /**
      * - List of navigation items.
      */
@@ -1626,9 +1658,9 @@ type NavigationSchema = {
      */
     navigation?: NavigationReference[];
 };
-/** @returns {PageGetResponse} */
-declare function PageGetResponse(): PageGetResponse;
-type PageGetResponse = {
+/** @returns {PageGetDetails} */
+declare function PageGetDetails(): PageGetDetails;
+type PageGetDetails = {
     /**
      * - List of details of custom pages.
      */
@@ -1724,9 +1756,9 @@ type CreatedBySchema = {
      */
     id?: string;
 };
-/** @returns {SlideshowGetResponse} */
-declare function SlideshowGetResponse(): SlideshowGetResponse;
-type SlideshowGetResponse = {
+/** @returns {SlideshowGetDetails} */
+declare function SlideshowGetDetails(): SlideshowGetDetails;
+type SlideshowGetDetails = {
     /**
      * - Details related to slideshow/screensaver.
      */
@@ -1961,9 +1993,9 @@ type CustomObjectFieldSchema = {
      */
     _id?: string;
     /**
-     * - Key of custom field inside custom object.
+     * - Slug of custom field inside custom object.
      */
-    key?: string;
+    slug?: string;
     /**
      * - Value of custom field inside
      * custom object.
@@ -1985,7 +2017,7 @@ type CustomObjectByIdSchema = {
     /**
      * - Unique identifier of an entry.
      */
-    _id?: string;
+    id?: string;
     /**
      * - String denoting whether custom object is active
      * or inactive.
@@ -2028,18 +2060,13 @@ type CustomFieldSchema = {
      */
     namespace?: string;
     /**
-     * - Unique identifier for a custom field.
+     * - Unique identifier for a custom field in a given namespace.
      */
-    key?: string;
+    slug?: string;
     /**
      * - Type of an entity under which custom field is defined.
      */
     resource?: string;
-    /**
-     * - Denotes where the custom field has been
-     * defined - within a company or within a sales channel.
-     */
-    creator?: string;
     /**
      * - Array containing values of custom field.
      */
@@ -2079,10 +2106,6 @@ type CustomFieldSchema = {
      * validation failure on a custom field inside a custom object.
      */
     invalid_value_errors?: any[];
-    /**
-     * - Details of the owner of custom field creator.
-     */
-    created_by?: string;
     /**
      * - Whether the custom field definition is deleted.
      */
@@ -2106,6 +2129,40 @@ type CustomFieldsResponseByResourceIdSchema = {
      */
     items?: CustomFieldSchema[];
 };
+/** @returns {CustomObjectListItemSchema} */
+declare function CustomObjectListItemSchema(): CustomObjectListItemSchema;
+type CustomObjectListItemSchema = {
+    /**
+     * - Unique system generated if for a custom object
+     */
+    _id?: string;
+    /**
+     * - Unique system generated id for a custom
+     * object definition
+     */
+    definition_id?: string;
+    /**
+     * - Flag to denote whether custom object is active or not
+     */
+    status?: string;
+    /**
+     * - Updation time of custom object entry
+     */
+    updated_at?: string;
+    /**
+     * - A custom field inside custom object used
+     * to display the entry of custom object in listing
+     */
+    display_name?: string;
+    definition?: CustomObjectListItemDefinationSchema;
+    references?: number;
+};
+/** @returns {CustomObjectsSchema} */
+declare function CustomObjectsSchema(): CustomObjectsSchema;
+type CustomObjectsSchema = {
+    items?: CustomObjectListItemSchema[];
+    page?: Page;
+};
 /** @returns {ActionPage} */
 declare function ActionPage(): ActionPage;
 type ActionPage = {
@@ -2129,4 +2186,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";