@gofynd/fdk-client-javascript 1.1.0 → 1.1.1

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

@@ -2,26 +2,6 @@ export = Order;
 declare class Order {
     constructor(config: any);
     config: any;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.batchId -
-     * @returns {Promise<BulkActionDetailsResponse>} - Success response
-     * @summary: Returns failed, processing and successfully processed shipments.
-     * @description: Returns failed, processing and successfully processed shipments along with their counts and failed reasons.
-     */
-    bulkActionDetails({ batchId }?: {
-        batchId: string;
-    }): Promise<BulkActionDetailsResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {BulkActionPayload} arg.body
-     * @returns {Promise<BulkActionResponse>} - Success response
-     * @summary: emits uuid to kafka topic.
-     * @description: Use this API to start processing Xlsx file.
-     */
-    bulkActionProcessXlsxFile({ body }?: {
-        body: BulkActionPayload;
-    }): Promise<BulkActionResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {OrderStatus} arg.body
@@ -34,21 +14,21 @@ declare class Order {
     }): Promise<OrderStatusResult>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.caller -
-     * @param {string} arg.receiver -
-     * @param {string} arg.bagId -
-     * @param {string} [arg.callingTo] -
-     * @param {string} [arg.callerId] -
+     * @param {string} arg.caller - Call Number
+     * @param {string} arg.receiver - Receiver Number
+     * @param {string} arg.bagId - Bag Id for the query
+     * @param {string} [arg.callerId] - Caller Id
+     * @param {string} [arg.method] - Provider Method to Call
      * @returns {Promise<Click2CallResponse>} - Success response
      * @summary:
      * @description:
      */
-    click2Call({ caller, receiver, bagId, callingTo, callerId, }?: {
+    click2Call({ caller, receiver, bagId, callerId, method, }?: {
         caller: string;
         receiver: string;
         bagId: string;
-        callingTo?: string;
         callerId?: string;
+        method?: string;
     }): Promise<Click2CallResponse>;
     /**
      * @param {Object} arg - Arg object.
@@ -70,18 +50,6 @@ declare class Order {
     createOrder({ body }?: {
         body: CreateOrderAPI;
     }): Promise<CreateOrderResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @returns {Promise<Success>} - Success response
-     * @summary:
-     * @description:
-     */
-    createShipmentReport({ fromDate, toDate }?: {
-        fromDate?: string;
-        toDate?: string;
-    }): Promise<Success>;
     /**
      * @param {Object} arg - Arg object.
      * @param {DispatchManifest} arg.body
@@ -94,7 +62,18 @@ declare class Order {
     }): Promise<SuccessResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.date] -
+     * @param {string} [arg.templateSlug] - Slug name of template to be downloaded
+     * @returns {Promise<FileResponse>} - Success response
+     * @summary:
+     * @description:
+     */
+    downloadBulkActionTemplate({ templateSlug }?: {
+        templateSlug?: string;
+    }): Promise<FileResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.date] - Date On which the announcement is Active
+     *   (Date should in ISO Datetime format IST Time)
      * @returns {Promise<AnnouncementsResponse>} - Success response
      * @summary:
      * @description:
@@ -144,109 +123,42 @@ declare class Order {
     }): Promise<GetBagsPlatformResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.batchId -
