@chrt-inc/typescript-sdk 0.0.203 → 0.0.205

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.
Files changed (54) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/Client.d.ts +13 -13
  3. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/Client.js +57 -57
  4. package/dist/cjs/api/resources/index.d.ts +1 -0
  5. package/dist/cjs/api/resources/index.js +1 -0
  6. package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/client/Client.d.ts +16 -16
  7. package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/client/Client.js +45 -45
  8. package/dist/cjs/api/resources/shipperPayCourierPayments/client/Client.d.ts +50 -30
  9. package/dist/cjs/api/resources/shipperPayCourierPayments/client/Client.js +134 -59
  10. package/dist/cjs/api/resources/shipperPayCourierPayments/client/index.d.ts +1 -0
  11. package/dist/cjs/api/resources/shipperPayCourierPayments/client/index.js +15 -0
  12. package/dist/cjs/api/resources/shipperPayCourierPayments/client/requests/ListPaymentsByCourierReq.d.ts +16 -0
  13. package/dist/cjs/api/resources/shipperPayCourierPayments/client/requests/ListPaymentsByShipperReq.d.ts +15 -0
  14. package/dist/cjs/api/resources/shipperPayCourierPayments/client/requests/ListPaymentsByShipperReq.js +5 -0
  15. package/dist/cjs/api/resources/shipperPayCourierPayments/client/requests/index.d.ts +2 -0
  16. package/dist/cjs/api/resources/shipperPayCourierPayments/client/requests/index.js +2 -0
  17. package/dist/cjs/api/types/CreateShipperPayCourierPaymentReq.d.ts +0 -3
  18. package/dist/cjs/api/types/GetShipperPayCourierPaymentsForShipperRes.d.ts +0 -3
  19. package/dist/cjs/api/types/PaymentPreviewResponse.d.ts +0 -3
  20. package/dist/cjs/api/types/ShipperPayCourierPayment1.d.ts +4 -3
  21. package/dist/cjs/api/types/index.d.ts +0 -1
  22. package/dist/cjs/api/types/index.js +0 -1
  23. package/dist/cjs/version.d.ts +1 -1
  24. package/dist/cjs/version.js +1 -1
  25. package/dist/esm/Client.mjs +2 -2
  26. package/dist/esm/api/resources/courierPayDriverRateSheets/client/Client.d.mts +13 -13
  27. package/dist/esm/api/resources/courierPayDriverRateSheets/client/Client.mjs +57 -57
  28. package/dist/esm/api/resources/index.d.mts +1 -0
  29. package/dist/esm/api/resources/index.mjs +1 -0
  30. package/dist/esm/api/resources/shipperPayCourierLineItemGroups/client/Client.d.mts +16 -16
  31. package/dist/esm/api/resources/shipperPayCourierLineItemGroups/client/Client.mjs +45 -45
  32. package/dist/esm/api/resources/shipperPayCourierPayments/client/Client.d.mts +50 -30
  33. package/dist/esm/api/resources/shipperPayCourierPayments/client/Client.mjs +134 -59
  34. package/dist/esm/api/resources/shipperPayCourierPayments/client/index.d.mts +1 -0
  35. package/dist/esm/api/resources/shipperPayCourierPayments/client/index.mjs +1 -1
  36. package/dist/esm/api/resources/shipperPayCourierPayments/client/requests/ListPaymentsByCourierReq.d.mts +16 -0
  37. package/dist/esm/api/resources/shipperPayCourierPayments/client/requests/ListPaymentsByShipperReq.d.mts +15 -0
  38. package/dist/esm/api/resources/shipperPayCourierPayments/client/requests/ListPaymentsByShipperReq.mjs +4 -0
  39. package/dist/esm/api/resources/shipperPayCourierPayments/client/requests/index.d.mts +2 -0
  40. package/dist/esm/api/resources/shipperPayCourierPayments/client/requests/index.mjs +1 -0
  41. package/dist/esm/api/types/CreateShipperPayCourierPaymentReq.d.mts +0 -3
  42. package/dist/esm/api/types/GetShipperPayCourierPaymentsForShipperRes.d.mts +0 -3
  43. package/dist/esm/api/types/PaymentPreviewResponse.d.mts +0 -3
  44. package/dist/esm/api/types/ShipperPayCourierPayment1.d.mts +4 -3
  45. package/dist/esm/api/types/index.d.mts +0 -1
  46. package/dist/esm/api/types/index.mjs +0 -1
  47. package/dist/esm/version.d.mts +1 -1
  48. package/dist/esm/version.mjs +1 -1
  49. package/package.json +1 -1
  50. package/reference.md +159 -84
  51. package/dist/cjs/api/types/GetShipperPayCourierPaymentsRes.d.ts +0 -10
  52. package/dist/esm/api/types/GetShipperPayCourierPaymentsRes.d.mts +0 -10
  53. /package/dist/cjs/api/{types/GetShipperPayCourierPaymentsRes.js → resources/shipperPayCourierPayments/client/requests/ListPaymentsByCourierReq.js} +0 -0
  54. /package/dist/esm/api/{types/GetShipperPayCourierPaymentsRes.mjs → resources/shipperPayCourierPayments/client/requests/ListPaymentsByCourierReq.mjs} +0 -0
