@gofynd/fdk-client-javascript 1.1.2 → 1.1.4

package/sdk/platform/Finance/FinancePlatformModel.d.ts

@@ -0,0 +1,51 @@
+export = FinanceModel;
+declare class FinanceModel {
+    static CreditlineDataPlatformPayload(): any;
+    static CreditlineDataPlatformRequest(): any;
+    static CreditlineDataPlatformResponse(): any;
+    static DownloadCreditDebitNote(): any;
+    static DownloadCreditDebitNoteRequest(): any;
+    static DownloadCreditDebitNoteResponse(): any;
+    static DownloadCreditDebitNoteResponseData(): any;
+    static DownloadReport(): any;
+    static DownloadReportItems(): any;
+    static DownloadReportList(): any;
+    static Error(): any;
+    static GenerateReportFilters(): any;
+    static GenerateReportJson(): any;
+    static GenerateReportMeta(): any;
+    static GenerateReportPlatform(): any;
+    static GenerateReportRequest(): any;
+    static GetAffiliate(): any;
+    static GetAffiliateResponse(): any;
+    static GetDocs(): any;
+    static GetEngineData(): any;
+    static GetEngineFilters(): any;
+    static GetEngineRequest(): any;
+    static GetEngineResponse(): any;
+    static GetReason(): any;
+    static GetReasonRequest(): any;
+    static GetReasonResponse(): any;
+    static GetReportListData(): any;
+    static GetReportListRequest(): any;
+    static InoviceListingPayloadDataFilters(): any;
+    static InvoiceListingPayloadData(): any;
+    static InvoiceListingRequest(): any;
+    static InvoiceListingResponse(): any;
+    static InvoiceListingResponseItems(): any;
+    static InvoicePdfPayloadData(): any;
+    static InvoicePdfRequest(): any;
+    static InvoicePdfResponse(): any;
+    static InvoiceTypePayloadData(): any;
+    static InvoiceTypeRequest(): any;
+    static InvoiceTypeResponse(): any;
+    static InvoiceTypeResponseItems(): any;
+    static IsCreditlinePayload(): any;
+    static IsCreditlinePlatformRequest(): any;
+    static IsCreditlinePlatformResponse(): any;
+    static Page(): any;
+    static PaymentProcessPayload(): any;
+    static PaymentProcessRequest(): any;
+    static PaymentProcessResponse(): any;
+    static UnpaidInvoiceDataItems(): any;
+}

package/sdk/platform/Finance/FinancePlatformModel.js

