@gofynd/fdk-client-javascript 1.4.13 → 1.4.14

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

@@ -0,0 +1,289 @@
+export = FinanceApplicationModel;
+/**
+ * @typedef CustomerCreditBalanceRequestSchema
+ * @property {CustomerCreditBalanceReqData} [data]
+ */
+/**
+ * @typedef CustomerCreditBalanceReqData
+ * @property {number} seller_id - Unique identifier for the seller requesting
+ *   the credit balance.
+ * @property {string} affiliate_id - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {string} [customer_mobile_number] - Mobile number of the customer
+ *   whose credit balance is being requested.
+ * @property {string} [customer_email] - Email of the customer whose credit
+ *   balance is being requested.
+ */
+/**
+ * @typedef CustomerCreditBalanceResponseSchema
+ * @property {boolean} [success] - Indicates whether the credit note balance
+ *   request was successful.
+ * @property {CustomerCreditBalanceResData} [data]
+ */
+/**
+ * @typedef CustomerCreditBalanceResData
+ * @property {string} [customer_mobile_number] - Mobile number of the customer
+ *   whose credit balance information is being returned.
+ * @property {string} [customer_email] - Email of the customer whose credit
+ *   balance information is being returned.
+ * @property {number} [total_credited_balance] - Total amount of credit
+ *   available to the customer.
+ * @property {number} [total_locked_amount] - Total amount of credit balance
+ *   that is currently locked and unavailable for use.
+ * @property {number} [allowed_redemption_amount] - Total amount of credit
+ *   balance that the customer is allowed to redeem.
+ */
+/**
+ * @typedef Error
+ * @property {number} [status] - The HTTP status code associated with the error.
+ * @property {string} [reason] - A brief explanation of the error.
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {string} [message] - A detailed message describing the error.
+ * @property {string} [code] - A specific code representing the error.
+ * @property {string} [exception] - The exception that caused the error.
+ * @property {string} [info] - Additional information about the error.
+ * @property {string} [request_id] - The unique identifier for the request that
+ *   caused the error.
+ * @property {string} [stack_trace] - The stack trace of the error for debugging purposes.
+ * @property {ErrorMeta} [meta]
+ */
+/**
+ * @typedef ErrorMeta
+ * @property {ErrorMetaItems[]} [columns_errors] - A list of errors related to
+ *   specific columns.
+ */
+/**
+ * @typedef ErrorMetaItems
+ * @property {number} [code] - The error code for the specific column error.
+ * @property {string} [message] - The error message for the specific column error.
+ */
+/**
+ * @typedef LockUnlockRequestData
+ * @property {number} seller_id - The unique identifier for the seller.
+ * @property {string} affiliate_id - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {string} ordering_channel - The channel through which the order was placed.
+ * @property {string} credit_note_number - A unique identifier for the credit note.
+ * @property {number} amount - The total amount of credit originally available
+ *   in the note.
+ * @property {string} request_type - Type of request for which api is called.
+ *   Either to lock credit note or unlock.
+ * @property {string} order_id - A unique identifier of the order against which
+ *   credit note is generated.
+ */
+/**
+ * @typedef LockUnlockRequestSchema
+ * @property {LockUnlockRequestData} [data]
+ */
+/**
+ * @typedef LockUnlockResponseData
+ * @property {string} [credit_note_number] - A unique identifier for the credit note.
+ * @property {number} [amount] - The total amount of credit originally available
+ *   in the note.
+ */
+/**
+ * @typedef LockUnlockResponseSchema
+ * @property {boolean} [success] - Indicates whether the credit note lock/unlock
+ *   request was successful.
+ * @property {LockUnlockResponseData} [data]
+ */
+declare class FinanceApplicationModel {
+}
+declare namespace FinanceApplicationModel {
+    export { CustomerCreditBalanceRequestSchema, CustomerCreditBalanceReqData, CustomerCreditBalanceResponseSchema, CustomerCreditBalanceResData, Error, ErrorMeta, ErrorMetaItems, LockUnlockRequestData, LockUnlockRequestSchema, LockUnlockResponseData, LockUnlockResponseSchema };
+}
+/** @returns {CustomerCreditBalanceRequestSchema} */
+declare function CustomerCreditBalanceRequestSchema(): CustomerCreditBalanceRequestSchema;
+type CustomerCreditBalanceRequestSchema = {
+    data?: CustomerCreditBalanceReqData;
+};
+/** @returns {CustomerCreditBalanceReqData} */
+declare function CustomerCreditBalanceReqData(): CustomerCreditBalanceReqData;
+type CustomerCreditBalanceReqData = {
+    /**
+     * - Unique identifier for the seller requesting
+     * the credit balance.
+     */
+    seller_id: number;
+    /**
+     * - The unique identifier of sale channels or
+     * application as affiliate_id associated with the seller.
+     */
+    affiliate_id: string;
+    /**
+     * - Mobile number of the customer
+     * whose credit balance is being requested.
+     */
+    customer_mobile_number?: string;
+    /**
+     * - Email of the customer whose credit
+     * balance is being requested.
+     */
+    customer_email?: string;
+};
+/** @returns {CustomerCreditBalanceResponseSchema} */
+declare function CustomerCreditBalanceResponseSchema(): CustomerCreditBalanceResponseSchema;
+type CustomerCreditBalanceResponseSchema = {
+    /**
+     * - Indicates whether the credit note balance
+     * request was successful.
+     */
+    success?: boolean;
+    data?: CustomerCreditBalanceResData;
+};
+/** @returns {CustomerCreditBalanceResData} */
+declare function CustomerCreditBalanceResData(): CustomerCreditBalanceResData;
+type CustomerCreditBalanceResData = {
+    /**
+     * - Mobile number of the customer
+     * whose credit balance information is being returned.
+     */
+    customer_mobile_number?: string;
+    /**
+     * - Email of the customer whose credit
+     * balance information is being returned.
+     */
+    customer_email?: string;
+    /**
+     * - Total amount of credit
+     * available to the customer.
+     */
+    total_credited_balance?: number;
+    /**
+     * - Total amount of credit balance
+     * that is currently locked and unavailable for use.
+     */
+    total_locked_amount?: number;
+    /**
+     * - Total amount of credit
+     * balance that the customer is allowed to redeem.
+     */
+    allowed_redemption_amount?: number;
+};
+/** @returns {Error} */
+declare function Error(): Error;
+type Error = {
+    /**
+     * - The HTTP status code associated with the error.
+     */
+    status?: number;
+    /**
+     * - A brief explanation of the error.
+     */
+    reason?: string;
+    /**
+     * - Indicates whether the request was successful.
+     */
+    success?: boolean;
+    /**
+     * - A detailed message describing the error.
+     */
+    message?: string;
+    /**
+     * - A specific code representing the error.
+     */
+    code?: string;
+    /**
+     * - The exception that caused the error.
+     */
+    exception?: string;
+    /**
+     * - Additional information about the error.
+     */
+    info?: string;
+    /**
+     * - The unique identifier for the request that
+     * caused the error.
+     */
+    request_id?: string;
+    /**
+     * - The stack trace of the error for debugging purposes.
+     */
+    stack_trace?: string;
+    meta?: ErrorMeta;
+};
+/** @returns {ErrorMeta} */
+declare function ErrorMeta(): ErrorMeta;
+type ErrorMeta = {
+    /**
+     * - A list of errors related to
+     * specific columns.
+     */
+    columns_errors?: ErrorMetaItems[];
+};
+/** @returns {ErrorMetaItems} */
+declare function ErrorMetaItems(): ErrorMetaItems;
+type ErrorMetaItems = {
+    /**
+     * - The error code for the specific column error.
+     */
+    code?: number;
+    /**
+     * - The error message for the specific column error.
+     */
+    message?: string;
+};
+/** @returns {LockUnlockRequestData} */
+declare function LockUnlockRequestData(): LockUnlockRequestData;
+type LockUnlockRequestData = {
+    /**
+     * - The unique identifier for the seller.
+     */
+    seller_id: number;
+    /**
+     * - The unique identifier of sale channels or
+     * application as affiliate_id associated with the seller.
+     */
+    affiliate_id: string;
+    /**
+     * - The channel through which the order was placed.
+     */
+    ordering_channel: string;
+    /**
+     * - A unique identifier for the credit note.
+     */
+    credit_note_number: string;
+    /**
+     * - The total amount of credit originally available
+     * in the note.
+     */
+    amount: number;
+    /**
+     * - Type of request for which api is called.
+     * Either to lock credit note or unlock.
+     */
+    request_type: string;
+    /**
+     * - A unique identifier of the order against which
+     * credit note is generated.
+     */
+    order_id: string;
+};
+/** @returns {LockUnlockRequestSchema} */
+declare function LockUnlockRequestSchema(): LockUnlockRequestSchema;
+type LockUnlockRequestSchema = {
+    data?: LockUnlockRequestData;
+};
+/** @returns {LockUnlockResponseData} */
+declare function LockUnlockResponseData(): LockUnlockResponseData;
+type LockUnlockResponseData = {
+    /**
+     * - A unique identifier for the credit note.
+     */
+    credit_note_number?: string;
+    /**
+     * - The total amount of credit originally available
+     * in the note.
+     */
+    amount?: number;
+};
+/** @returns {LockUnlockResponseSchema} */
+declare function LockUnlockResponseSchema(): LockUnlockResponseSchema;
+type LockUnlockResponseSchema = {
+    /**
+     * - Indicates whether the credit note lock/unlock
+     * request was successful.
+     */
+    success?: boolean;
+    data?: LockUnlockResponseData;
+};

