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

package/sdk/public/Webhook/WebhookPublicValidator.js

@@ -13,12 +13,12 @@ const WebhookPublicModel = require("./WebhookPublicModel");
 
 /**
  * @typedef TestHandlerTransformationParam
- * @property {WebhookPublicModel.TransformEventPayload} body
+ * @property {WebhookPublicModel.TransformEventRequest} body
  */
 
 /**
  * @typedef ValidateSchemaParam
- * @property {WebhookPublicModel.ValidateSchemaPayload} body
+ * @property {WebhookPublicModel.ValidateSchemaRequest} body
  */
 
 class WebhookPublicValidator {
@@ -42,14 +42,14 @@ class WebhookPublicValidator {
   /** @returns {TestHandlerTransformationParam} */
   static testHandlerTransformation() {
     return Joi.object({
-      body: WebhookPublicModel.TransformEventPayload().required(),
+      body: WebhookPublicModel.TransformEventRequest().required(),
     }).required();
   }
 
   /** @returns {ValidateSchemaParam} */
   static validateSchema() {
     return Joi.object({
-      body: WebhookPublicModel.ValidateSchemaPayload().required(),
+      body: WebhookPublicModel.ValidateSchemaRequest().required(),
     }).required();
   }
 }

package/sdk/public/index.d.ts

@@ -1,7 +1,7 @@
 export const PublicConfig: typeof import("./PublicConfig");
 export const PublicClient: typeof import("./PublicClient");
 export namespace PublicModel {
-    const CatalogPublicModel: typeof import("./Catalog/CatalogPublicModel");
+    const BillingPublicModel: typeof import("./Billing/BillingPublicModel");
     const ConfigurationPublicModel: typeof import("./Configuration/ConfigurationPublicModel");
     const ContentPublicModel: typeof import("./Content/ContentPublicModel");
     const PartnerPublicModel: typeof import("./Partner/PartnerPublicModel");

package/sdk/public/index.js

@@ -2,7 +2,7 @@ module.exports = {
   PublicConfig: require("./PublicConfig"),
   PublicClient: require("./PublicClient"),
   PublicModel: {
-    CatalogPublicModel: require("./Catalog/CatalogPublicModel"),
+    BillingPublicModel: require("./Billing/BillingPublicModel"),
 
     ConfigurationPublicModel: require("./Configuration/ConfigurationPublicModel"),
 

package/sdk/application/Finance/FinanceApplicationClient.d.ts

@@ -1,29 +0,0 @@
-export = Finance;
-declare class Finance {
-    constructor(_conf: any);
-    _conf: any;
-    _relativeUrls: {
-        customerCreditBalance: string;
-        lockUnlockCreditNote: string;
-    };
-    _urls: {};
-    updateUrls(urls: any): void;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
-     * @name customerCreditBalance
-     * @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
-     * @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
-     */
-    customerCreditBalance({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomerCreditBalanceResponseSchema>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<LockUnlockResponseSchema>} - Success response
-     * @name lockUnlockCreditNote
-     * @summary: Lock or Unlock requested credit note.
-     * @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
-     */
-    lockUnlockCreditNote({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LockUnlockResponseSchema>;
-}

package/sdk/application/Finance/FinanceApplicationClient.js

@@ -1,126 +0,0 @@
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-
-const ApplicationAPIClient = require("../ApplicationAPIClient");
-const constructUrl = require("../constructUrl");
-const Paginator = require("../../common/Paginator");
-
-class Finance {
-  constructor(_conf) {
-    this._conf = _conf;
-    this._relativeUrls = {
-      customerCreditBalance:
-        "/service/application/finance/v1.0/customer-credit-balance",
-      lockUnlockCreditNote:
-        "/service/application/finance/v1.0/lock-unlock-credit-note",
-    };
-    this._urls = Object.entries(this._relativeUrls).reduce(
-      (urls, [method, relativeUrl]) => {
-        urls[method] = `${_conf.domain}${relativeUrl}`;
-        return urls;
-      },
-      {}
-    );
-  }
-
-  updateUrls(urls) {
-    this._urls = {
-      ...this._urls,
-      ...urls,
-    };
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
-   * @name customerCreditBalance
-   * @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
-   * @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
-   */
-  async customerCreditBalance(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["customerCreditBalance"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<LockUnlockResponseSchema>} - Success response
-   * @name lockUnlockCreditNote
-   * @summary: Lock or Unlock requested credit note.
-   * @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
-   */
-  async lockUnlockCreditNote(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["lockUnlockCreditNote"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-}
-
-module.exports = Finance;

package/sdk/public/Catalog/CatalogPublicClient.d.ts

@@ -1,22 +0,0 @@
-export = Catalog;
-declare class Catalog {
-    constructor(_conf: any);
-    _conf: any;
-    _relativeUrls: {
-        getTaxonomyByLevel: string;
-    };
-    _urls: {};
-    updateUrls(urls: any): void;
-    /**
-     * @param {CatalogPublicValidator.GetTaxonomyByLevelParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<CatalogPublicModel.TaxonomyResponseSchema>} - Success response
-     * @name getTaxonomyByLevel
-     * @summary: Get Taxonomy Information by Level
-     * @description: Get Taxonomy Details for a given level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/catalog/getTaxonomyByLevel/).
-     */
-    getTaxonomyByLevel({ level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders }?: CatalogPublicValidator.GetTaxonomyByLevelParam, { responseHeaders }?: object): Promise<CatalogPublicModel.TaxonomyResponseSchema>;
-}
-import CatalogPublicValidator = require("./CatalogPublicValidator");
-import CatalogPublicModel = require("./CatalogPublicModel");

package/sdk/public/Catalog/CatalogPublicClient.js

@@ -1,138 +0,0 @@
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-
-const PublicAPIClient = require("../PublicAPIClient");
-const constructUrl = require("../constructUrl");
-const Paginator = require("../../common/Paginator");
-
-const CatalogPublicValidator = require("./CatalogPublicValidator");
-const CatalogPublicModel = require("./CatalogPublicModel");
-const Joi = require("joi");
-const { Logger } = require("./../../common/Logger");
-
-class Catalog {
-  constructor(_conf) {
-    this._conf = _conf;
-    this._relativeUrls = {
-      getTaxonomyByLevel: "/service/public/catalog/v1.0/taxonomy/level/{level}",
-    };
-    this._urls = Object.entries(this._relativeUrls).reduce(
-      (urls, [method, relativeUrl]) => {
-        urls[method] = `${_conf.domain}${relativeUrl}`;
-        return urls;
-      },
-      {}
-    );
-  }
-
-  updateUrls(urls) {
-    this._urls = {
-      ...this._urls,
-      ...urls,
-    };
-  }
-
-  /**
-   * @param {CatalogPublicValidator.GetTaxonomyByLevelParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<CatalogPublicModel.TaxonomyResponseSchema>} - Success response
-   * @name getTaxonomyByLevel
-   * @summary: Get Taxonomy Information by Level
-   * @description: Get Taxonomy Details for a given level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/catalog/getTaxonomyByLevel/).
-   */
-  async getTaxonomyByLevel(
-    { level, l0Slug, l1Slug, l2Slug, l3Slug, limit, requestHeaders } = {
-      requestHeaders: {},
-    },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-
-    if (!level) {
-      invalidInput.push({
-        message: `The 'level' field is required.`,
-        path: ["level"],
-      });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const { error } = CatalogPublicValidator.getTaxonomyByLevel().validate(
-      { level, l0Slug, l1Slug, l2Slug, l3Slug, limit },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = CatalogPublicValidator.getTaxonomyByLevel().validate(
-      { level, l0Slug, l1Slug, l2Slug, l3Slug, limit },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for public > Catalog > getTaxonomyByLevel \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["l0_slug"] = l0Slug;
-    query_params["l1_slug"] = l1Slug;
-    query_params["l2_slug"] = l2Slug;
-    query_params["l3_slug"] = l3Slug;
-    query_params["limit"] = limit;
-
-    const xHeaders = {};
-
-    const response = await PublicAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getTaxonomyByLevel"],
-        params: { level },
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = CatalogPublicModel.TaxonomyResponseSchema().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this._conf.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for public > Catalog > getTaxonomyByLevel \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-}
-
-module.exports = Catalog;

package/sdk/public/Catalog/CatalogPublicModel.d.ts

@@ -1,155 +0,0 @@
-export = CatalogPublicModel;
-/**
- * @typedef TaxonomyItemAttributeSchemaObject
- * @property {string} [type] - The data type of the attribute".
- * @property {boolean} [mandatory] - Specifies if the attribute is mandatory.
- */
-/**
- * @typedef TaxonomyItemAttributesResponseSchema
- * @property {string} [id] - Unique identifier for the attribute.
- * @property {string} [name] - The name of the attribute, such as "Color" or "Size".
- * @property {string} [slug] - A URL-friendly identifier for the attribute,
- *   which is used for filtering or querying.
- * @property {TaxonomyItemAttributeSchemaObject} [schema]
- */
-/**
- * @typedef TaxonomyItemResponseSchema
- * @property {number} uid - Unique identifier for the taxonomy item.
- * @property {string} name - The name of the taxonomy item. For example, it
- *   could be the name of a department or category.
- * @property {string} slug - A URL-friendly identifier for the taxonomy item.
- *   The slug differs based on the level: - At level 0, it refers to the
- *   department. - At level 1, it refers to the L1 category. - At level 2, it
- *   refers to the L2 category. - At level 3, it refers to the L3 category.
- * @property {number} level - The level level of the taxonomy item in the
- *   hierarchy: - 0: Department - 1: L1 category - 2: L2 category - 3: L3 category
- * @property {TaxonomyItemAttributesResponseSchema[]} [attributes] - A list of
- *   attributes associated with the taxonomy item, such as color or size. These
- *   attributes may differ depending on the level of the taxonomy.
- * @property {string} [product_template_slug] - A slug identifier for the
- *   template associated with this taxonomy item. It links the taxonomy to a
- *   specific product template.
- * @property {string} [product_template_name] - A Name for the template
- *   associated with this taxonomy item. It links the taxonomy to a specific
- *   product template.
- */
-/**
- * @typedef TaxonomyResponseSchema
- * @property {TaxonomyItemResponseSchema[]} [items] - List of taxonomy items for
- *   the requested level level. Each item represents a taxonomy node with
- *   details about its category, attributes, and associated template.
- */
-/**
- * @typedef ValidationErrors
- * @property {ValidationError[]} errors
- */
-/**
- * @typedef ValidationError
- * @property {string} message - A brief description of the error encountered.
- * @property {string} field - The field in the request that caused the error.
- */
-declare class CatalogPublicModel {
-}
-declare namespace CatalogPublicModel {
-    export { TaxonomyItemAttributeSchemaObject, TaxonomyItemAttributesResponseSchema, TaxonomyItemResponseSchema, TaxonomyResponseSchema, ValidationErrors, ValidationError };
-}
-/** @returns {TaxonomyItemAttributeSchemaObject} */
-declare function TaxonomyItemAttributeSchemaObject(): TaxonomyItemAttributeSchemaObject;
-type TaxonomyItemAttributeSchemaObject = {
-    /**
-     * - The data type of the attribute".
-     */
-    type?: string;
-    /**
-     * - Specifies if the attribute is mandatory.
-     */
-    mandatory?: boolean;
-};
-/** @returns {TaxonomyItemAttributesResponseSchema} */
-declare function TaxonomyItemAttributesResponseSchema(): TaxonomyItemAttributesResponseSchema;
-type TaxonomyItemAttributesResponseSchema = {
-    /**
-     * - Unique identifier for the attribute.
-     */
-    id?: string;
-    /**
-     * - The name of the attribute, such as "Color" or "Size".
-     */
-    name?: string;
-    /**
-     * - A URL-friendly identifier for the attribute,
-     * which is used for filtering or querying.
-     */
-    slug?: string;
-    schema?: TaxonomyItemAttributeSchemaObject;
-};
-/** @returns {TaxonomyItemResponseSchema} */
-declare function TaxonomyItemResponseSchema(): TaxonomyItemResponseSchema;
-type TaxonomyItemResponseSchema = {
-    /**
-     * - Unique identifier for the taxonomy item.
-     */
-    uid: number;
-    /**
-     * - The name of the taxonomy item. For example, it
-     * could be the name of a department or category.
-     */
-    name: string;
-    /**
-     * - A URL-friendly identifier for the taxonomy item.
-     * The slug differs based on the level: - At level 0, it refers to the
-     * department. - At level 1, it refers to the L1 category. - At level 2, it
-     * refers to the L2 category. - At level 3, it refers to the L3 category.
-     */
-    slug: string;
-    /**
-     * - The level level of the taxonomy item in the
-     * hierarchy: - 0: Department - 1: L1 category - 2: L2 category - 3: L3 category
-     */
-    level: number;
-    /**
-     * - A list of
-     * attributes associated with the taxonomy item, such as color or size. These
-     * attributes may differ depending on the level of the taxonomy.
-     */
-    attributes?: TaxonomyItemAttributesResponseSchema[];
-    /**
-     * - A slug identifier for the
-     * template associated with this taxonomy item. It links the taxonomy to a
-     * specific product template.
-     */
-    product_template_slug?: string;
-    /**
-     * - A Name for the template
-     * associated with this taxonomy item. It links the taxonomy to a specific
-     * product template.
-     */
-    product_template_name?: string;
-};
-/** @returns {TaxonomyResponseSchema} */
-declare function TaxonomyResponseSchema(): TaxonomyResponseSchema;
-type TaxonomyResponseSchema = {
-    /**
-     * - List of taxonomy items for
-     * the requested level level. Each item represents a taxonomy node with
-     * details about its category, attributes, and associated template.
-     */
-    items?: TaxonomyItemResponseSchema[];
-};
-/** @returns {ValidationErrors} */
-declare function ValidationErrors(): ValidationErrors;
-type ValidationErrors = {
-    errors: ValidationError[];
-};
-/** @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;
-};

package/sdk/public/Catalog/CatalogPublicModel.js

@@ -1,116 +0,0 @@
-const Joi = require("joi");
-
-/**
- * @typedef TaxonomyItemAttributeSchemaObject
- * @property {string} [type] - The data type of the attribute".
- * @property {boolean} [mandatory] - Specifies if the attribute is mandatory.
- */
-
-/**
- * @typedef TaxonomyItemAttributesResponseSchema
- * @property {string} [id] - Unique identifier for the attribute.
- * @property {string} [name] - The name of the attribute, such as "Color" or "Size".
- * @property {string} [slug] - A URL-friendly identifier for the attribute,
- *   which is used for filtering or querying.
- * @property {TaxonomyItemAttributeSchemaObject} [schema]
- */
-
-/**
- * @typedef TaxonomyItemResponseSchema
- * @property {number} uid - Unique identifier for the taxonomy item.
- * @property {string} name - The name of the taxonomy item. For example, it
- *   could be the name of a department or category.
- * @property {string} slug - A URL-friendly identifier for the taxonomy item.
- *   The slug differs based on the level: - At level 0, it refers to the
- *   department. - At level 1, it refers to the L1 category. - At level 2, it
- *   refers to the L2 category. - At level 3, it refers to the L3 category.
- * @property {number} level - The level level of the taxonomy item in the
- *   hierarchy: - 0: Department - 1: L1 category - 2: L2 category - 3: L3 category
- * @property {TaxonomyItemAttributesResponseSchema[]} [attributes] - A list of
- *   attributes associated with the taxonomy item, such as color or size. These
- *   attributes may differ depending on the level of the taxonomy.
- * @property {string} [product_template_slug] - A slug identifier for the
- *   template associated with this taxonomy item. It links the taxonomy to a
- *   specific product template.
- * @property {string} [product_template_name] - A Name for the template
- *   associated with this taxonomy item. It links the taxonomy to a specific
- *   product template.
- */
-
-/**
- * @typedef TaxonomyResponseSchema
- * @property {TaxonomyItemResponseSchema[]} [items] - List of taxonomy items for
- *   the requested level level. Each item represents a taxonomy node with
- *   details about its category, attributes, and associated template.
- */
-
-/**
- * @typedef ValidationErrors
- * @property {ValidationError[]} errors
- */
-
-/**
- * @typedef ValidationError
- * @property {string} message - A brief description of the error encountered.
- * @property {string} field - The field in the request that caused the error.
- */
-
-class CatalogPublicModel {
-  /** @returns {TaxonomyItemAttributeSchemaObject} */
-  static TaxonomyItemAttributeSchemaObject() {
-    return Joi.object({
-      type: Joi.string().allow(""),
-      mandatory: Joi.boolean(),
-    });
-  }
-
-  /** @returns {TaxonomyItemAttributesResponseSchema} */
-  static TaxonomyItemAttributesResponseSchema() {
-    return Joi.object({
-      id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      slug: Joi.string().allow(""),
-      schema: CatalogPublicModel.TaxonomyItemAttributeSchemaObject(),
-    });
-  }
-
-  /** @returns {TaxonomyItemResponseSchema} */
-  static TaxonomyItemResponseSchema() {
-    return Joi.object({
-      uid: Joi.number().required(),
-      name: Joi.string().allow("").required(),
-      slug: Joi.string().allow("").required(),
-      level: Joi.number().required(),
-      attributes: Joi.array().items(
-        CatalogPublicModel.TaxonomyItemAttributesResponseSchema()
-      ),
-      product_template_slug: Joi.string().allow(""),
-      product_template_name: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {TaxonomyResponseSchema} */
-  static TaxonomyResponseSchema() {
-    return Joi.object({
-      items: Joi.array().items(CatalogPublicModel.TaxonomyItemResponseSchema()),
-    });
-  }
-
-  /** @returns {ValidationErrors} */
-  static ValidationErrors() {
-    return Joi.object({
-      errors: Joi.array()
-        .items(CatalogPublicModel.ValidationError())
-        .required(),
-    });
-  }
-
-  /** @returns {ValidationError} */
-  static ValidationError() {
-    return Joi.object({
-      message: Joi.string().allow("").required(),
-      field: Joi.string().allow("").required(),
-    });
-  }
-}
-module.exports = CatalogPublicModel;