@@ -0,0 +1,342 @@
+const Joi = require("joi");
+
+class FinanceModel {
+  static CreditlineDataPlatformPayload() {
+    return Joi.object({
+      end_end: Joi.string().allow(""),
+      page: Joi.number(),
+      pagesize: Joi.number(),
+      seller_id: Joi.string().allow(""),
+      start_end: Joi.string().allow(""),
+    });
+  }
+  static CreditlineDataPlatformRequest() {
+    return Joi.object({
+      data: FinanceModel.CreditlineDataPlatformPayload(),
+    });
+  }
+  static CreditlineDataPlatformResponse() {
+    return Joi.object({
+      code: Joi.number(),
+      headers: Joi.array().items(Joi.string().allow("")),
+      item_count: Joi.number(),
+      items: Joi.array().items(Joi.any()),
+      message: Joi.string().allow(""),
+      page: Joi.any(),
+      show_mr: Joi.boolean(),
+    });
+  }
+  static DownloadCreditDebitNote() {
+    return Joi.object({
+      note_id: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+  static DownloadCreditDebitNoteRequest() {
+    return Joi.object({
+      data: FinanceModel.DownloadCreditDebitNote(),
+    });
+  }
+  static DownloadCreditDebitNoteResponse() {
+    return Joi.object({
+      data: Joi.array().items(
+        FinanceModel.DownloadCreditDebitNoteResponseData()
+      ),
+      success: Joi.boolean(),
+    });
+  }
+  static DownloadCreditDebitNoteResponseData() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+      pdf_s3_url: Joi.string().allow(""),
+    });
+  }
+  static DownloadReport() {
+    return Joi.object({
+      end_date: Joi.string().allow(""),
+      page: Joi.number(),
+      pagesize: Joi.number(),
+      start_date: Joi.string().allow(""),
+    });
+  }
+  static DownloadReportItems() {
+    return Joi.object({
+      end_date: Joi.string().allow(""),
+      filters: FinanceModel.GenerateReportFilters(),
+      meta: FinanceModel.GenerateReportMeta(),
+      report_id: Joi.string().allow(""),
+      start_date: Joi.string().allow(""),
+      type_of_request: Joi.string().allow(""),
+    });
+  }
+  static DownloadReportList() {
+    return Joi.object({
+      item_count: Joi.number(),
+      items: Joi.array().items(FinanceModel.DownloadReportItems()),
+      page: FinanceModel.Page(),
+    });
+  }
+  static Error() {
+    return Joi.object({
+      reason: Joi.string().allow(""),
+      success: Joi.boolean(),
+    });
+  }
+  static GenerateReportFilters() {
+    return Joi.object({
+      brand: Joi.array().items(Joi.string().allow("")),
+      channel: Joi.array().items(Joi.string().allow("")),
+      company: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+  static GenerateReportJson() {
+    return Joi.object({
+      end_date: Joi.string().allow(""),
+      headers: Joi.array().items(Joi.string().allow("")),
+      item_count: Joi.number(),
+      items: Joi.array().items(Joi.array().items(Joi.string().allow(""))),
+      page: FinanceModel.Page(),
+      start_date: Joi.string().allow(""),
+    });
+  }
+  static GenerateReportMeta() {
+    return Joi.object({
+      brand: Joi.string().allow(""),
+      channel: Joi.string().allow(""),
+      company: Joi.string().allow(""),
+    });
+  }
+  static GenerateReportPlatform() {
+    return Joi.object({
+      end_date: Joi.string().allow(""),
+      filters: FinanceModel.GenerateReportFilters(),
+      meta: FinanceModel.GenerateReportMeta(),
+      report_id: Joi.string().allow(""),
+      start_date: Joi.string().allow(""),
+    });
+  }
+  static GenerateReportRequest() {
+    return Joi.object({
+      data: FinanceModel.GenerateReportPlatform(),
+    });
+  }
+  static GetAffiliate() {
+    return Joi.object({
+      company_id: Joi.number(),
+    });
+  }
+  static GetAffiliateResponse() {
+    return Joi.object({
+      docs: Joi.array().items(Joi.any()),
+      success: Joi.boolean(),
+    });
+  }
+  static GetDocs() {
+    return Joi.object({
+      docs: Joi.array().items(Joi.any()),
+      items: Joi.array().items(Joi.any()),
+    });
+  }
+  static GetEngineData() {
+    return Joi.object({
+      filters: FinanceModel.GetEngineFilters(),
+      project: Joi.array().items(Joi.string().allow("")),
+      table_name: Joi.string().allow(""),
+    });
+  }
+  static GetEngineFilters() {
+    return Joi.object({
+      config_field: Joi.string().allow(""),
+    });
+  }
+  static GetEngineRequest() {
+    return Joi.object({
+      data: FinanceModel.GetEngineData(),
+    });
+  }
+  static GetEngineResponse() {
+    return Joi.object({
+      item_count: Joi.number(),
+      items: Joi.array().items(Joi.any()),
+      page: FinanceModel.Page(),
+      success: Joi.boolean(),
+    });
+  }
+  static GetReason() {
+    return Joi.object({
+      reason_type: Joi.string().allow(""),
+    });
+  }
+  static GetReasonRequest() {
+    return Joi.object({
+      data: FinanceModel.GetReason(),
+    });
+  }
+  static GetReasonResponse() {
+    return Joi.object({
+      data: FinanceModel.GetDocs(),
+      success: Joi.boolean(),
+    });
+  }
+  static GetReportListData() {
+    return Joi.object({
+      listing_enabled: Joi.boolean(),
+      role_name: Joi.string().allow(""),
+    });
+  }
+  static GetReportListRequest() {
+    return Joi.object({
+      data: FinanceModel.GetReportListData(),
+    });
+  }
+  static InoviceListingPayloadDataFilters() {
+    return Joi.object({
+      company_id: Joi.array().items(Joi.string().allow("")),
+      invoice_type: Joi.array().items(Joi.string().allow("")),
+      payment_status: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+  static InvoiceListingPayloadData() {
+    return Joi.object({
+      end_date: Joi.string().allow(""),
+      filters: FinanceModel.InoviceListingPayloadDataFilters(),
+      page: Joi.number(),
+      page_size: Joi.number(),
+      search: Joi.string().allow(""),
+      start_date: Joi.string().allow(""),
+    });
+  }
+  static InvoiceListingRequest() {
+    return Joi.object({
+      data: FinanceModel.InvoiceListingPayloadData(),
+    });
+  }
+  static InvoiceListingResponse() {
+    return Joi.object({
+      item_count: Joi.number(),
+      items: Joi.array().items(FinanceModel.InvoiceListingResponseItems()),
+      page: FinanceModel.Page(),
+      unpaid_invoice_data: FinanceModel.UnpaidInvoiceDataItems(),
+    });
+  }
+  static InvoiceListingResponseItems() {
+    return Joi.object({
+      amount: Joi.string().allow(""),
+      company: Joi.string().allow(""),
+      due_date: Joi.string().allow(""),
+      invoice_date: Joi.string().allow(""),
+      invoice_id: Joi.string().allow(""),
+      invoice_number: Joi.string().allow(""),
+      invoice_type: Joi.string().allow(""),
+      is_downloadable: Joi.boolean(),
+      period: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+    });
+  }
+  static InvoicePdfPayloadData() {
+    return Joi.object({
+      invoice_number: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+  static InvoicePdfRequest() {
+    return Joi.object({
+      data: FinanceModel.InvoicePdfPayloadData(),
+    });
+  }
+  static InvoicePdfResponse() {
+    return Joi.object({
+      data: Joi.array().items(Joi.string().allow("")),
+      error: Joi.array().items(Joi.string().allow("")),
+      success: Joi.boolean(),
+    });
+  }
+  static InvoiceTypePayloadData() {
+    return Joi.object({
+      is_active: Joi.boolean(),
+    });
+  }
+  static InvoiceTypeRequest() {
+    return Joi.object({
+      data: FinanceModel.InvoiceTypePayloadData(),
+    });
+  }
+  static InvoiceTypeResponse() {
+    return Joi.object({
+      invoice_type_list: Joi.array().items(
+        FinanceModel.InvoiceTypeResponseItems()
+      ),
+      payment_status_list: Joi.array().items(
+        FinanceModel.InvoiceTypeResponseItems()
+      ),
+      success: Joi.boolean(),
+    });
+  }
+  static InvoiceTypeResponseItems() {
+    return Joi.object({
+      text: Joi.string().allow(""),
+      value: Joi.string().allow(""),
+    });
+  }
+  static IsCreditlinePayload() {
+    return Joi.object({
+      seller_id: Joi.string().allow(""),
+    });
+  }
+  static IsCreditlinePlatformRequest() {
+    return Joi.object({
+      data: FinanceModel.IsCreditlinePayload(),
+    });
+  }
+  static IsCreditlinePlatformResponse() {
+    return Joi.object({
+      code: Joi.number(),
+      is_creditline_opted: Joi.boolean(),
+    });
+  }
+  static Page() {
+    return Joi.object({
+      current: Joi.number(),
+      has_next: Joi.boolean(),
+      has_previous: Joi.boolean(),
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      size: Joi.number(),
+      type: Joi.string().allow("").required(),
+    });
+  }
+  static PaymentProcessPayload() {
+    return Joi.object({
+      amount: Joi.string().allow(""),
+      currency: Joi.string().allow(""),
+      invoice_number: Joi.string().allow(""),
+      meta: Joi.any(),
+      mode_of_payment: Joi.string().allow(""),
+      platform: Joi.string().allow(""),
+      seller_id: Joi.string().allow(""),
+      source_reference: Joi.string().allow(""),
+      total_amount: Joi.string().allow(""),
+      transaction_type: Joi.string().allow(""),
+    });
+  }
+  static PaymentProcessRequest() {
+    return Joi.object({
+      data: FinanceModel.PaymentProcessPayload(),
+    });
+  }
+  static PaymentProcessResponse() {
+    return Joi.object({
+      code: Joi.number(),
+      message: Joi.string().allow(""),
+      meta: Joi.any(),
+      redirect_url: Joi.string().allow(""),
+      transaction_id: Joi.string().allow(""),
+    });
+  }
+  static UnpaidInvoiceDataItems() {
+    return Joi.object({
+      currency: Joi.string().allow(""),
+      total_unpaid_amount: Joi.number(),
+      total_unpaid_invoice_count: Joi.number(),
+    });
+  }
+}
+module.exports = FinanceModel;

package/sdk/platform/Finance/FinancePlatformValidator.d.ts

@@ -0,0 +1,16 @@
+export = FinanceValidator;
+declare class FinanceValidator {
+    static creditlineDataplatform(): any;
+    static downloadCreditDebitNote(): any;
+    static downloadReport(): any;
+    static generateReport(): any;
+    static getAffiliate(): any;
+    static getData(): any;
+    static getReason(): any;
+    static getReportList(): any;
+    static invoiceListing(): any;
+    static invoicePDF(): any;
+    static invoiceType(): any;
+    static isCreditlinePlatform(): any;
+    static paymentProcess(): any;
+}

package/sdk/platform/Finance/FinancePlatformValidator.js

@@ -0,0 +1,84 @@
+const Joi = require("joi");
+
+const FinanceModel = require("./FinancePlatformModel");
+class FinanceValidator {
+  static creditlineDataplatform() {
+    return Joi.object({
+      body: FinanceModel.CreditlineDataPlatformRequest().required(),
+    }).required();
+  }
+
+  static downloadCreditDebitNote() {
+    return Joi.object({
+      body: FinanceModel.DownloadCreditDebitNoteRequest().required(),
+    }).required();
+  }
+
+  static downloadReport() {
+    return Joi.object({
+      body: FinanceModel.DownloadReport().required(),
+    }).required();
+  }
+
+  static generateReport() {
+    return Joi.object({
+      body: FinanceModel.GenerateReportRequest().required(),
+    }).required();
+  }
+
+  static getAffiliate() {
+    return Joi.object({
+      body: FinanceModel.GetAffiliate().required(),
+    }).required();
+  }
+
+  static getData() {
+    return Joi.object({
+      body: FinanceModel.GetEngineRequest().required(),
+    }).required();
+  }
+
+  static getReason() {
+    return Joi.object({
+      body: FinanceModel.GetReasonRequest().required(),
+    }).required();
+  }
+
+  static getReportList() {
+    return Joi.object({
+      body: FinanceModel.GetReportListRequest().required(),
+    }).required();
+  }
+
+  static invoiceListing() {
+    return Joi.object({
+      body: FinanceModel.InvoiceListingRequest().required(),
+    }).required();
+  }
+
+  static invoicePDF() {
+    return Joi.object({
+      body: FinanceModel.InvoicePdfRequest().required(),
+    }).required();
+  }
+
+  static invoiceType() {
+    return Joi.object({
+      body: FinanceModel.InvoiceTypeRequest().required(),
+    }).required();
+  }
+
+  static isCreditlinePlatform() {
+    return Joi.object({
+      body: FinanceModel.IsCreditlinePlatformRequest().required(),
+    }).required();
+  }
+
+  static paymentProcess() {
+    return Joi.object({
+      body: FinanceModel.PaymentProcessRequest().required(),
+    }).required();
+  }
+}
+
+module.exports = FinanceValidator;

package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts

@@ -5,7 +5,17 @@ declare class Order {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.shipmentId -
+     * @param {string} arg.action -
+     * @returns {Promise<ShipmentReasonsResponse>} - Success response
+     * @summary: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
+     * @description: Using action, get reasons behind full or partial cancellation of a shipment
+     */
+    getPlatformShipmentReasons({ action }?: {
+        action: string;
+    }): Promise<ShipmentReasonsResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.shipmentId - Shipment Id
      * @returns {Promise<PlatformShipmentTrack>} - Success response
      * @summary: Track shipment
      * @description: Track Shipment by shipment id, for application based on application Id

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -14,7 +14,71 @@ class Order {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.shipmentId -
+   * @param {string} arg.action -
+   * @returns {Promise<ShipmentReasonsResponse>} - Success response
+   * @summary: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
+   * @description: Using action, get reasons behind full or partial cancellation of a shipment
+   */
+  async getPlatformShipmentReasons({ action } = {}) {
+    const { error } = OrderValidator.getPlatformShipmentReasons().validate(
+      {
+        action,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderValidator.getPlatformShipmentReasons().validate(
+      {
+        action,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getPlatformShipmentReasons",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/order/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/reasons/${action}`,
+      query_params,
+      undefined
+    );
+
+    const {
+      error: res_error,
+    } = OrderModel.ShipmentReasonsResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getPlatformShipmentReasons",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.shipmentId - Shipment Id
    * @returns {Promise<PlatformShipmentTrack>} - Success response
    * @summary: Track shipment
    * @description: Track Shipment by shipment id, for application based on application Id
@@ -50,7 +114,7 @@ class Order {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/${shipmentId}/track`,
+      `/service/platform/order/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/${shipmentId}/track`,
       query_params,
       undefined
     );

package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts

@@ -1,4 +1,5 @@
 export = OrderValidator;
 declare class OrderValidator {
+    static getPlatformShipmentReasons(): any;
     static trackShipmentPlatform(): any;
 }

package/sdk/platform/Order/OrderPlatformApplicationValidator.js

@@ -2,6 +2,12 @@ const Joi = require("joi");
 
 const OrderModel = require("./OrderPlatformModel");
 class OrderValidator {
+  static getPlatformShipmentReasons() {
+    return Joi.object({
+      action: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static trackShipmentPlatform() {
     return Joi.object({
       shipmentId: Joi.string().allow("").required(),