@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

package/sdk/platform/Content/ContentPlatformModel.js

@@ -42,21 +42,6 @@ const Joi = require("joi");
  * @property {string} [type]
  */
 
-/**
- * @typedef AnnouncementSchema
- * @property {string} [announcement]
- * @property {ScheduleStartSchema} [schedule]
- */
-
-/**
- * @typedef AnnouncementsResponseSchema
- * @property {Object} [announcements]
- * @property {string[]} [refresh_pages] - List of page slugs on which
- *   announcement should be fetched as soon as they are loaded
- * @property {number} [refresh_rate] - Number of seconds after which api should
- *   hit again to fetch new announcements
- */
-
 /**
  * @typedef ApplicationLegal
  * @property {string} [_id]
@@ -190,12 +175,6 @@ const Joi = require("joi");
  * @property {number} [status]
  */
 
-/**
- * @typedef ContentSchema
- * @property {string} [type]
- * @property {Object} [value]
- */
-
 /**
  * @typedef CreateAnnouncementSchema
  * @property {AdminAnnouncementSchema} [data]
@@ -260,32 +239,9 @@ const Joi = require("joi");
  * @property {string} [name]
  */
 
-/**
- * @typedef CustomPage
- * @property {CustomPageSchema} [data]
- */
-
-/**
- * @typedef CustomPageSchema
- * @property {string} [_id]
- * @property {ScheduleSchema} [_schedule]
- * @property {string} [application]
- * @property {Object[]} [content]
- * @property {CreatedBySchema} [created_by]
- * @property {DateMeta} [date_meta]
- * @property {string} [description]
- * @property {string} [orientation]
- * @property {string} [platform]
- * @property {boolean} [published]
- * @property {string} [slug]
- * @property {string[]} [tags]
- * @property {string} [title]
- * @property {string} [type]
- */
-
 /**
  * @typedef DataLoaderResetResponseSchema
- * @property {string} [reset]
+ * @property {boolean} [reset]
  */
 
 /**
@@ -383,11 +339,6 @@ const Joi = require("joi");
  * @property {string} [title]
  */
 
-/**
- * @typedef FaqResponseSchema
- * @property {FaqSchema[]} [faqs]
- */
-
 /**
  * @typedef FaqSchema
  * @property {string} [_id]
@@ -398,11 +349,6 @@ const Joi = require("joi");
  * @property {string[]} [tags]
  */
 
-/**
- * @typedef FeatureImage
- * @property {string} [secure_url]
- */
-
 /**
  * @typedef GeneratedSEOContent
  * @property {string} [description]
@@ -449,12 +395,6 @@ const Joi = require("joi");
  * @property {string} [url]
  */
 
-/**
- * @typedef LandingPage
- * @property {LandingPageSchema} [data]
- * @property {boolean} [success]
- */
-
 /**
  * @typedef LandingPageGetResponse
  * @property {LandingPageSchema[]} [items]
@@ -486,20 +426,6 @@ const Joi = require("joi");
  * @property {Language} [hi]
  */
 
-/**
- * @typedef Navigation
- * @property {string} [_id]
- * @property {string} [application]
- * @property {CreatedBySchema} [created_by]
- * @property {DateMeta} [date_meta]
- * @property {string} [name]
- * @property {NavigationReference} [navigation]
- * @property {string} [orientation]
- * @property {string} [platform]
- * @property {string} [position]
- * @property {string} [slug]
- */
-
 /**
  * @typedef NavigationGetResponse
  * @property {NavigationSchema[]} [items]
@@ -567,24 +493,12 @@ const Joi = require("joi");
  * @property {string} type
  */
 
-/**
- * @typedef PageContent
- * @property {string} [type]
- * @property {Object} [value]
- */
-
 /**
  * @typedef PageGetResponse
  * @property {PageSchema[]} [items]
  * @property {Page} [page]
  */
 
-/**
- * @typedef PageMeta
- * @property {string} [key]
- * @property {Object} [value]
- */
-
 /**
  * @typedef PageMetaSchema
  * @property {string} [application_id]
@@ -643,7 +557,7 @@ const Joi = require("joi");
 
 /**
  * @typedef PageSpec
- * @property {Object[]} [specifications]
+ * @property {PageSpecItem[]} [specifications]
  */
 
 /**
@@ -706,13 +620,7 @@ const Joi = require("joi");
  * @property {string} [cron]
  * @property {number} [duration]
  * @property {string} [end]
- * @property {Object[]} [next_schedule]
- * @property {string} [start]
- */
-
-/**
- * @typedef ScheduleStartSchema
- * @property {string} [end]
+ * @property {NextSchedule[]} [next_schedule]
  * @property {string} [start]
  */
 