@@ -66,8 +66,8 @@ class ChrtClient {
66
66
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
67
67
  "X-Fern-Language": "JavaScript",
68
68
  "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
69
- "X-Fern-SDK-Version": "0.0.203",
70
- "User-Agent": "@chrt-inc/typescript-sdk/0.0.203",
69
+ "X-Fern-SDK-Version": "0.0.205",
70
+ "User-Agent": "@chrt-inc/typescript-sdk/0.0.205",
71
71
  "X-Fern-Runtime": core.RUNTIME.type,
72
72
  "X-Fern-Runtime-Version": core.RUNTIME.version,
73
73
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -38,6 +38,19 @@ export declare class CourierPayDriverRateSheets {
38
38
  */
39
39
  listByCourierOrgId(requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverRateSheet1[]>;
40
40
  private __listByCourierOrgId;
41
+ /**
42
+ * Retrieves all rate sheets assigned to a specific driver.
43
+ *
44
+ * @param {string} driverId
45
+ * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
46
+ *
47
+ * @throws {@link Chrt.UnprocessableEntityError}
48
+ *
49
+ * @example
50
+ * await client.courierPayDriverRateSheets.listByDriverId("driver_id")
51
+ */
52
+ listByDriverId(driverId: string, requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverRateSheet1[]>;
53
+ private __listByDriverId;
41
54
  /**
42
55
  * Creates a new driver rate sheet for calculating courier payments.
43
56
  *
@@ -107,18 +120,5 @@ export declare class CourierPayDriverRateSheets {
107
120
  */
108
121
  updateById(id: string, request?: Chrt.CourierPayDriverRateSheetClientUpdate1, requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverRateSheet1>;
109
122
  private __updateById;
110
- /**
111
- * Retrieves all rate sheets assigned to a specific driver.
112
- *
113
- * @param {string} driverId
114
- * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
115
- *
116
- * @throws {@link Chrt.UnprocessableEntityError}
117
- *
118
- * @example
119
- * await client.courierPayDriverRateSheets.listByDriverId("driver_id")
120
- */
121
- listByDriverId(driverId: string, requestOptions?: CourierPayDriverRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.CourierPayDriverRateSheet1[]>;
122
- private __listByDriverId;
123
123
  protected _getAuthorizationHeader(): Promise<string | undefined>;
124
124
  }
@@ -104,6 +104,63 @@ class CourierPayDriverRateSheets {
104
104
  }
105
105
  });
106
106
  }
107
+ /**
108
+ * Retrieves all rate sheets assigned to a specific driver.
109
+ *
110
+ * @param {string} driverId
111
+ * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
112
+ *
113
+ * @throws {@link Chrt.UnprocessableEntityError}
114
+ *
115
+ * @example
116
+ * await client.courierPayDriverRateSheets.listByDriverId("driver_id")
117
+ */
118
+ listByDriverId(driverId, requestOptions) {
119
+ return core.HttpResponsePromise.fromPromise(this.__listByDriverId(driverId, requestOptions));
120
+ }
121
+ __listByDriverId(driverId, requestOptions) {
122
+ return __awaiter(this, void 0, void 0, function* () {
123
+ var _a, _b, _c, _d;
124
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
125
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/courier_pay_driver_rate_sheets/by_driver_id/${encodeURIComponent(driverId)}`),
126
+ method: "GET",
127
+ headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
128
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
129
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
130
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
131
+ });
132
+ if (_response.ok) {
133
+ return { data: _response.body, rawResponse: _response.rawResponse };
134
+ }
135
+ if (_response.error.reason === "status-code") {
136
+ switch (_response.error.statusCode) {
137
+ case 422:
138
+ throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
139
+ default:
140
+ throw new errors.ChrtError({
141
+ statusCode: _response.error.statusCode,
142
+ body: _response.error.body,
143
+ rawResponse: _response.rawResponse,
144
+ });
145
+ }
146
+ }
147
+ switch (_response.error.reason) {
148
+ case "non-json":
149
+ throw new errors.ChrtError({
150
+ statusCode: _response.error.statusCode,
151
+ body: _response.error.rawBody,
152
+ rawResponse: _response.rawResponse,
153
+ });
154
+ case "timeout":
155
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/courier_pay_driver_rate_sheets/by_driver_id/{driver_id}.");
156
+ case "unknown":
157
+ throw new errors.ChrtError({
158
+ message: _response.error.errorMessage,
159
+ rawResponse: _response.rawResponse,
160
+ });
161
+ }
162
+ });
163
+ }
107
164
  /**
108
165
  * Creates a new driver rate sheet for calculating courier payments.
109
166
  *
@@ -355,63 +412,6 @@ class CourierPayDriverRateSheets {
355
412
  }
356
413
  });
357
414
  }
358
- /**
359
- * Retrieves all rate sheets assigned to a specific driver.
360
- *
361
- * @param {string} driverId
362
- * @param {CourierPayDriverRateSheets.RequestOptions} requestOptions - Request-specific configuration.
363
- *
364
- * @throws {@link Chrt.UnprocessableEntityError}
365
- *
366
- * @example
367
- * await client.courierPayDriverRateSheets.listByDriverId("driver_id")
368
- */
369
- listByDriverId(driverId, requestOptions) {
370
- return core.HttpResponsePromise.fromPromise(this.__listByDriverId(driverId, requestOptions));
371
- }
372
- __listByDriverId(driverId, requestOptions) {
373
- return __awaiter(this, void 0, void 0, function* () {
374
- var _a, _b, _c, _d;
375
- const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
376
- url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/courier_pay_driver_rate_sheets/list/by_driver_id/${encodeURIComponent(driverId)}`),
377
- method: "GET",
378
- headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
379
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
380
- maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
381
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
382
- });
383
- if (_response.ok) {
384
- return { data: _response.body, rawResponse: _response.rawResponse };
385
- }
386
- if (_response.error.reason === "status-code") {
387
- switch (_response.error.statusCode) {
388
- case 422:
389
- throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
390
- default:
391
- throw new errors.ChrtError({
392
- statusCode: _response.error.statusCode,
393
- body: _response.error.body,
394
- rawResponse: _response.rawResponse,
395
- });
396
- }
397
- }
398
- switch (_response.error.reason) {
399
- case "non-json":
400
- throw new errors.ChrtError({
401
- statusCode: _response.error.statusCode,
402
- body: _response.error.rawBody,
403
- rawResponse: _response.rawResponse,
404
- });
405
- case "timeout":
406
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/courier_pay_driver_rate_sheets/list/by_driver_id/{driver_id}.");
407
- case "unknown":
408
- throw new errors.ChrtError({
409
- message: _response.error.errorMessage,
410
- rawResponse: _response.rawResponse,
411
- });
412
- }
413
- });
414
- }
415
415
  _getAuthorizationHeader() {
416
416
  return __awaiter(this, void 0, void 0, function* () {
417
417
  const bearer = yield core.Supplier.get(this._options.token);
@@ -28,6 +28,7 @@ export * from "./orgProfiles/client/requests/index.js";
28
28
  export * from "./orders/client/requests/index.js";
29
29
  export * from "./courierPayDriverRateSheets/client/requests/index.js";
30
30
  export * from "./shipperPayCourierRateSheets/client/requests/index.js";
31
+ export * from "./shipperPayCourierPayments/client/requests/index.js";
31
32
  export * from "./courierPayDriverPayouts/client/requests/index.js";
32
33
  export * from "./taskGroups/client/requests/index.js";
33
34
  export * from "./shipperContactInfo/client/requests/index.js";
@@ -67,6 +67,7 @@ __exportStar(require("./orgProfiles/client/requests/index.js"), exports);
67
67
  __exportStar(require("./orders/client/requests/index.js"), exports);
68
68
  __exportStar(require("./courierPayDriverRateSheets/client/requests/index.js"), exports);
69
69
  __exportStar(require("./shipperPayCourierRateSheets/client/requests/index.js"), exports);
70
+ __exportStar(require("./shipperPayCourierPayments/client/requests/index.js"), exports);
70
71
  __exportStar(require("./courierPayDriverPayouts/client/requests/index.js"), exports);
71
72
  __exportStar(require("./taskGroups/client/requests/index.js"), exports);
72
73
  __exportStar(require("./shipperContactInfo/client/requests/index.js"), exports);
@@ -34,22 +34,6 @@ export declare class ShipperPayCourierLineItemGroups {
34
34
  constructor(_options?: ShipperPayCourierLineItemGroups.Options);
35
35
  get addLineItems(): AddLineItems;
36
36
  get removeLineItems(): RemoveLineItems;
37
- /**
38
- * Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
39
- *
40
- * @param {Chrt.ShipperPayCourierLineItemGroupCreateReq} request
41
- * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
42
- *
43
- * @throws {@link Chrt.UnprocessableEntityError}
44
- *
45
- * @example
46
- * await client.shipperPayCourierLineItemGroups.preview({
47
- * shipper_pay_courier_rate_sheet_id: "shipper_pay_courier_rate_sheet_id",
48
- * task_group_id: "task_group_id"
49
- * })
50
- */
51
- preview(request: Chrt.ShipperPayCourierLineItemGroupCreateReq, requestOptions?: ShipperPayCourierLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierLineItemGroupServerCreate1>;
52
- private __preview;
53
37
  /**
54
38
  * Retrieves a shipper pay courier line item group by its ID.
55
39
  *
@@ -89,6 +73,22 @@ export declare class ShipperPayCourierLineItemGroups {
89
73
  */
90
74
  byTaskGroupId(taskGroupId: string, requestOptions?: ShipperPayCourierLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierLineItemGroup1>;
91
75
  private __byTaskGroupId;
76
+ /**
77
+ * Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
78
+ *
79
+ * @param {Chrt.ShipperPayCourierLineItemGroupCreateReq} request
80
+ * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
81
+ *
82
+ * @throws {@link Chrt.UnprocessableEntityError}
83
+ *
84
+ * @example
85
+ * await client.shipperPayCourierLineItemGroups.preview({
86
+ * shipper_pay_courier_rate_sheet_id: "shipper_pay_courier_rate_sheet_id",
87
+ * task_group_id: "task_group_id"
88
+ * })
89
+ */
90
+ preview(request: Chrt.ShipperPayCourierLineItemGroupCreateReq, requestOptions?: ShipperPayCourierLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierLineItemGroupServerCreate1>;
91
+ private __preview;
92
92
  /**
93
93
  * Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
94
94
  *
@@ -66,41 +66,32 @@ class ShipperPayCourierLineItemGroups {
66
66
  return ((_a = this._removeLineItems) !== null && _a !== void 0 ? _a : (this._removeLineItems = new Client_js_2.RemoveLineItems(this._options)));
67
67
  }
68
68
  /**
69
- * Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
69
+ * Retrieves a shipper pay courier line item group by its ID.
70
70
  *
71
- * @param {Chrt.ShipperPayCourierLineItemGroupCreateReq} request
71
+ * @param {string} id
72
72
  * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
73
73
  *
74
74
  * @throws {@link Chrt.UnprocessableEntityError}
75
75
  *
76
76
  * @example
77
- * await client.shipperPayCourierLineItemGroups.preview({
78
- * shipper_pay_courier_rate_sheet_id: "shipper_pay_courier_rate_sheet_id",
79
- * task_group_id: "task_group_id"
80
- * })
77
+ * await client.shipperPayCourierLineItemGroups.getById("id")
81
78
  */
82
- preview(request, requestOptions) {
83
- return core.HttpResponsePromise.fromPromise(this.__preview(request, requestOptions));
79
+ getById(id, requestOptions) {
80
+ return core.HttpResponsePromise.fromPromise(this.__getById(id, requestOptions));
84
81
  }
85
- __preview(request, requestOptions) {
82
+ __getById(id, requestOptions) {
86
83
  return __awaiter(this, void 0, void 0, function* () {
87
84
  var _a, _b, _c, _d;
88
85
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
89
- url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "oort/shipper_pay_courier_line_item_groups/preview"),
90
- method: "POST",
86
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/shipper_pay_courier_line_item_groups/${encodeURIComponent(id)}`),
87
+ method: "GET",
91
88
  headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
92
- contentType: "application/json",
93
- requestType: "json",
94
- body: request,
95
89
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
96
90
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
97
91
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
98
92
  });
99
93
  if (_response.ok) {
100
- return {
101
- data: _response.body,
102
- rawResponse: _response.rawResponse,
103
- };
94
+ return { data: _response.body, rawResponse: _response.rawResponse };
104
95
  }
105
96
  if (_response.error.reason === "status-code") {
106
97
  switch (_response.error.statusCode) {
@@ -122,7 +113,7 @@ class ShipperPayCourierLineItemGroups {
122
113
  rawResponse: _response.rawResponse,
123
114
  });
124
115
  case "timeout":
125
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/shipper_pay_courier_line_item_groups/preview.");
116
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/shipper_pay_courier_line_item_groups/{id}.");
126
117
  case "unknown":
127
118
  throw new errors.ChrtError({
128
119
  message: _response.error.errorMessage,
@@ -132,7 +123,7 @@ class ShipperPayCourierLineItemGroups {
132
123
  });
133
124
  }
134
125
  /**
135
- * Retrieves a shipper pay courier line item group by its ID.
126
+ * Deletes a shipper pay courier line item group by its ID.
136
127
  *
137
128
  * @param {string} id
138
129
  * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -140,17 +131,17 @@ class ShipperPayCourierLineItemGroups {
140
131
  * @throws {@link Chrt.UnprocessableEntityError}
141
132
  *
142
133
  * @example
143
- * await client.shipperPayCourierLineItemGroups.getById("id")
134
+ * await client.shipperPayCourierLineItemGroups.deleteById("id")
144
135
  */
145
- getById(id, requestOptions) {
146
- return core.HttpResponsePromise.fromPromise(this.__getById(id, requestOptions));
136
+ deleteById(id, requestOptions) {
137
+ return core.HttpResponsePromise.fromPromise(this.__deleteById(id, requestOptions));
147
138
  }
148
- __getById(id, requestOptions) {
139
+ __deleteById(id, requestOptions) {
149
140
  return __awaiter(this, void 0, void 0, function* () {
150
141
  var _a, _b, _c, _d;
151
142
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
152
143
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/shipper_pay_courier_line_item_groups/${encodeURIComponent(id)}`),
153
- method: "GET",
144
+ method: "DELETE",
154
145
  headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
155
146
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
156
147
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -179,7 +170,7 @@ class ShipperPayCourierLineItemGroups {
179
170
  rawResponse: _response.rawResponse,
180
171
  });
181
172
  case "timeout":
182
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/shipper_pay_courier_line_item_groups/{id}.");
173
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling DELETE /oort/shipper_pay_courier_line_item_groups/{id}.");
183
174
  case "unknown":
184
175
  throw new errors.ChrtError({
185
176
  message: _response.error.errorMessage,
@@ -189,25 +180,25 @@ class ShipperPayCourierLineItemGroups {
189
180
  });
190
181
  }
191
182
  /**
192
- * Deletes a shipper pay courier line item group by its ID.
183
+ * Retrieves a shipper pay courier line item group by its associated task group ID.
193
184
  *
194
- * @param {string} id
185
+ * @param {string} taskGroupId
195
186
  * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
196
187
  *
197
188
  * @throws {@link Chrt.UnprocessableEntityError}
198
189
  *
199
190
  * @example
200
- * await client.shipperPayCourierLineItemGroups.deleteById("id")
191
+ * await client.shipperPayCourierLineItemGroups.byTaskGroupId("task_group_id")
201
192
  */
202
- deleteById(id, requestOptions) {
203
- return core.HttpResponsePromise.fromPromise(this.__deleteById(id, requestOptions));
193
+ byTaskGroupId(taskGroupId, requestOptions) {
194
+ return core.HttpResponsePromise.fromPromise(this.__byTaskGroupId(taskGroupId, requestOptions));
204
195
  }
205
- __deleteById(id, requestOptions) {
196
+ __byTaskGroupId(taskGroupId, requestOptions) {
206
197
  return __awaiter(this, void 0, void 0, function* () {
207
198
  var _a, _b, _c, _d;
208
199
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
209
- url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/shipper_pay_courier_line_item_groups/${encodeURIComponent(id)}`),
210
- method: "DELETE",
200
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/shipper_pay_courier_line_item_groups/by_task_group/${encodeURIComponent(taskGroupId)}`),
201
+ method: "GET",
211
202
  headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
212
203
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
213
204
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -236,7 +227,7 @@ class ShipperPayCourierLineItemGroups {
236
227
  rawResponse: _response.rawResponse,
237
228
  });
238
229
  case "timeout":
239
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling DELETE /oort/shipper_pay_courier_line_item_groups/{id}.");
230
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/shipper_pay_courier_line_item_groups/by_task_group/{task_group_id}.");
240
231
  case "unknown":
241
232
  throw new errors.ChrtError({
242
233
  message: _response.error.errorMessage,
@@ -246,32 +237,41 @@ class ShipperPayCourierLineItemGroups {
246
237
  });
247
238
  }
248
239
  /**
249
- * Retrieves a shipper pay courier line item group by its associated task group ID.
240
+ * Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
250
241
  *
251
- * @param {string} taskGroupId
242
+ * @param {Chrt.ShipperPayCourierLineItemGroupCreateReq} request
252
243
  * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
253
244
  *
254
245
  * @throws {@link Chrt.UnprocessableEntityError}
255
246
  *
256
247
  * @example
257
- * await client.shipperPayCourierLineItemGroups.byTaskGroupId("task_group_id")
248
+ * await client.shipperPayCourierLineItemGroups.preview({
249
+ * shipper_pay_courier_rate_sheet_id: "shipper_pay_courier_rate_sheet_id",
250
+ * task_group_id: "task_group_id"
251
+ * })
258
252
  */
259
- byTaskGroupId(taskGroupId, requestOptions) {
260
- return core.HttpResponsePromise.fromPromise(this.__byTaskGroupId(taskGroupId, requestOptions));
253
+ preview(request, requestOptions) {
254
+ return core.HttpResponsePromise.fromPromise(this.__preview(request, requestOptions));
261
255
  }
262
- __byTaskGroupId(taskGroupId, requestOptions) {
256
+ __preview(request, requestOptions) {
263
257
  return __awaiter(this, void 0, void 0, function* () {
264
258
  var _a, _b, _c, _d;
265
259
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
266
- url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/shipper_pay_courier_line_item_groups/by_task_group/${encodeURIComponent(taskGroupId)}`),
267
- method: "GET",
260
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "oort/shipper_pay_courier_line_item_groups/preview"),
261
+ method: "POST",
268
262
  headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
263
+ contentType: "application/json",
264
+ requestType: "json",
265
+ body: request,
269
266
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
270
267
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
271
268
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
272
269
  });
273
270
  if (_response.ok) {
274
- return { data: _response.body, rawResponse: _response.rawResponse };
271
+ return {
272
+ data: _response.body,
273
+ rawResponse: _response.rawResponse,
274
+ };
275
275
  }
276
276
  if (_response.error.reason === "status-code") {
277
277
  switch (_response.error.statusCode) {
@@ -293,7 +293,7 @@ class ShipperPayCourierLineItemGroups {
293
293
  rawResponse: _response.rawResponse,
294
294
  });
295
295
  case "timeout":
296
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/shipper_pay_courier_line_item_groups/by_task_group/{task_group_id}.");
296
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/shipper_pay_courier_line_item_groups/preview.");
297
297
  case "unknown":
298
298
  throw new errors.ChrtError({
299
299
  message: _response.error.errorMessage,
@@ -29,58 +29,76 @@ export declare class ShipperPayCourierPayments {
29
29
  protected readonly _options: ShipperPayCourierPayments.Options;
30
30
  constructor(_options?: ShipperPayCourierPayments.Options);
31
31
  /**
32
- * Retrieves all shipper-to-courier payments for a specific order by ID or short ID.
32
+ * Get a shipper pay courier payment by its ID
33
33
  *
34
- * @param {string} orderIdOrShortId
34
+ * @param {string} shipperPayCourierPaymentId
35
35
  * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
36
36
  *
37
37
  * @throws {@link Chrt.UnprocessableEntityError}
38
38
  *
39
39
  * @example
40
- * await client.shipperPayCourierPayments.getByOrderIdOrShortId("order_id_or_short_id")
40
+ * await client.shipperPayCourierPayments.getById("shipper_pay_courier_payment_id")
41
41
  */
42
- getByOrderIdOrShortId(orderIdOrShortId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierPaymentsRes>;
43
- private __getByOrderIdOrShortId;
42
+ getById(shipperPayCourierPaymentId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierPayment1>;
43
+ private __getById;
44
44
  /**
45
- * Create a shipper-to-courier payment record based on all task groups in an order
45
+ * Deletes a shipper-to-courier payment record. Only allowed if the payment status is PENDING.
46
46
  *
47
- * @param {Chrt.CreateShipperPayCourierPaymentReq} request
47
+ * @param {string} shipperPayCourierPaymentId
48
48
  * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
49
49
  *
50
50
  * @throws {@link Chrt.UnprocessableEntityError}
51
51
  *
52
52
  * @example
53
- * await client.shipperPayCourierPayments.create({
54
- * order_id_or_short_id: "order_id_or_short_id"
55
- * })
53
+ * await client.shipperPayCourierPayments.delete("shipper_pay_courier_payment_id")
56
54
  */
57
- create(request: Chrt.CreateShipperPayCourierPaymentReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<string>;
58
- private __create;
55
+ delete(shipperPayCourierPaymentId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<boolean>;
56
+ private __delete;
59
57
  /**
60
- * Retrieves all shipper-to-courier payments for the authenticated shipper organization.
58
+ * Get a shipper pay courier payment by order ID or short ID
61
59
  *
60
+ * @param {string} orderIdOrShortId
62
61
  * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
63
62
  *
63
+ * @throws {@link Chrt.UnprocessableEntityError}
64
+ *
64
65
  * @example
65
- * await client.shipperPayCourierPayments.listByShipperOrg()
66
+ * await client.shipperPayCourierPayments.getByOrderIdOrShortId("order_id_or_short_id")
66
67
  */
67
- listByShipperOrg(requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierPaymentsForShipperRes>;
68
- private __listByShipperOrg;
68
+ getByOrderIdOrShortId(orderIdOrShortId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierPayment1>;
69
+ private __getByOrderIdOrShortId;
69
70
  /**
70
- * Retrieves shipper-to-courier payments for the authenticated shipper organization filtered by payment status.
71
+ * List shipper pay courier payments by shipper org ID with status filtering
71
72
  *
72
- * @param {Chrt.StripeConnectInvoiceStatusEnum} paymentStatus
73
+ * @param {Chrt.ListPaymentsByShipperReq} request
73
74
  * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
74
75
  *
75
76
  * @throws {@link Chrt.UnprocessableEntityError}
76
77
  *
77
78
  * @example
78
- * await client.shipperPayCourierPayments.listByShipperOrgAndStatus("invoice_not_yet_created")
79
+ * await client.shipperPayCourierPayments.listByShipperOrgId({
80
+ * statuses: ["invoice_not_yet_created"]
81
+ * })
79
82
  */
80
- listByShipperOrgAndStatus(paymentStatus: Chrt.StripeConnectInvoiceStatusEnum, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierPaymentsForShipperRes>;
81
- private __listByShipperOrgAndStatus;
83
+ listByShipperOrgId(request: Chrt.ListPaymentsByShipperReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierPaymentsForShipperRes>;
84
+ private __listByShipperOrgId;
82
85
  /**
83
- * Preview a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status
86
+ * List shipper pay courier payments by courier org ID with status filtering
87
+ *
88
+ * @param {Chrt.ListPaymentsByCourierReq} request
89
+ * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
90
+ *
91
+ * @throws {@link Chrt.UnprocessableEntityError}
92
+ *
93
+ * @example
94
+ * await client.shipperPayCourierPayments.listByCourierOrgId({
95
+ * statuses: ["invoice_not_yet_created"]
96
+ * })
97
+ */
98
+ listByCourierOrgId(request: Chrt.ListPaymentsByCourierReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierPaymentsForShipperRes>;
99
+ private __listByCourierOrgId;
100
+ /**
101
+ * Create a shipper-to-courier payment record based on all task groups in an order
84
102
  *
85
103
  * @param {Chrt.CreateShipperPayCourierPaymentReq} request
86
104
  * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -88,24 +106,26 @@ export declare class ShipperPayCourierPayments {
88
106
  * @throws {@link Chrt.UnprocessableEntityError}
89
107
  *
90
108
  * @example
91
- * await client.shipperPayCourierPayments.preview({
109
+ * await client.shipperPayCourierPayments.create({
92
110
  * order_id_or_short_id: "order_id_or_short_id"
93
111
  * })
94
112
  */
95
- preview(request: Chrt.CreateShipperPayCourierPaymentReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.PaymentPreviewResponse>;
96
- private __preview;
113
+ create(request: Chrt.CreateShipperPayCourierPaymentReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<string>;
114
+ private __create;
97
115
  /**
98
- * Deletes a shipper-to-courier payment record. Only allowed if the payment status is PENDING.
116
+ * Preview a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status
99
117
  *
100
- * @param {string} shipperPayCourierPaymentId
118
+ * @param {Chrt.CreateShipperPayCourierPaymentReq} request
101
119
  * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
102
120
  *
103
121
  * @throws {@link Chrt.UnprocessableEntityError}
104
122
  *
105
123
  * @example
106
- * await client.shipperPayCourierPayments.delete("shipper_pay_courier_payment_id")
124
+ * await client.shipperPayCourierPayments.preview({
125
+ * order_id_or_short_id: "order_id_or_short_id"
126
+ * })
107
127
  */
108
- delete(shipperPayCourierPaymentId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<boolean>;
109
- private __delete;
128
+ preview(request: Chrt.CreateShipperPayCourierPaymentReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.PaymentPreviewResponse>;
129
+ private __preview;
110
130
  protected _getAuthorizationHeader(): Promise<string | undefined>;
111
131
  }