octopian-apis 1.0.60 → 1.0.61

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "octopian-apis",
3
- "version": "1.0.60",
3
+ "version": "1.0.61",
4
4
  "description": "Transaction APIs SDK that implements Octopian Services which will be used for any node project typescript or javascript",
5
5
  "main": "./src/index.js",
6
6
  "scripts": {
@@ -1097,6 +1097,44 @@ export async function MaintainRequestAttributeList(
1097
1097
  );
1098
1098
  return APIResponse;
1099
1099
  }
1100
+
1101
+ /**
1102
+ * @description
1103
+ * Maintains the request steps.
1104
+ *
1105
+ * @param {object} MaintainRequestStepListDTO
1106
+ * An object containing fields necessary for maintaining the request steps.
1107
+ * DynamicSteps : DynamicStep[]
1108
+ * RequestId : number
1109
+ *
1110
+ * @param {string} AuthToken
1111
+ * Authentication token for authorization purposes.
1112
+ *
1113
+ * @param {number} Timeout
1114
+ * Time in milliseconds to wait before the request times out. Default is 30000.
1115
+ *
1116
+ * @returns
1117
+ * An object containing the response from the Maintain Request Step List request, including
1118
+ * success message, status code, and any additional data returned by the API.
1119
+ * {
1120
+ * Message: Success,
1121
+ * StatusCode: 200,
1122
+ * Result: -- list of updated request steps --
1123
+ * }
1124
+ */
1125
+ export async function MaintainRequestStepList(
1126
+ MaintainRequestStepListDTO,
1127
+ AuthToken = null,
1128
+ Timeout = 30000
1129
+ ) {
1130
+ let APIResponse = await apiHandler.PostMethod(
1131
+ RequestsAPIConstants.uriMaintainRequestStepList(),
1132
+ MaintainRequestStepListDTO,
1133
+ AuthToken,
1134
+ Timeout
1135
+ );
1136
+ return APIResponse;
1137
+ }
1100
1138
  /**
1101
1139
  * @description
1102
1140
  * Updates the dismiss status of a request.
package/src/index.d.ts CHANGED
@@ -102,6 +102,7 @@ import { DispatchOrderInput } from "./modals/input-modals/request-step-modals/Di
102
102
  import { GetDriverDetailsInput } from "./modals/input-modals/request-step-modals/GetDriverDetailsInput";
103
103
  import { GetOrderDetailsInput } from "./modals/input-modals/request-step-modals/GetOrderDetailsInput";
104
104
  import { GetOrderStatusInput } from "./modals/input-modals/request-step-modals/GetOrderStatusInput";
105
+ import { MaintainRequestStepListInput } from "./modals/input-modals/request-modals/MaintainRequestStepListInput";
105
106
  import {
106
107
  ProcessRequestStepListInput,
107
108
  ProcessCheckedOutStepListInput,
@@ -5577,6 +5578,22 @@ interface RequestsTransactionCommonServices {
5577
5578
  AuthToken?: string | null,
5578
5579
  Timeout?: number | null
5579
5580
  ) => BaseResponse<MaintainRequestAttributeListOutput[] | BaseErrorResponse>;
5581
+
5582
+ /**
5583
+ * @description
5584
+ * Maintains the request steps.
5585
+ *
5586
+ * @param {MaintainRequestStepListInput} MaintainRequestStepListDTO
5587
+ * An object containing fields necessary for maintaining the request steps.
5588
+ * DynamicSteps : DynamicStep[]
5589
+ * RequestId : number
5590
+ */
5591
+ MaintainRequestStepList: (
5592
+ Input: MaintainRequestStepListInput,
5593
+ AuthToken?: string | null,
5594
+ Timeout?: number | null
5595
+ ) => BaseResponse<boolean | BaseErrorResponse>;
5596
+
5580
5597
  /**
5581
5598
  * @description
5582
5599
  * Reorders a trackable batch for a given batch identifier.
@@ -7622,5 +7639,6 @@ export {
7622
7639
  NotificationListOutput,
7623
7640
  UpdateNotificationInput,
7624
7641
  GetStepTypeOutput,
7625
- ChildStep
7642
+ ChildStep,
7643
+ MaintainRequestStepListInput
7626
7644
  };
package/src/index.js CHANGED
@@ -298,6 +298,7 @@ const {
298
298
  JoinGroupOrder,
299
299
  LeaveGroupOrder,
300
300
  MaintainRequestAttributeList,
301
+ MaintainRequestStepList,
301
302
  ReorderTrackableBatch,
302
303
  TrackBatch,
303
304
  UpdateRequestDismiss,
@@ -348,6 +349,7 @@ const RequestsTransactionCommonServices = {
348
349
  JoinGroupOrder,
349
350
  LeaveGroupOrder,
350
351
  MaintainRequestAttributeList,
352
+ MaintainRequestStepList,
351
353
  ReorderTrackableBatch,
352
354
  TrackBatch,
353
355
  UpdateRequestDismiss,
@@ -0,0 +1,6 @@
1
+ import { DynamicStepList } from "./RequesterAddRequestInput"
2
+
3
+ export interface MaintainRequestStepListInput {
4
+ DynamicSteps : DynamicStepList[]
5
+ RequestId : number
6
+ }
@@ -540,6 +540,11 @@ export class RequestsAPIConstants {
540
540
  requestServicesURI + "/api/TransactionCommon/MaintainRequestAttributeList"
541
541
  );
542
542
  }
543
+ static uriMaintainRequestStepList() {
544
+ return (
545
+ requestServicesURI + "/api/TransactionCommon/MaintainRequestStepList"
546
+ );
547
+ }
543
548
  static uriUpdateRequestDismiss() {
544
549
  return requestServicesURI + "/api/TransactionCommon/UpdateRequestDismiss";
545
550
  }