@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

package/sdk/partner/Lead/LeadPartnerModel.js

@@ -9,13 +9,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts

@@ -33,13 +33,13 @@ export = LogisticsPartnerModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef BulkRegionJobSerializer
@@ -239,12 +239,33 @@ type BulkRegionServiceabilityTatResponse = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {BulkRegionJobSerializer} */

package/sdk/partner/Logistics/LogisticsPartnerModel.js

@@ -39,13 +39,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

package/sdk/partner/PartnerClient.d.ts

@@ -25,6 +25,14 @@ declare class PartnerClient {
      * @throws {FDKClientValidationError} When the provided header is not an object.
      */
     setExtraHeaders(header: object): void;
+    request({ method, url, query, body, headers, responseHeaders, }: {
+        method: any;
+        url: any;
+        query: any;
+        body: any;
+        headers: any;
+        responseHeaders?: boolean;
+    }): Promise<import("axios").AxiosResponse<any, any>>;
 }
 import FileStorage = require("./FileStorage/FileStoragePartnerClient");
 import Lead = require("./Lead/LeadPartnerClient");

package/sdk/partner/PartnerClient.js

@@ -9,6 +9,7 @@ const Theme = require("./Theme/ThemePartnerClient");
 const Webhook = require("./Webhook/WebhookPartnerClient");
 
 const { FDKClientValidationError } = require("../common/FDKError");
+const { execute } = require("./PartnerAPIClient");
 
 /**
  * Represents the client for the partner APIs.
@@ -44,6 +45,19 @@ class PartnerClient {
       throw new FDKClientValidationError("Context value should be an object");
     }
   }
+
+  async request({
+    method,
+    url,
+    query,
+    body,
+    headers,
+    responseHeaders = false,
+  }) {
+    return await execute(this.config, method, url, query, body, headers, {
+      responseHeaders,
+    });
+  }
 }
 
 module.exports = PartnerClient;

package/sdk/partner/Theme/ThemePartnerClient.d.ts

@@ -194,6 +194,26 @@ declare class Theme {
      * @description: Publish a draft extension section within the specified organization. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/publishExtensionSections/).
      */
     publishExtensionSections({ extensionId, body, requestHeaders }?: ThemePartnerValidator.PublishExtensionSectionsParam, { responseHeaders }?: object): Promise<ThemePartnerModel.PublishExtensionSectionResponse>;
