@gofynd/fdk-client-javascript 3.25.0 → 3.27.0

package/sdk/platform/Order/OrderPlatformModel.js

@@ -2915,18 +2915,18 @@ const Joi = require("joi");
 
 /**
  * @typedef BundleDetailsSchema
- * @property {boolean} [is_base] - This serves as the base item, with all other
+ * @property {boolean} is_base - This serves as the base item, with all other
  *   items acting as child elements within the bundle to display the hero
  *   product prominently at the top.
- * @property {string[]} [images] - An array of image URLs associated with the bundle.
- * @property {string} [group_id] - Unique group identifier for the bundle
+ * @property {string[]} images - An array of image URLs associated with the bundle.
+ * @property {string} group_id - Unique group identifier for the bundle
  *   generated by seller to club the articles
- * @property {string} [name] - Name of the bundle.
- * @property {string} [item_type] - Type of the bundle item
- * @property {number} [item_id] - Unique identifier of the item.
- * @property {string} [item_code] - Item code for the item.
- * @property {string} [item_name] - Name of the item.
- * @property {string} [seller_identifier] - Identifier for the seller of the bundle.
+ * @property {string} name - Name of the bundle.
+ * @property {string} item_type - Type of the bundle item
+ * @property {number} item_id - Unique identifier of the item.
+ * @property {string} item_code - Item code for the item.
+ * @property {string} item_name - Name of the item.
+ * @property {string} seller_identifier - Identifier for the seller of the bundle.
  * @property {number} [bundle_article_quantity] - In orders with multiple
  *   quantities of the same line item, the line item count remains constant, but
  *   multiple bundles can exist. To distinguish between these bundles, the
@@ -8781,15 +8781,15 @@ class OrderPlatformModel {
   /** @returns {BundleDetailsSchema} */
   static BundleDetailsSchema() {
     return Joi.object({
-      is_base: Joi.boolean(),
-      images: Joi.array().items(Joi.string().allow("")),
-      group_id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      item_type: Joi.string().allow(""),
-      item_id: Joi.number(),
-      item_code: Joi.string().allow(""),
-      item_name: Joi.string().allow(""),
-      seller_identifier: Joi.string().allow(""),
+      is_base: Joi.boolean().required(),
+      images: Joi.array().items(Joi.string().allow("")).required(),
+      group_id: Joi.string().allow("").required(),
+      name: Joi.string().allow("").required(),
+      item_type: Joi.string().allow("").required(),
+      item_id: Joi.number().required(),
+      item_code: Joi.string().allow("").required(),
+      item_name: Joi.string().allow("").required(),
+      seller_identifier: Joi.string().allow("").required(),
       bundle_article_quantity: Joi.number(),
       brand_name: Joi.string().allow(""),
       size: Joi.string().allow(""),

package/sdk/platform/PlatformApplicationClient.d.ts

@@ -15,7 +15,6 @@ declare class PlatformApplicationClient {
     config: import("./PlatformConfig");
     companyId: string;
     applicationId: string;
-    analytics: Analytics;
     cart: Cart;
     catalog: Catalog;
     communication: Communication;
@@ -38,7 +37,6 @@ declare class PlatformApplicationClient {
      */
     setExtraHeaders(header: object): void;
 }
-import Analytics = require("./Analytics/AnalyticsPlatformApplicationClient");
 import Cart = require("./Cart/CartPlatformApplicationClient");
 import Catalog = require("./Catalog/CatalogPlatformApplicationClient");
 import Communication = require("./Communication/CommunicationPlatformApplicationClient");

package/sdk/platform/PlatformApplicationClient.js

@@ -1,5 +1,3 @@
-const Analytics = require("./Analytics/AnalyticsPlatformApplicationClient");
-
 const Cart = require("./Cart/CartPlatformApplicationClient");
 
 const Catalog = require("./Catalog/CatalogPlatformApplicationClient");
@@ -47,8 +45,6 @@ class PlatformApplicationClient {
     this.companyId = config.companyId;
     this.applicationId = applicationId;
 
-    this.analytics = new Analytics(config, applicationId);
-
     this.cart = new Cart(config, applicationId);
 
     this.catalog = new Catalog(config, applicationId);

package/sdk/platform/Theme/ThemePlatformModel.d.ts

@@ -584,6 +584,7 @@ export = ThemePlatformModel;
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -1667,4 +1668,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-email" | "profile-phone" | "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" | "single-page-checkout" | "request-reattempt" | "files";
+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-email" | "profile-phone" | "profile-loyalty-rewards" | "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" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -667,6 +667,7 @@ const Joi = require("joi");
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -1561,6 +1562,8 @@ class ThemePlatformModel {
 
       "profile-phone",
 
+      "profile-loyalty-rewards",
+
       "rate-us",
 
       "refer-earn",

package/sdk/platform/index.d.ts

@@ -1,7 +1,6 @@
 export const PlatformConfig: typeof import("./PlatformConfig");
 export const PlatformClient: typeof import("./PlatformClient");
 export namespace PlatformModel {
-    const AnalyticsPlatformModel: typeof import("./Analytics/AnalyticsPlatformModel");
     const AuditTrailPlatformModel: typeof import("./AuditTrail/AuditTrailPlatformModel");
     const BillingPlatformModel: typeof import("./Billing/BillingPlatformModel");
     const CartPlatformModel: typeof import("./Cart/CartPlatformModel");

package/sdk/platform/index.js

@@ -2,8 +2,6 @@ module.exports = {
   PlatformConfig: require("./PlatformConfig"),
   PlatformClient: require("./PlatformClient"),
   PlatformModel: {
-    AnalyticsPlatformModel: require("./Analytics/AnalyticsPlatformModel"),
-
     AuditTrailPlatformModel: require("./AuditTrail/AuditTrailPlatformModel"),
 
     BillingPlatformModel: require("./Billing/BillingPlatformModel"),

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts

@@ -1,44 +0,0 @@
-export = Analytics;
-declare class Analytics {
-    constructor(config: any, applicationId: any);
-    config: any;
-    applicationId: any;
-    /**
-     * @param {AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AnalyticsPlatformModel.JobStatus>} - Success response
-     * @name checkJobStatusByNameV2
-     * @summary: Checks download job status
-     * @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/checkJobStatusByNameV2/).
-     */
-    checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobStatus>;
-    /**
-     * @param {AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - Success response
-     * @name executeJobForProvidedParametersV2
-     * @summary: Executes given sql(Base64 Encoded) query
-     * @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
-     */
-    executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobExecutionResult>;
-    /**
-     * @param {AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
-     * @name startDownloadForQueryV2
-     * @summary: Initiates download job
-     * @description: Initiates download job and returns job name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/startDownloadForQueryV2/).
-     */
-    startDownloadForQueryV2({ exportType, body, requestHeaders }?: AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param, { responseHeaders }?: object): Promise<any>;
-}
-import AnalyticsPlatformApplicationValidator = require("./AnalyticsPlatformApplicationValidator");
-import AnalyticsPlatformModel = require("./AnalyticsPlatformModel");

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js

@@ -1,263 +0,0 @@
-const PlatformAPIClient = require("../PlatformAPIClient");
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-const Paginator = require("../../common/Paginator");
-const AnalyticsPlatformApplicationValidator = require("./AnalyticsPlatformApplicationValidator");
-const AnalyticsPlatformModel = require("./AnalyticsPlatformModel");
-const { Logger } = require("./../../common/Logger");
-const Joi = require("joi");
-
-class Analytics {
-  constructor(config, applicationId) {
-    this.config = config;
-    this.applicationId = applicationId;
-  }
-
-  /**
-   * @param {AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param} arg
-   *   - Arg object
-   *
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AnalyticsPlatformModel.JobStatus>} - Success response
-   * @name checkJobStatusByNameV2
-   * @summary: Checks download job status
-   * @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/checkJobStatusByNameV2/).
-   */
-  async checkJobStatusByNameV2(
-    { fileName, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = AnalyticsPlatformApplicationValidator.checkJobStatusByNameV2().validate(
-      {
-        fileName,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AnalyticsPlatformApplicationValidator.checkJobStatusByNameV2().validate(
-      {
-        fileName,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Analytics > checkJobStatusByNameV2 \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/insights/v2.0/company/${this.config.companyId}/application/${this.applicationId}/job/${fileName}/status`,
-      query_params,
-      undefined,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AnalyticsPlatformModel.JobStatus().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 platform > Analytics > checkJobStatusByNameV2 \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param} arg
-   *   - Arg object
-   *
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - Success response
-   * @name executeJobForProvidedParametersV2
-   * @summary: Executes given sql(Base64 Encoded) query
-   * @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
-   */
-  async executeJobForProvidedParametersV2(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = AnalyticsPlatformApplicationValidator.executeJobForProvidedParametersV2().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AnalyticsPlatformApplicationValidator.executeJobForProvidedParametersV2().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Analytics > executeJobForProvidedParametersV2 \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/insights/v2.0/company/${this.config.companyId}/application/${this.applicationId}/job/execute`,
-      query_params,
-      body,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AnalyticsPlatformModel.JobExecutionResult().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 platform > Analytics > executeJobForProvidedParametersV2 \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param} arg
-   *   - Arg object
-   *
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<Object>} - Success response
-   * @name startDownloadForQueryV2
-   * @summary: Initiates download job
-   * @description: Initiates download job and returns job name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/startDownloadForQueryV2/).
-   */
-  async startDownloadForQueryV2(
-    { exportType, body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = AnalyticsPlatformApplicationValidator.startDownloadForQueryV2().validate(
-      {
-        exportType,
-        body,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AnalyticsPlatformApplicationValidator.startDownloadForQueryV2().validate(
-      {
-        exportType,
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Analytics > startDownloadForQueryV2 \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["export_type"] = exportType;
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/insights/v2.0/company/${this.config.companyId}/application/${this.applicationId}/job/download`,
-      query_params,
-      body,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const { error: res_error } = Joi.any().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 platform > Analytics > startDownloadForQueryV2 \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-}
-
-module.exports = Analytics;

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts

@@ -1,42 +0,0 @@
-export = AnalyticsPlatformApplicationValidator;
-/**
- * @typedef CheckJobStatusByNameV2Param
- * @property {string} fileName - Download job name
- */
-/**
- * @typedef ExecuteJobForProvidedParametersV2Param
- * @property {AnalyticsPlatformModel.JobExecute} body
- */
-/**
- * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
- * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
- */
-declare class AnalyticsPlatformApplicationValidator {
-    /** @returns {CheckJobStatusByNameV2Param} */
-    static checkJobStatusByNameV2(): CheckJobStatusByNameV2Param;
-    /** @returns {ExecuteJobForProvidedParametersV2Param} */
-    static executeJobForProvidedParametersV2(): ExecuteJobForProvidedParametersV2Param;
-    /** @returns {StartDownloadForQueryV2Param} */
-    static startDownloadForQueryV2(): StartDownloadForQueryV2Param;
-}
-declare namespace AnalyticsPlatformApplicationValidator {
-    export { CheckJobStatusByNameV2Param, ExecuteJobForProvidedParametersV2Param, StartDownloadForQueryV2Param };
-}
-type CheckJobStatusByNameV2Param = {
-    /**
-     * - Download job name
-     */
-    fileName: string;
-};
-type ExecuteJobForProvidedParametersV2Param = {
-    body: AnalyticsPlatformModel.JobExecute;
-};
-type StartDownloadForQueryV2Param = {
-    /**
-     * - Format in which to be exported(eg. CSV or excel).
-     */
-    exportType: string;
-    body: AnalyticsPlatformModel.FileDownloadRequestBody;
-};
-import AnalyticsPlatformModel = require("./AnalyticsPlatformModel");

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -1,45 +0,0 @@
-const Joi = require("joi");
-
-const AnalyticsPlatformModel = require("./AnalyticsPlatformModel");
-
-/**
- * @typedef CheckJobStatusByNameV2Param
- * @property {string} fileName - Download job name
- */
-
-/**
- * @typedef ExecuteJobForProvidedParametersV2Param
- * @property {AnalyticsPlatformModel.JobExecute} body
- */
-
-/**
- * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
- * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
- */
-
-class AnalyticsPlatformApplicationValidator {
-  /** @returns {CheckJobStatusByNameV2Param} */
-  static checkJobStatusByNameV2() {
-    return Joi.object({
-      fileName: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {ExecuteJobForProvidedParametersV2Param} */
-  static executeJobForProvidedParametersV2() {
-    return Joi.object({
-      body: AnalyticsPlatformModel.JobExecute().required(),
-    }).required();
-  }
-
-  /** @returns {StartDownloadForQueryV2Param} */
-  static startDownloadForQueryV2() {
-    return Joi.object({
-      exportType: Joi.string().allow("").required(),
-      body: AnalyticsPlatformModel.FileDownloadRequestBody().required(),
-    }).required();
-  }
-}
-
-module.exports = AnalyticsPlatformApplicationValidator;

package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts

@@ -1,136 +0,0 @@
-export = AnalyticsPlatformModel;
-/**
- * @typedef Page
- * @property {number} [item_total] - The total number of all items across all pages.
- * @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, can be 'cursor' or 'number'.
- * @property {number} [size] - The number of items per page.
- * @property {number} [page_size] - The number of items per page.
- */
-/**
- * @typedef FileDownloadRequestBody
- * @property {string} query - Base64 encoded SQL query to execute on ClickHouse.
- * @property {boolean} [split_files] - Flag indicating whether to split the
- *   files for larger datasets.
- */
-/**
- * @typedef JobExecute
- * @property {string} query - Base64 encoded SQL query to execute on ClickHouse.
- * @property {Page} [page]
- */
-/**
- * @typedef JobExecutionResult
- * @property {Object[]} [rows] - Array of rows resulting from the job execution.
- * @property {Page} [page]
- */
-/**
- * @typedef JobStatus
- * @property {string} [start_date] - The start date and time of the job.
- * @property {string} [end_date] - The end date and time of the job.
- * @property {string} [status] - The current status of the job.
- * @property {string} [message] - Message providing additional details about the
- *   job status.
- * @property {Object[]} [file_metadata] - Metadata about files associated with
- *   the job, if any.
- */
-declare class AnalyticsPlatformModel {
-}
-declare namespace AnalyticsPlatformModel {
-    export { Page, FileDownloadRequestBody, JobExecute, JobExecutionResult, JobStatus };
-}
-/** @returns {Page} */
-declare function Page(): Page;
-type Page = {
-    /**
-     * - The total number of all items across all pages.
-     */
-    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, can be 'cursor' or 'number'.
-     */
-    type: string;
-    /**
-     * - The number of items per page.
-     */
-    size?: number;
-    /**
-     * - The number of items per page.
-     */
-    page_size?: number;
-};
-/** @returns {FileDownloadRequestBody} */
-declare function FileDownloadRequestBody(): FileDownloadRequestBody;
-type FileDownloadRequestBody = {
-    /**
-     * - Base64 encoded SQL query to execute on ClickHouse.
-     */
-    query: string;
-    /**
-     * - Flag indicating whether to split the
-     * files for larger datasets.
-     */
-    split_files?: boolean;
-};
-/** @returns {JobExecute} */
-declare function JobExecute(): JobExecute;
-type JobExecute = {
-    /**
-     * - Base64 encoded SQL query to execute on ClickHouse.
-     */
-    query: string;
-    page?: Page;
-};
-/** @returns {JobExecutionResult} */
-declare function JobExecutionResult(): JobExecutionResult;
-type JobExecutionResult = {
-    /**
-     * - Array of rows resulting from the job execution.
-     */
-    rows?: any[];
-    page?: Page;
-};
-/** @returns {JobStatus} */
-declare function JobStatus(): JobStatus;
-type JobStatus = {
-    /**
-     * - The start date and time of the job.
-     */
-    start_date?: string;
-    /**
-     * - The end date and time of the job.
-     */
-    end_date?: string;
-    /**
-     * - The current status of the job.
-     */
-    status?: string;
-    /**
-     * - Message providing additional details about the
-     * job status.
-     */
-    message?: string;
-    /**
-     * - Metadata about files associated with
-     * the job, if any.
-     */
-    file_metadata?: any[];
-};