@@ -739,19 +647,13 @@ const Joi = require("joi");
  * @property {string} [app]
  * @property {boolean} [cannonical_enabled]
  * @property {string} [created_at]
- * @property {Object[]} [custom_meta_tags]
+ * @property {CustomMetaTag[]} [custom_meta_tags]
  * @property {Detail} [details]
  * @property {string} [robots_txt]
  * @property {boolean} [sitemap_enabled]
  * @property {string} [updated_at]
  */
 
-/**
- * @typedef Slideshow
- * @property {SlideshowSchema} [data]
- * @property {boolean} [success]
- */
-
 /**
  * @typedef SlideshowGetResponse
  * @property {SlideshowSchema[]} [items]
@@ -954,26 +856,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {AnnouncementSchema} */
-  static AnnouncementSchema() {
-    return Joi.object({
-      announcement: Joi.string().allow(""),
-      schedule: ContentPlatformModel.ScheduleStartSchema(),
-    });
-  }
-
-  /** @returns {AnnouncementsResponseSchema} */
-  static AnnouncementsResponseSchema() {
-    return Joi.object({
-      announcements: Joi.object().pattern(
-        /\S/,
-        Joi.array().items(ContentPlatformModel.AnnouncementSchema())
-      ),
-      refresh_pages: Joi.array().items(Joi.string().allow("")),
-      refresh_rate: Joi.number(),
-    });
-  }
-
   /** @returns {ApplicationLegal} */
   static ApplicationLegal() {
     return Joi.object({
@@ -1135,14 +1017,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {ContentSchema} */
-  static ContentSchema() {
-    return Joi.object({
-      type: Joi.string().allow(""),
-      value: Joi.any(),
-    });
-  }
-
   /** @returns {CreateAnnouncementSchema} */
   static CreateAnnouncementSchema() {
     return Joi.object({
@@ -1227,37 +1101,10 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {CustomPage} */
-  static CustomPage() {
-    return Joi.object({
-      data: ContentPlatformModel.CustomPageSchema(),
-    });
-  }
-
-  /** @returns {CustomPageSchema} */
-  static CustomPageSchema() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      _schedule: ContentPlatformModel.ScheduleSchema(),
-      application: Joi.string().allow(""),
-      content: Joi.array().items(Joi.any()),
-      created_by: ContentPlatformModel.CreatedBySchema(),
-      date_meta: ContentPlatformModel.DateMeta(),
-      description: Joi.string().allow(""),
-      orientation: Joi.string().allow(""),
-      platform: Joi.string().allow(""),
-      published: Joi.boolean(),
-      slug: Joi.string().allow(""),
-      tags: Joi.array().items(Joi.string().allow("")),
-      title: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {DataLoaderResetResponseSchema} */
   static DataLoaderResetResponseSchema() {
     return Joi.object({
-      reset: Joi.string().allow(""),
+      reset: Joi.boolean(),
     });
   }
 
@@ -1380,13 +1227,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {FaqResponseSchema} */
-  static FaqResponseSchema() {
-    return Joi.object({
-      faqs: Joi.array().items(ContentPlatformModel.FaqSchema()),
-    });
-  }
-
   /** @returns {FaqSchema} */
   static FaqSchema() {
     return Joi.object({
@@ -1399,13 +1239,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {FeatureImage} */
-  static FeatureImage() {
-    return Joi.object({
-      secure_url: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {GeneratedSEOContent} */
   static GeneratedSEOContent() {
     return Joi.object({
@@ -1466,14 +1299,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {LandingPage} */
-  static LandingPage() {
-    return Joi.object({
-      data: ContentPlatformModel.LandingPageSchema(),
-      success: Joi.boolean(),
-    });
-  }
-
   /** @returns {LandingPageGetResponse} */
   static LandingPageGetResponse() {
     return Joi.object({
@@ -1513,22 +1338,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {Navigation} */
-  static Navigation() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      application: Joi.string().allow(""),
-      created_by: ContentPlatformModel.CreatedBySchema(),
-      date_meta: ContentPlatformModel.DateMeta(),
-      name: Joi.string().allow(""),
-      navigation: ContentPlatformModel.NavigationReference(),
-      orientation: Joi.string().allow(""),
-      platform: Joi.string().allow(""),
-      position: Joi.string().allow(""),
-      slug: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {NavigationGetResponse} */
   static NavigationGetResponse() {
     return Joi.object({
@@ -1610,14 +1419,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {PageContent} */
-  static PageContent() {
-    return Joi.object({
-      type: Joi.string().allow(""),
-      value: Joi.any(),
-    });
-  }
-
   /** @returns {PageGetResponse} */
   static PageGetResponse() {
     return Joi.object({
@@ -1626,14 +1427,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {PageMeta} */
-  static PageMeta() {
-    return Joi.object({
-      key: Joi.string().allow(""),
-      value: Joi.any(),
-    });
-  }
-
   /** @returns {PageMetaSchema} */
   static PageMetaSchema() {
     return Joi.object({
@@ -1700,7 +1493,7 @@ class ContentPlatformModel {
   /** @returns {PageSpec} */
   static PageSpec() {
     return Joi.object({
-      specifications: Joi.array().items(Joi.any()),
+      specifications: Joi.array().items(ContentPlatformModel.PageSpecItem()),
     });
   }
 
@@ -1781,15 +1574,7 @@ class ContentPlatformModel {
       cron: Joi.string().allow(""),
       duration: Joi.number(),
       end: Joi.string().allow(""),
-      next_schedule: Joi.array().items(Joi.any()),
-      start: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ScheduleStartSchema} */
-  static ScheduleStartSchema() {
-    return Joi.object({
-      end: Joi.string().allow(""),
+      next_schedule: Joi.array().items(ContentPlatformModel.NextSchedule()),
       start: Joi.string().allow(""),
     });
   }
@@ -1824,7 +1609,7 @@ class ContentPlatformModel {
       app: Joi.string().allow(""),
       cannonical_enabled: Joi.boolean(),
       created_at: Joi.string().allow(""),
-      custom_meta_tags: Joi.array().items(Joi.any()),
+      custom_meta_tags: Joi.array().items(ContentPlatformModel.CustomMetaTag()),
       details: ContentPlatformModel.Detail(),
       robots_txt: Joi.string().allow(""),
       sitemap_enabled: Joi.boolean(),
@@ -1832,14 +1617,6 @@ class ContentPlatformModel {
     });
   }
 
-  /** @returns {Slideshow} */
-  static Slideshow() {
-    return Joi.object({
-      data: ContentPlatformModel.SlideshowSchema(),
-      success: Joi.boolean(),
-    });
-  }
-
   /** @returns {SlideshowGetResponse} */
   static SlideshowGetResponse() {
     return Joi.object({

package/sdk/platform/Discount/DiscountPlatformClient.d.ts

@@ -4,103 +4,140 @@ declare class Discount {
     config: any;
     /**
      * @param {DiscountPlatformValidator.CancelDownloadJobParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
      * @name cancelDownloadJob
      * @summary: Cancel Download Job.
      * @description: Cancel Download Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelDownloadJob/).
      */
-    cancelDownloadJob({ id }?: DiscountPlatformValidator.CancelDownloadJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.CancelJobResponse>;
+    cancelDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.CancelJobResponse>;
     /**
      * @param {DiscountPlatformValidator.CancelValidationJobParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
      * @name cancelValidationJob
      * @summary: Cancel Validation Job.
      * @description: Cancel Validation Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
      */
-    cancelValidationJob({ id }?: DiscountPlatformValidator.CancelValidationJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.CancelJobResponse>;
+    cancelValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.CancelJobResponse>;
     /**
      * @param {DiscountPlatformValidator.CreateDiscountParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
      * @name createDiscount
      * @summary: Create Discount.
      * @description: Create Discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
      */
-    createDiscount({ body }?: DiscountPlatformValidator.CreateDiscountParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.DiscountJob>;
+    createDiscount({ body, requestHeaders }?: DiscountPlatformValidator.CreateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
     /**
      * @param {DiscountPlatformValidator.DownloadDiscountFileParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
      * @name downloadDiscountFile
      * @summary: Validate File.
      * @description: Validate File. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
      */
-    downloadDiscountFile({ type, body }?: DiscountPlatformValidator.DownloadDiscountFileParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.FileJobResponse>;
+    downloadDiscountFile({ type, body, requestHeaders }?: DiscountPlatformValidator.DownloadDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponse>;
     /**
      * @param {DiscountPlatformValidator.GetDiscountParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
      * @name getDiscount
      * @summary: Fetch discount.
      * @description: Fetch discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
      */
-    getDiscount({ id }?: DiscountPlatformValidator.GetDiscountParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.DiscountJob>;
+    getDiscount({ id, requestHeaders }?: DiscountPlatformValidator.GetDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
     /**
      * @param {DiscountPlatformValidator.GetDiscountsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
      * @name getDiscounts
      * @summary: Fetch discount list.
      * @description: Fetch discount list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
      */
-    getDiscounts({ view, q, pageNo, pageSize, archived, month, year, type, appIds }?: DiscountPlatformValidator.GetDiscountsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.ListOrCalender>;
+    getDiscounts({ view, q, pageNo, pageSize, archived, month, year, type, appIds, requestHeaders, }?: DiscountPlatformValidator.GetDiscountsParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.ListOrCalender>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.view] - Listing or calender. Default is listing.
+     * @param {string} [arg.q] - The search query. This can be a partial or
+     *   complete name of a discount.
+     * @param {number} [arg.pageSize] - Page size. Default is 12.
+     * @param {boolean} [arg.archived] - Archived. Default is false.
+     * @param {number} [arg.month] - Month. Default is current month.
+     * @param {number} [arg.year] - Year. Default is current year.
+     * @param {string} [arg.type] - Basic or custom.
+     * @param {string[]} [arg.appIds] - Application ids.
+     * @returns {Paginator<DiscountPlatformModel.ListOrCalender>}
+     * @summary: Fetch discount list.
+     * @description: Fetch discount list.
+     */
+    getDiscountsPaginator({ view, q, pageSize, archived, month, year, type, appIds, }?: {
+        view?: string;
+        q?: string;
+        pageSize?: number;
+        archived?: boolean;
+        month?: number;
+        year?: number;
+        type?: string;
+        appIds?: string[];
+    }): Paginator<DiscountPlatformModel.ListOrCalender>;
     /**
      * @param {DiscountPlatformValidator.GetDownloadJobParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
      * @name getDownloadJob
      * @summary: Download File Job.
      * @description: Download File Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
      */
-    getDownloadJob({ id }?: DiscountPlatformValidator.GetDownloadJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.FileJobResponse>;
+    getDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.GetDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponse>;
     /**
      * @param {DiscountPlatformValidator.GetValidationJobParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
      * @name getValidationJob
      * @summary: Validate File Job.
      * @description: Validate File Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
      */
-    getValidationJob({ id }?: DiscountPlatformValidator.GetValidationJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.FileJobResponse>;
+    getValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.GetValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponse>;
     /**
      * @param {DiscountPlatformValidator.UpdateDiscountParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
      * @name updateDiscount
      * @summary: Create Discount.
      * @description: Create Discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
      */
-    updateDiscount({ id, body }?: DiscountPlatformValidator.UpdateDiscountParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.DiscountJob>;
+    updateDiscount({ id, body, requestHeaders }?: DiscountPlatformValidator.UpdateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
     /**
      * @param {DiscountPlatformValidator.UpsertDiscountItemsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<Object>} - Success response
      * @name upsertDiscountItems
      * @summary: Create custom discount from bulk.
      * @description: Create custom discounts through API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
      */
-    upsertDiscountItems({ id, body }?: DiscountPlatformValidator.UpsertDiscountItemsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<any>;
+    upsertDiscountItems({ id, body, requestHeaders }?: DiscountPlatformValidator.UpsertDiscountItemsParam, { responseHeaders }?: object): Promise<any>;
     /**
      * @param {DiscountPlatformValidator.ValidateDiscountFileParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
      * @name validateDiscountFile
      * @summary: Validate File.
      * @description: Validate File. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
      */
-    validateDiscountFile({ body, discount }?: DiscountPlatformValidator.ValidateDiscountFileParam, { headers }?: import("../PlatformAPIClient").Options): Promise<DiscountPlatformModel.FileJobResponse>;
+    validateDiscountFile({ body, discount, requestHeaders }?: DiscountPlatformValidator.ValidateDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponse>;
 }
 import DiscountPlatformValidator = require("./DiscountPlatformValidator");
 import DiscountPlatformModel = require("./DiscountPlatformModel");
+import Paginator = require("../../common/Paginator");