+    /**
+     * @param {ThemePartnerValidator.ApplyExtensionPreviewParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<ThemePartnerModel.ExtensionPreviewResponse>} - Success response
+     * @name applyExtensionPreview
+     * @summary: Start a Preview of Extension Section
+     * @description: Use this API to start a local session for previewing the extension section binding. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/applyExtensionPreview/).
+     */
+    applyExtensionPreview({ extensionSectionId, body, requestHeaders }?: ThemePartnerValidator.ApplyExtensionPreviewParam, { responseHeaders }?: object): Promise<ThemePartnerModel.ExtensionPreviewResponse>;
+    /**
+     * @param {ThemePartnerValidator.RemoveExtensionPreviewParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<ThemePartnerModel.ExtensionPreviewResponse>} - Success response
+     * @name removeExtensionPreview
+     * @summary: Close a Preview of Extension Section
+     * @description: Use this API to close a local session for previewing the extension section binding - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/removeExtensionPreview/).
+     */
+    removeExtensionPreview({ extensionSectionId, body, requestHeaders }?: ThemePartnerValidator.RemoveExtensionPreviewParam, { responseHeaders }?: object): Promise<ThemePartnerModel.ExtensionPreviewResponse>;
     /**
      * @param {ThemePartnerValidator.GetThemeRejectionReasonsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/partner/Theme/ThemePartnerClient.js

@@ -1532,6 +1532,164 @@ class Theme {
     return response;
   }
 
+  /**
+   * @param {ThemePartnerValidator.ApplyExtensionPreviewParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PartnerAPIClient").Options} - Options
+   * @returns {Promise<ThemePartnerModel.ExtensionPreviewResponse>} - Success response
+   * @name applyExtensionPreview
+   * @summary: Start a Preview of Extension Section
+   * @description: Use this API to start a local session for previewing the extension section binding. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/applyExtensionPreview/).
+   */
+  async applyExtensionPreview(
+    { extensionSectionId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemePartnerValidator.applyExtensionPreview().validate(
+      {
+        extensionSectionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ThemePartnerValidator.applyExtensionPreview().validate(
+      {
+        extensionSectionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for partner > Theme > applyExtensionPreview \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PartnerAPIClient.execute(
+      this.config,
+      "post",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/extension-section/${extensionSectionId}/preview`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ThemePartnerModel.ExtensionPreviewResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for partner > Theme > applyExtensionPreview \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {ThemePartnerValidator.RemoveExtensionPreviewParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PartnerAPIClient").Options} - Options
+   * @returns {Promise<ThemePartnerModel.ExtensionPreviewResponse>} - Success response
+   * @name removeExtensionPreview
+   * @summary: Close a Preview of Extension Section
+   * @description: Use this API to close a local session for previewing the extension section binding - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/removeExtensionPreview/).
+   */
+  async removeExtensionPreview(
+    { extensionSectionId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemePartnerValidator.removeExtensionPreview().validate(
+      {
+        extensionSectionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ThemePartnerValidator.removeExtensionPreview().validate(
+      {
+        extensionSectionId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for partner > Theme > removeExtensionPreview \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PartnerAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/extension-section/${extensionSectionId}/preview`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ThemePartnerModel.ExtensionPreviewResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for partner > Theme > removeExtensionPreview \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ThemePartnerValidator.GetThemeRejectionReasonsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/partner/Theme/ThemePartnerModel.d.ts

@@ -65,6 +65,15 @@ export = ThemePartnerModel;
  * @property {string} [type]
  * @property {string} [status]
  */
+/**
+ * @typedef ExtensionPreviewRequest
+ * @property {string} [application_id] - Application ID
+ * @property {string} [section_preview_hash] - Hash for the section preview
+ */
+/**
+ * @typedef ExtensionPreviewResponse
+ * @property {string} [message]
+ */
 /**
  * @typedef PublishExtensionSectionResponse
  * @property {SectionsResponse} [sections]
@@ -104,7 +113,7 @@ export = ThemePartnerModel;
  */
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -589,9 +598,9 @@ export = ThemePartnerModel;
  */
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 /**
@@ -606,6 +615,7 @@ export = ThemePartnerModel;
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -645,7 +655,7 @@ export = ThemePartnerModel;
 declare class ThemePartnerModel {
 }
 declare namespace ThemePartnerModel {
-    export { AvailablePageSchema, DraftExtensionSectionRequest, DraftExtensionSectionResponse, SectionsResponse, ExtensionSection, PropExtension, AssetsExtension, PublishExtensionSectionRequest, PublishExtensionSectionResponse, AvailablePageSectionMetaAttributes, AvailablePageSeo, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSchemaSections, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AvailablePagePredicate, MarketplaceThemeSchema, MarketplaceTheme, PaymentInfo, ContactInfo, CatalogSize, MarketplaceThemeImages, CarouselItem, ExploreInfo, Feature, FeatureItem, Highlight, Variation, Documentation, Comments, ThemeRejectionReasons, AllAvailablePageSchema, PaginationSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, ThemesSchema, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, CustomProps, ThemeMeta, ThemePayment, Release, Images, Assets, UMDJs, CommonJS, CSS, SectionItem, GlobalSchema, Prop, Preset, Page, SectionProps, SectionPreset, ImagePickerProp, UrlProp, BlockProps, TextProp, CheckboxProp, RangeProp, Section, Block, Predicate, Screen, ThemeUserSchema, Route, UpdateThemeRequestBody, CreateNewTheme, ActionPage, PageType };
+    export { AvailablePageSchema, DraftExtensionSectionRequest, DraftExtensionSectionResponse, SectionsResponse, ExtensionSection, PropExtension, AssetsExtension, PublishExtensionSectionRequest, ExtensionPreviewRequest, ExtensionPreviewResponse, PublishExtensionSectionResponse, AvailablePageSectionMetaAttributes, AvailablePageSeo, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSchemaSections, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AvailablePagePredicate, MarketplaceThemeSchema, MarketplaceTheme, PaymentInfo, ContactInfo, CatalogSize, MarketplaceThemeImages, CarouselItem, ExploreInfo, Feature, FeatureItem, Highlight, Variation, Documentation, Comments, ThemeRejectionReasons, AllAvailablePageSchema, PaginationSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, ThemesSchema, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, CustomProps, ThemeMeta, ThemePayment, Release, Images, Assets, UMDJs, CommonJS, CSS, SectionItem, GlobalSchema, Prop, Preset, Page, SectionProps, SectionPreset, ImagePickerProp, UrlProp, BlockProps, TextProp, CheckboxProp, RangeProp, Section, Block, Predicate, Screen, ThemeUserSchema, Route, UpdateThemeRequestBody, CreateNewTheme, ActionPage, PageType };
 }
 /** @returns {AvailablePageSchema} */
 declare function AvailablePageSchema(): AvailablePageSchema;
@@ -727,6 +737,23 @@ type PublishExtensionSectionRequest = {
     type?: string;
     status?: string;
 };
+/** @returns {ExtensionPreviewRequest} */
+declare function ExtensionPreviewRequest(): ExtensionPreviewRequest;
+type ExtensionPreviewRequest = {
+    /**
+     * - Application ID
+     */
+    application_id?: string;
+    /**
+     * - Hash for the section preview
+     */
+    section_preview_hash?: string;
+};
+/** @returns {ExtensionPreviewResponse} */
+declare function ExtensionPreviewResponse(): ExtensionPreviewResponse;
+type ExtensionPreviewResponse = {
+    message?: string;
+};
 /** @returns {PublishExtensionSectionResponse} */
 declare function PublishExtensionSectionResponse(): PublishExtensionSectionResponse;
 type PublishExtensionSectionResponse = {
@@ -774,6 +801,9 @@ type SEObreadcrumb = {
 /** @returns {Action} */
 declare function Action(): Action;
 type Action = {
+    /**
+     * - Type of action to be taken e.g, page.
+     */
     type?: string;
     page?: ActionPage;
     popup?: ActionPage;
@@ -1785,8 +1815,17 @@ type CreateNewTheme = {
 /** @returns {ActionPage} */
 declare function ActionPage(): ActionPage;
 type ActionPage = {
+    /**
+     * - Parameters that should be considered in path.
+     */
     params?: any;
+    /**
+     * - Query parameter if any to be added to the action.
+     */
     query?: any;
+    /**
+     * - The URL for the action.
+     */
     url?: string;
     type: PageType;
 };
@@ -1796,4 +1835,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "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";

package/sdk/partner/Theme/ThemePartnerModel.js

@@ -74,6 +74,17 @@ const Joi = require("joi");
  * @property {string} [status]
  */
 
+/**
+ * @typedef ExtensionPreviewRequest
+ * @property {string} [application_id] - Application ID
+ * @property {string} [section_preview_hash] - Hash for the section preview
+ */
+
+/**
+ * @typedef ExtensionPreviewResponse
+ * @property {string} [message]
+ */
+
 /**
  * @typedef PublishExtensionSectionResponse
  * @property {SectionsResponse} [sections]
@@ -120,7 +131,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -675,9 +686,9 @@ const Joi = require("joi");
 
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 
@@ -693,6 +704,7 @@ const Joi = require("joi");
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -825,6 +837,21 @@ class ThemePartnerModel {
     });
   }
 
+  /** @returns {ExtensionPreviewRequest} */
+  static ExtensionPreviewRequest() {
+    return Joi.object({
+      application_id: Joi.string().allow(""),
+      section_preview_hash: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ExtensionPreviewResponse} */
+  static ExtensionPreviewResponse() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {PublishExtensionSectionResponse} */
   static PublishExtensionSectionResponse() {
     return Joi.object({
@@ -1620,6 +1647,8 @@ class ThemePartnerModel {
 
       "collections",
 
+      "custom",
+
       "contact-us",
 
       "external",

package/sdk/partner/Theme/ThemePartnerValidator.d.ts

@@ -19,6 +19,8 @@ declare class ThemeValidator {
     static createNewThemeInOrganization(): any;
     static createExtensionSectionDraft(): any;
     static publishExtensionSections(): any;
+    static applyExtensionPreview(): any;
+    static removeExtensionPreview(): any;
     static getThemeRejectionReasons(): any;
     static getThemeVersions(): any;
     static createTheme(): any;

package/sdk/partner/Theme/ThemePartnerValidator.js

@@ -153,6 +153,20 @@ class ThemeValidator {
     }).required();
   }
 
+  static applyExtensionPreview() {
+    return Joi.object({
+      extensionSectionId: Joi.string().allow("").required(),
+      body: ThemeModel.ExtensionPreviewRequest().required(),
+    }).required();
+  }
+
+  static removeExtensionPreview() {
+    return Joi.object({
+      extensionSectionId: Joi.string().allow("").required(),
+      body: ThemeModel.ExtensionPreviewRequest().required(),
+    }).required();
+  }
+
   static getThemeRejectionReasons() {
     return Joi.object({
       themeId: Joi.string().allow("").required(),

package/sdk/partner/Webhook/WebhookPartnerModel.d.ts

@@ -179,13 +179,13 @@ export = WebhookPartnerModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef DeliveryEventLevelSchema
@@ -516,12 +516,33 @@ type EventProcessReportObject = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {DeliveryEventLevelSchema} */

package/sdk/partner/Webhook/WebhookPartnerModel.js

@@ -205,13 +205,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**