package/sdk/application/Finance/FinanceApplicationModel.js

@@ -0,0 +1,208 @@
+const Joi = require("joi");
+
+/**
+ * @typedef CustomerCreditBalanceRequestSchema
+ * @property {CustomerCreditBalanceReqData} [data]
+ */
+
+/**
+ * @typedef CustomerCreditBalanceReqData
+ * @property {number} seller_id - Unique identifier for the seller requesting
+ *   the credit balance.
+ * @property {string} affiliate_id - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {string} [customer_mobile_number] - Mobile number of the customer
+ *   whose credit balance is being requested.
+ * @property {string} [customer_email] - Email of the customer whose credit
+ *   balance is being requested.
+ */
+
+/**
+ * @typedef CustomerCreditBalanceResponseSchema
+ * @property {boolean} [success] - Indicates whether the credit note balance
+ *   request was successful.
+ * @property {CustomerCreditBalanceResData} [data]
+ */
+
+/**
+ * @typedef CustomerCreditBalanceResData
+ * @property {string} [customer_mobile_number] - Mobile number of the customer
+ *   whose credit balance information is being returned.
+ * @property {string} [customer_email] - Email of the customer whose credit
+ *   balance information is being returned.
+ * @property {number} [total_credited_balance] - Total amount of credit
+ *   available to the customer.
+ * @property {number} [total_locked_amount] - Total amount of credit balance
+ *   that is currently locked and unavailable for use.
+ * @property {number} [allowed_redemption_amount] - Total amount of credit
+ *   balance that the customer is allowed to redeem.
+ */
+
+/**
+ * @typedef Error
+ * @property {number} [status] - The HTTP status code associated with the error.
+ * @property {string} [reason] - A brief explanation of the error.
+ * @property {boolean} [success] - Indicates whether the request was successful.
+ * @property {string} [message] - A detailed message describing the error.
+ * @property {string} [code] - A specific code representing the error.
+ * @property {string} [exception] - The exception that caused the error.
+ * @property {string} [info] - Additional information about the error.
+ * @property {string} [request_id] - The unique identifier for the request that
+ *   caused the error.
+ * @property {string} [stack_trace] - The stack trace of the error for debugging purposes.
+ * @property {ErrorMeta} [meta]
+ */
+
+/**
+ * @typedef ErrorMeta
+ * @property {ErrorMetaItems[]} [columns_errors] - A list of errors related to
+ *   specific columns.
+ */
+
+/**
+ * @typedef ErrorMetaItems
+ * @property {number} [code] - The error code for the specific column error.
+ * @property {string} [message] - The error message for the specific column error.
+ */
+
+/**
+ * @typedef LockUnlockRequestData
+ * @property {number} seller_id - The unique identifier for the seller.
+ * @property {string} affiliate_id - The unique identifier of sale channels or
+ *   application as affiliate_id associated with the seller.
+ * @property {string} ordering_channel - The channel through which the order was placed.
+ * @property {string} credit_note_number - A unique identifier for the credit note.
+ * @property {number} amount - The total amount of credit originally available
+ *   in the note.
+ * @property {string} request_type - Type of request for which api is called.
+ *   Either to lock credit note or unlock.
+ * @property {string} order_id - A unique identifier of the order against which
+ *   credit note is generated.
+ */
+
+/**
+ * @typedef LockUnlockRequestSchema
+ * @property {LockUnlockRequestData} [data]
+ */
+
+/**
+ * @typedef LockUnlockResponseData
+ * @property {string} [credit_note_number] - A unique identifier for the credit note.
+ * @property {number} [amount] - The total amount of credit originally available
+ *   in the note.
+ */
+
+/**
+ * @typedef LockUnlockResponseSchema
+ * @property {boolean} [success] - Indicates whether the credit note lock/unlock
+ *   request was successful.
+ * @property {LockUnlockResponseData} [data]
+ */
+
+class FinanceApplicationModel {
+  /** @returns {CustomerCreditBalanceRequestSchema} */
+  static CustomerCreditBalanceRequestSchema() {
+    return Joi.object({
+      data: FinanceApplicationModel.CustomerCreditBalanceReqData(),
+    });
+  }
+
+  /** @returns {CustomerCreditBalanceReqData} */
+  static CustomerCreditBalanceReqData() {
+    return Joi.object({
+      seller_id: Joi.number().required(),
+      affiliate_id: Joi.string().allow("").required(),
+      customer_mobile_number: Joi.string().allow(""),
+      customer_email: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CustomerCreditBalanceResponseSchema} */
+  static CustomerCreditBalanceResponseSchema() {
+    return Joi.object({
+      success: Joi.boolean(),
+      data: FinanceApplicationModel.CustomerCreditBalanceResData(),
+    });
+  }
+
+  /** @returns {CustomerCreditBalanceResData} */
+  static CustomerCreditBalanceResData() {
+    return Joi.object({
+      customer_mobile_number: Joi.string().allow(""),
+      customer_email: Joi.string().allow(""),
+      total_credited_balance: Joi.number(),
+      total_locked_amount: Joi.number(),
+      allowed_redemption_amount: Joi.number(),
+    });
+  }
+
+  /** @returns {Error} */
+  static Error() {
+    return Joi.object({
+      status: Joi.number(),
+      reason: Joi.string().allow(""),
+      success: Joi.boolean(),
+      message: Joi.string().allow(""),
+      code: Joi.string().allow("").allow(null),
+      exception: Joi.string().allow(""),
+      info: Joi.string().allow("").allow(null),
+      request_id: Joi.string().allow("").allow(null),
+      stack_trace: Joi.string().allow("").allow(null),
+      meta: FinanceApplicationModel.ErrorMeta(),
+    });
+  }
+
+  /** @returns {ErrorMeta} */
+  static ErrorMeta() {
+    return Joi.object({
+      columns_errors: Joi.array().items(
+        FinanceApplicationModel.ErrorMetaItems()
+      ),
+    });
+  }
+
+  /** @returns {ErrorMetaItems} */
+  static ErrorMetaItems() {
+    return Joi.object({
+      code: Joi.number().allow(null),
+      message: Joi.string().allow("").allow(null),
+    });
+  }
+
+  /** @returns {LockUnlockRequestData} */
+  static LockUnlockRequestData() {
+    return Joi.object({
+      seller_id: Joi.number().required(),
+      affiliate_id: Joi.string().allow("").required(),
+      ordering_channel: Joi.string().allow("").required(),
+      credit_note_number: Joi.string().allow("").required(),
+      amount: Joi.number().required(),
+      request_type: Joi.string().allow("").required(),
+      order_id: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {LockUnlockRequestSchema} */
+  static LockUnlockRequestSchema() {
+    return Joi.object({
+      data: FinanceApplicationModel.LockUnlockRequestData(),
+    });
+  }
+
+  /** @returns {LockUnlockResponseData} */
+  static LockUnlockResponseData() {
+    return Joi.object({
+      credit_note_number: Joi.string().allow(""),
+      amount: Joi.number(),
+    });
+  }
+
+  /** @returns {LockUnlockResponseSchema} */
+  static LockUnlockResponseSchema() {
+    return Joi.object({
+      success: Joi.boolean(),
+      data: FinanceApplicationModel.LockUnlockResponseData(),
+    });
+  }
+}
+module.exports = FinanceApplicationModel;

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

@@ -0,0 +1,25 @@
+export = FinanceApplicationValidator;
+/**
+ * @typedef CustomerCreditBalanceParam
+ * @property {FinanceApplicationModel.CustomerCreditBalanceRequestSchema} body
+ */
+/**
+ * @typedef LockUnlockCreditNoteParam
+ * @property {FinanceApplicationModel.LockUnlockRequestSchema} body
+ */
+declare class FinanceApplicationValidator {
+    /** @returns {CustomerCreditBalanceParam} */
+    static customerCreditBalance(): CustomerCreditBalanceParam;
+    /** @returns {LockUnlockCreditNoteParam} */
+    static lockUnlockCreditNote(): LockUnlockCreditNoteParam;
+}
+declare namespace FinanceApplicationValidator {
+    export { CustomerCreditBalanceParam, LockUnlockCreditNoteParam };
+}
+type CustomerCreditBalanceParam = {
+    body: FinanceApplicationModel.CustomerCreditBalanceRequestSchema;
+};
+type LockUnlockCreditNoteParam = {
+    body: FinanceApplicationModel.LockUnlockRequestSchema;
+};
+import FinanceApplicationModel = require("./FinanceApplicationModel");

package/sdk/application/Finance/FinanceApplicationValidator.js

@@ -0,0 +1,31 @@
+const Joi = require("joi");
+
+const FinanceApplicationModel = require("./FinanceApplicationModel");
+
+/**
+ * @typedef CustomerCreditBalanceParam
+ * @property {FinanceApplicationModel.CustomerCreditBalanceRequestSchema} body
+ */
+
+/**
+ * @typedef LockUnlockCreditNoteParam
+ * @property {FinanceApplicationModel.LockUnlockRequestSchema} body
+ */
+
+class FinanceApplicationValidator {
+  /** @returns {CustomerCreditBalanceParam} */
+  static customerCreditBalance() {
+    return Joi.object({
+      body: FinanceApplicationModel.CustomerCreditBalanceRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {LockUnlockCreditNoteParam} */
+  static lockUnlockCreditNote() {
+    return Joi.object({
+      body: FinanceApplicationModel.LockUnlockRequestSchema().required(),
+    }).required();
+  }
+}
+
+module.exports = FinanceApplicationValidator;

package/sdk/application/Lead/LeadApplicationClient.d.ts

@@ -55,13 +55,12 @@ declare class Lead {
      * @param {LeadApplicationValidator.SubmitCustomFormParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
-     *   Success response
+     * @returns {Promise<LeadApplicationModel.SubmitCustomFormDetails>} - Success response
      * @name submitCustomForm
      * @summary: Submits form data
      * @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
      */
-    submitCustomForm({ slug, body, requestHeaders }?: LeadApplicationValidator.SubmitCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.SubmitCustomFormResponse>;
+    submitCustomForm({ slug, body, requestHeaders }?: LeadApplicationValidator.SubmitCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.SubmitCustomFormDetails>;
 }
 import LeadApplicationValidator = require("./LeadApplicationValidator");
 import LeadApplicationModel = require("./LeadApplicationModel");

package/sdk/application/Lead/LeadApplicationClient.js

@@ -350,8 +350,7 @@ class Lead {
    * @param {LeadApplicationValidator.SubmitCustomFormParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
-   *   Success response
+   * @returns {Promise<LeadApplicationModel.SubmitCustomFormDetails>} - Success response
    * @name submitCustomForm
    * @summary: Submits form data
    * @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
@@ -406,7 +405,7 @@ class Lead {
 
     const {
       error: res_error,
-    } = LeadApplicationModel.SubmitCustomFormResponse().validate(responseData, {
+    } = LeadApplicationModel.SubmitCustomFormDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

package/sdk/application/Lead/LeadApplicationModel.d.ts

@@ -10,13 +10,13 @@ export = LeadApplicationModel;
  * @property {TicketAsset[]} [attachments] - List of all attachments related to the form.
  */
 /**
- * @typedef SubmitCustomFormResponse
+ * @typedef SubmitCustomFormDetails
  * @property {string} message - Success message for form submission.
  * @property {Ticket} [ticket]
- * @property {FormFieldResponse} [response]
+ * @property {FormFieldDetails} [response]
  */
 /**
- * @typedef FormFieldResponse
+ * @typedef FormFieldDetails
  * @property {string} [_id] - Unique identifier for a custom form response.
  * @property {number} [__v] - Version of the form.
  * @property {string} [application_id] - Unique identifier for a Sales channel.
@@ -174,7 +174,7 @@ export = LeadApplicationModel;
 declare class LeadApplicationModel {
 }
 declare namespace LeadApplicationModel {
-    export { TicketHistoryPayload, CustomFormSubmissionPayload, SubmitCustomFormResponse, FormFieldResponse, FormFieldResponseValues, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, Status, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, TicketHistory, Ticket, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
+    export { TicketHistoryPayload, CustomFormSubmissionPayload, SubmitCustomFormDetails, FormFieldDetails, FormFieldResponseValues, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, Status, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, TicketHistory, Ticket, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
 }
 /** @returns {TicketHistoryPayload} */
 declare function TicketHistoryPayload(): TicketHistoryPayload;
@@ -197,19 +197,19 @@ type CustomFormSubmissionPayload = {
      */
     attachments?: TicketAsset[];
 };
-/** @returns {SubmitCustomFormResponse} */
-declare function SubmitCustomFormResponse(): SubmitCustomFormResponse;
-type SubmitCustomFormResponse = {
+/** @returns {SubmitCustomFormDetails} */
+declare function SubmitCustomFormDetails(): SubmitCustomFormDetails;
+type SubmitCustomFormDetails = {
     /**
      * - Success message for form submission.
      */
     message: string;
     ticket?: Ticket;
-    response?: FormFieldResponse;
+    response?: FormFieldDetails;
 };
-/** @returns {FormFieldResponse} */
-declare function FormFieldResponse(): FormFieldResponse;
-type FormFieldResponse = {
+/** @returns {FormFieldDetails} */
+declare function FormFieldDetails(): FormFieldDetails;
+type FormFieldDetails = {
     /**
      * - Unique identifier for a custom form response.
      */