-     * @param {string} [arg.reportType] -
-     * @returns {Promise<FileResponse>} - Success response
-     * @summary:
-     * @description:
-     */
-    getBulkActionFailedReport({ batchId, reportType }?: {
-        batchId: string;
-        reportType?: string;
-    }): Promise<FileResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.batchId -
-     * @param {string} arg.docType -
-     * @returns {Promise<BulkInvoicingResponse>} - Success response
-     * @summary:
-     * @description:
-     */
-    getBulkInvoice({ batchId, docType }?: {
-        batchId: string;
-        docType: string;
-    }): Promise<BulkInvoicingResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.batchId -
-     * @returns {Promise<BulkInvoiceLabelResponse>} - Success response
-     * @summary:
-     * @description:
-     */
-    getBulkInvoiceLabel({ batchId }?: {
-        batchId: string;
-    }): Promise<BulkInvoiceLabelResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.lane] -
-     * @param {string} [arg.searchType] -
-     * @param {string} [arg.searchId] -
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @param {string} [arg.dpIds] -
-     * @param {string} [arg.orderingCompanyId] -
-     * @param {string} [arg.stores] -
-     * @param {string} [arg.salesChannel] -
-     * @param {string} [arg.requestByExt] -
-     * @param {number} [arg.pageNo] -
-     * @param {number} [arg.pageSize] -
-     * @param {string} [arg.customerId] -
-     * @param {boolean} [arg.isPrioritySort] -
-     * @returns {Promise<BulkListingResponse>} - Success response
+     * @returns {Promise<BulkActionTemplateResponse>} - Success response
      * @summary:
      * @description:
      */
-    getBulkList({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
-        lane?: string;
-        searchType?: string;
-        searchId?: string;
-        fromDate?: string;
-        toDate?: string;
-        dpIds?: string;
-        orderingCompanyId?: string;
-        stores?: string;
-        salesChannel?: string;
-        requestByExt?: string;
-        pageNo?: number;
-        pageSize?: number;
-        customerId?: string;
-        isPrioritySort?: boolean;
-    }): Promise<BulkListingResponse>;
+    getBulkActionTemplate({}?: any): Promise<BulkActionTemplateResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} [arg.lane] -
-     * @param {string} [arg.searchType] -
-     * @param {string} [arg.searchId] -
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @param {string} [arg.dpIds] -
-     * @param {string} [arg.orderingCompanyId] -
-     * @param {string} [arg.stores] -
-     * @param {string} [arg.salesChannel] -
-     * @param {string} [arg.requestByExt] -
+     * @param {string} [arg.salesChannels] - Comma seperated values of sales channel ids
+     * @param {string} [arg.dpIds] - Comma seperated values of delivery partner ids
+     * @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
+     * @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
+     * @param {string} [arg.stores] - Comma seperated values of store ids
+     * @param {string} [arg.tags] - Comma seperated values of tags
+     * @param {string} [arg.bagStatus] - Comma seperated values of bag statuses
+     * @param {string} [arg.paymentMethods] - Comma seperated values of payment methods
+     * @param {string} [arg.fileType] - File type to be downloaded
+     * @param {number} [arg.timeToDispatch] - Sla breached or not breached
      * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
-     * @param {string} [arg.customerId] -
-     * @param {boolean} [arg.isPrioritySort] -
      * @returns {Promise<FileResponse>} - Success response
      * @summary:
      * @description:
      */
-    getBulkShipmentExcelFile({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, }?: {
-        lane?: string;
-        searchType?: string;
-        searchId?: string;
+    getBulkShipmentExcelFile({ salesChannels, dpIds, fromDate, toDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, }?: {
+        salesChannels?: string;
+        dpIds?: string;
         fromDate?: string;
         toDate?: string;
-        dpIds?: string;
-        orderingCompanyId?: string;
         stores?: string;
-        salesChannel?: string;
-        requestByExt?: string;
+        tags?: string;
+        bagStatus?: string;
+        paymentMethods?: string;
+        fileType?: string;
+        timeToDispatch?: number;
         pageNo?: number;
         pageSize?: number;
-        customerId?: string;
-        isPrioritySort?: boolean;
     }): Promise<FileResponse>;
     /**
      * @param {Object} arg - Arg object.
@@ -281,18 +193,6 @@ declare class Order {
         paymentMode?: string;
         bagStatus?: string;
     }): Promise<LaneConfigResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.fromDate] -
-     * @param {string} [arg.toDate] -
-     * @returns {Promise<MetricCountResponse>} - Success response
-     * @summary:
-     * @description:
-     */
-    getMetricCount({ fromDate, toDate }?: {
-        fromDate?: string;
-        toDate?: string;
-    }): Promise<MetricCountResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId -
@@ -343,18 +243,6 @@ declare class Order {
         isPrioritySort?: boolean;
         customMeta?: string;
     }): Promise<OrderListingResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] -
-     * @param {number} [arg.pageSize] -
-     * @returns {Promise<OmsReports>} - Success response
-     * @summary:
-     * @description:
-     */
-    getReportsShipmentListing({ pageNo, pageSize }?: {
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<OmsReports>;
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<GetActionsResponse>} - Success response
@@ -380,14 +268,14 @@ declare class Order {
     }): Promise<ShipmentInfoResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} [arg.shipmentId] -
-     * @param {number} [arg.bagId] -
+     * @param {string} [arg.shipmentId] - Shipment Id
+     * @param {number} [arg.bagId] - Bag/Product Id
      * @returns {Promise<ShipmentHistoryResponse>} - Success response
      * @summary:
      * @description:
      */
     getShipmentHistory({ shipmentId, bagId }?: {
-        shipmentId?: number;
+        shipmentId?: string;
         bagId?: number;
     }): Promise<ShipmentHistoryResponse>;
     /**
@@ -463,6 +351,13 @@ declare class Order {
         orderingChannel?: string;
         companyAffiliateTag?: string;
     }): Promise<ShipmentInternalPlatformViewResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<BagStateTransitionMap>} - Success response
+     * @summary:
+     * @description:
+     */
+    getStateTransitionMap({}?: any): Promise<BagStateTransitionMap>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.view -
@@ -495,16 +390,6 @@ declare class Order {
     orderUpdate({ body }?: {
         body: PlatformOrderUpdate;
     }): Promise<ResponseDetail>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {ManualAssignDPToShipment} arg.body
-     * @returns {Promise<ManualAssignDPToShipmentResponse>} - Success response
-     * @summary:
-     * @description:
-     */
-    platformManualAssignDPToShipment({ body }?: {
-        body: ManualAssignDPToShipment;
-    }): Promise<ManualAssignDPToShipmentResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {PostShipmentHistory} arg.body
@@ -545,13 +430,6 @@ declare class Order {
     sendSmsNinja({ body }?: {
         body: SendSmsPayload;
     }): Promise<OrderStatusResult>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<OrderStatusResult>} - Success response
-     * @summary:
-     * @description:
-     */
-    sendSmsNinjaPlatform({}?: any): Promise<OrderStatusResult>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.shipmentId -
@@ -599,7 +477,7 @@ declare class Order {
      * @param {UpdateShipmentLockPayload} arg.body
      * @returns {Promise<UpdateShipmentLockResponse>} - Success response
      * @summary:
-     * @description: update shipment lock
+     * @description: update shipment/bag lock and check status
      */
     updateShipmentLock({ body }?: {
         body: UpdateShipmentLockPayload;
@@ -609,7 +487,7 @@ declare class Order {
      * @param {UpdateShipmentStatusRequest} arg.body
      * @returns {Promise<UpdateShipmentStatusResponseBody>} - Success response
      * @summary:
-     * @description: Update shipment status
+     * @description: This API is for Shipment State transition or Shipment data update or both below example is for partial state transition with data update
      */
     updateShipmentStatus({ body }?: {
         body: UpdateShipmentStatusRequest;
@@ -624,14 +502,4 @@ declare class Order {
     uploadConsent({ body }?: {
         body: UploadConsent;
     }): Promise<SuccessResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {JioCodeUpsertPayload} arg.body
-     * @returns {Promise<JioCodeUpsertResponse>} - Success response
-     * @summary:
-     * @description:
-     */
-    upsertJioCode({ body }?: {
-        body: JioCodeUpsertPayload;
-    }): Promise<JioCodeUpsertResponse>;
 }