@shipengine/react-api 0.14.0 → 0.15.0

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/hooks/index.d.ts CHANGED
@@ -8,14 +8,17 @@ export * from "./use-create-sales-order-shipment";
8
8
  export * from "./use-create-shipment";
9
9
  export * from "./use-create-warehouse";
10
10
  export * from "./use-delete-warehouse";
11
+ export * from "./use-download-rate-card";
11
12
  export * from "./use-get-account-settings";
12
13
  export * from "./use-get-auto-funding-configuration";
13
14
  export * from "./use-get-carrier-by-id";
14
15
  export * from "./use-get-funding-source-by-id";
15
16
  export * from "./use-get-insurance-account";
16
17
  export * from "./use-get-label";
18
+ export * from "./use-get-rate-package-formats-by-carrier";
17
19
  export * from "./use-get-sales-order";
18
20
  export * from "./use-get-sales-order-shipment";
21
+ export * from "./use-get-services-by-carrier";
19
22
  export * from "./use-get-shipment";
20
23
  export * from "./use-get-wallet-history";
21
24
  export * from "./use-get-countries-by-carrier";
@@ -38,6 +41,7 @@ export * from "./use-get-shipment-rates";
38
41
  export * from "./use-update-account-settings";
39
42
  export * from "./use-update-auto-funding";
40
43
  export * from "./use-update-funding-source";
44
+ export * from "./use-update-rate-card";
41
45
  export * from "./use-update-sales-order-shipment";
42
46
  export * from "./use-update-warehouse";
43
47
  export * from "./use-validate-addresses";
@@ -0,0 +1,5 @@
1
+ /**
2
+ * @category ShipEngine API Hooks
3
+ *
4
+ */
5
+ export declare const useDownloadRateCard: (rateCardId: string) => import("react-query").UseQueryResult<Blob, import("@shipengine/js-api").CodedError[]>;
@@ -0,0 +1,5 @@
1
+ /**
2
+ * @category ShipEngine API Hooks
3
+ *
4
+ */
5
+ export declare const useGetRatePackageFormatsByCarrier: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").CarrierRatePackageFormat[], import("@shipengine/js-api").CodedError[]>;
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @category ShipEngine API Hooks
3
+ *
4
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-carrier-services/)
5
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_carrier_services)
6
+ */
7
+ export declare const useGetServicesByCarrier: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").CarrierService[], import("@shipengine/js-api").CodedError[]>;
@@ -0,0 +1,6 @@
1
+ import { RateCard } from "@shipengine/js-api";
2
+ /**
3
+ * @category ShipEngine API Hooks
4
+ *
5
+ */
6
+ export declare const useUpdateRateCard: () => import("react-query").UseMutationResult<RateCard, import("@shipengine/js-api").CodedError[], RateCard, unknown>;
package/index.js CHANGED
@@ -114,7 +114,7 @@ const retryUntil = (callbackFn, retries = 10, timeoutBetweenAttempts = 1e3) => P
114
114
  throw error;
115
115
  });
116
116
 
117
- var __async$k = (__this, __arguments, generator) => {
117
+ var __async$l = (__this, __arguments, generator) => {
118
118
  return new Promise((resolve, reject) => {
119
119
  var fulfilled = (value) => {
120
120
  try {
@@ -137,7 +137,7 @@ var __async$k = (__this, __arguments, generator) => {
137
137
  const useAddFunds = (carrierId) => {
138
138
  const { client } = useShipEngine();
139
139
  return reactQuery.useMutation({
140
- mutationFn: (funds) => __async$k(void 0, null, function* () {
140
+ mutationFn: (funds) => __async$l(void 0, null, function* () {
141
141
  const result = yield client.carriers.addFunds(carrierId, funds);
142
142
  return result.data;
143
143
  }),
@@ -146,7 +146,7 @@ const useAddFunds = (carrierId) => {
146
146
  });
147
147
  };
148
148
 
149
- var __async$j = (__this, __arguments, generator) => {
149
+ var __async$k = (__this, __arguments, generator) => {
150
150
  return new Promise((resolve, reject) => {
151
151
  var fulfilled = (value) => {
152
152
  try {
@@ -169,7 +169,7 @@ var __async$j = (__this, __arguments, generator) => {
169
169
  const useCalculateRates = () => {
170
170
  const { client } = useShipEngine();
171
171
  return reactQuery.useMutation({
172
- mutationFn: (_0) => __async$j(void 0, [_0], function* ({ rateOptions, shipmentId }) {
172
+ mutationFn: (_0) => __async$k(void 0, [_0], function* ({ rateOptions, shipmentId }) {
173
173
  const result = yield client.rates.calculateByShipmentId(shipmentId, rateOptions);
174
174
  return result.data;
175
175
  }),
@@ -178,7 +178,7 @@ const useCalculateRates = () => {
178
178
  });
179
179
  };
180
180
 
181
- var __async$i = (__this, __arguments, generator) => {
181
+ var __async$j = (__this, __arguments, generator) => {
182
182
  return new Promise((resolve, reject) => {
183
183
  var fulfilled = (value) => {
184
184
  try {
@@ -201,7 +201,7 @@ var __async$i = (__this, __arguments, generator) => {
201
201
  const useConnectCarrier = () => {
202
202
  const { client } = useShipEngine();
203
203
  return reactQuery.useMutation({
204
- mutationFn: (params) => __async$i(void 0, null, function* () {
204
+ mutationFn: (params) => __async$j(void 0, null, function* () {
205
205
  const result = yield client.carriers.connect(params);
206
206
  return result.data;
207
207
  }),
@@ -210,7 +210,7 @@ const useConnectCarrier = () => {
210
210
  });
211
211
  };
212
212
 
213
- var __async$h = (__this, __arguments, generator) => {
213
+ var __async$i = (__this, __arguments, generator) => {
214
214
  return new Promise((resolve, reject) => {
215
215
  var fulfilled = (value) => {
216
216
  try {
@@ -233,7 +233,7 @@ var __async$h = (__this, __arguments, generator) => {
233
233
  const useCreateFundingSource = () => {
234
234
  const { client } = useShipEngine();
235
235
  return reactQuery.useMutation({
236
- mutationFn: (fundingSource) => __async$h(void 0, null, function* () {
236
+ mutationFn: (fundingSource) => __async$i(void 0, null, function* () {
237
237
  const result = yield client.fundingSources.create(fundingSource);
238
238
  return result.data;
239
239
  }),
@@ -257,7 +257,7 @@ var __objRest$5 = (source, exclude) => {
257
257
  }
258
258
  return target;
259
259
  };
260
- var __async$g = (__this, __arguments, generator) => {
260
+ var __async$h = (__this, __arguments, generator) => {
261
261
  return new Promise((resolve, reject) => {
262
262
  var fulfilled = (value) => {
263
263
  try {
@@ -280,7 +280,7 @@ var __async$g = (__this, __arguments, generator) => {
280
280
  const useCreateLabel = () => {
281
281
  const { client } = useShipEngine();
282
282
  return reactQuery.useMutation({
283
- mutationFn: (_a) => __async$g(void 0, null, function* () {
283
+ mutationFn: (_a) => __async$h(void 0, null, function* () {
284
284
  var _b = _a, { rateId } = _b, options = __objRest$5(_b, ["rateId"]);
285
285
  const result = yield client.labels.createByRateId(rateId, options);
286
286
  return result.data;
@@ -290,7 +290,7 @@ const useCreateLabel = () => {
290
290
  });
291
291
  };
292
292
 
293
- var __async$f = (__this, __arguments, generator) => {
293
+ var __async$g = (__this, __arguments, generator) => {
294
294
  return new Promise((resolve, reject) => {
295
295
  var fulfilled = (value) => {
296
296
  try {
@@ -313,7 +313,7 @@ var __async$f = (__this, __arguments, generator) => {
313
313
  const useCreateRateCard = () => {
314
314
  const { client } = useShipEngine();
315
315
  return reactQuery.useMutation({
316
- mutationFn: (rateCard) => __async$f(void 0, null, function* () {
316
+ mutationFn: (rateCard) => __async$g(void 0, null, function* () {
317
317
  const result = yield client.rateCards.create(rateCard);
318
318
  return result.data;
319
319
  }),
@@ -337,7 +337,7 @@ var __objRest$4 = (source, exclude) => {
337
337
  }
338
338
  return target;
339
339
  };
340
- var __async$e = (__this, __arguments, generator) => {
340
+ var __async$f = (__this, __arguments, generator) => {
341
341
  return new Promise((resolve, reject) => {
342
342
  var fulfilled = (value) => {
343
343
  try {
@@ -360,7 +360,7 @@ var __async$e = (__this, __arguments, generator) => {
360
360
  const useCreateSalesOrderShipment = () => {
361
361
  const { client } = useShipEngine();
362
362
  return reactQuery.useMutation({
363
- mutationFn: (_a) => __async$e(void 0, null, function* () {
363
+ mutationFn: (_a) => __async$f(void 0, null, function* () {
364
364
  var _b = _a, { salesOrderId } = _b, shipment = __objRest$4(_b, ["salesOrderId"]);
365
365
  const result = yield client.salesOrderShipments.create(salesOrderId, shipment);
366
366
  return result.data;
@@ -389,7 +389,7 @@ var __spreadValues = (a, b) => {
389
389
  return a;
390
390
  };
391
391
  var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
392
- var __async$d = (__this, __arguments, generator) => {
392
+ var __async$e = (__this, __arguments, generator) => {
393
393
  return new Promise((resolve, reject) => {
394
394
  var fulfilled = (value) => {
395
395
  try {
@@ -412,7 +412,7 @@ var __async$d = (__this, __arguments, generator) => {
412
412
  const useCreateShipment = () => {
413
413
  const { client } = useShipEngine();
414
414
  return reactQuery.useMutation({
415
- mutationFn: (shipment) => __async$d(void 0, null, function* () {
415
+ mutationFn: (shipment) => __async$e(void 0, null, function* () {
416
416
  var _a;
417
417
  if (shipment.warehouseId === void 0) {
418
418
  throw new jsApi.SE.CodedError("errorMessages.noWarehouses", {
@@ -439,7 +439,7 @@ const useCreateShipment = () => {
439
439
  });
440
440
  };
441
441
 
442
- var __async$c = (__this, __arguments, generator) => {
442
+ var __async$d = (__this, __arguments, generator) => {
443
443
  return new Promise((resolve, reject) => {
444
444
  var fulfilled = (value) => {
445
445
  try {
@@ -462,7 +462,7 @@ var __async$c = (__this, __arguments, generator) => {
462
462
  const useCreateWarehouse = () => {
463
463
  const { client } = useShipEngine();
464
464
  return reactQuery.useMutation({
465
- mutationFn: (data) => __async$c(void 0, null, function* () {
465
+ mutationFn: (data) => __async$d(void 0, null, function* () {
466
466
  const result = yield client.warehouses.create(data);
467
467
  return result.data;
468
468
  }),
@@ -471,7 +471,7 @@ const useCreateWarehouse = () => {
471
471
  });
472
472
  };
473
473
 
474
- var __async$b = (__this, __arguments, generator) => {
474
+ var __async$c = (__this, __arguments, generator) => {
475
475
  return new Promise((resolve, reject) => {
476
476
  var fulfilled = (value) => {
477
477
  try {
@@ -494,7 +494,7 @@ var __async$b = (__this, __arguments, generator) => {
494
494
  const useDeleteWarehouse = () => {
495
495
  const { client } = useShipEngine();
496
496
  return reactQuery.useMutation({
497
- mutationFn: (_0) => __async$b(void 0, [_0], function* ({ warehouseId }) {
497
+ mutationFn: (_0) => __async$c(void 0, [_0], function* ({ warehouseId }) {
498
498
  const result = yield client.warehouses.delete(warehouseId);
499
499
  return result.data;
500
500
  }),
@@ -503,6 +503,19 @@ const useDeleteWarehouse = () => {
503
503
  });
504
504
  };
505
505
 
506
+ const useDownloadRateCard = (rateCardId) => {
507
+ const { client } = useShipEngine();
508
+ return reactQuery.useQuery({
509
+ enabled: !!rateCardId.length,
510
+ onError,
511
+ queryFn: () => {
512
+ return client.rateCards.download(rateCardId);
513
+ },
514
+ queryKey: ["useDownloadRateCard", rateCardId],
515
+ select: (result) => result.data
516
+ });
517
+ };
518
+
506
519
  const useGetAccountSettings = () => {
507
520
  const { client } = useShipEngine();
508
521
  return reactQuery.useQuery({
@@ -585,6 +598,23 @@ const useGetLabel = (labelId) => {
585
598
  });
586
599
  };
587
600
 
601
+ const useGetRatePackageFormatsByCarrier = (carrierId) => {
602
+ const { client } = useShipEngine();
603
+ return reactQuery.useQuery({
604
+ enabled: !!carrierId,
605
+ onError,
606
+ queryFn: () => {
607
+ if (carrierId)
608
+ return client.carriers.getRatePackageFormats(carrierId);
609
+ return Promise.reject(new Error("carrierId is required"));
610
+ },
611
+ queryKey: ["useGetRatePackageFormatsByCarrier", carrierId],
612
+ select: (result) => result.data.ratePackageFormats,
613
+ // Fresh for 5 minutes
614
+ staleTime: 5 * 60 * 1e3
615
+ });
616
+ };
617
+
588
618
  const useGetSalesOrder = (salesOrderId) => {
589
619
  const { client } = useShipEngine();
590
620
  return reactQuery.useQuery({
@@ -615,6 +645,23 @@ const useGetSalesOrderShipment = (shipmentId) => {
615
645
  });
616
646
  };
617
647
 
648
+ const useGetServicesByCarrier = (carrierId) => {
649
+ const { client } = useShipEngine();
650
+ return reactQuery.useQuery({
651
+ enabled: !!carrierId,
652
+ onError,
653
+ queryFn: () => {
654
+ if (carrierId)
655
+ return client.carriers.getServices(carrierId);
656
+ return Promise.reject(new Error("carrierId is required"));
657
+ },
658
+ queryKey: ["useGetServicesByCarrier", carrierId],
659
+ select: (result) => result.data.services,
660
+ // Fresh for 5 minutes
661
+ staleTime: 5 * 60 * 1e3
662
+ });
663
+ };
664
+
618
665
  const useGetShipment = (shipmentId) => {
619
666
  const { client } = useShipEngine();
620
667
  return reactQuery.useQuery({
@@ -823,7 +870,7 @@ var __objRest$2 = (source, exclude) => {
823
870
  }
824
871
  return target;
825
872
  };
826
- var __async$a = (__this, __arguments, generator) => {
873
+ var __async$b = (__this, __arguments, generator) => {
827
874
  return new Promise((resolve, reject) => {
828
875
  var fulfilled = (value) => {
829
876
  try {
@@ -846,7 +893,7 @@ var __async$a = (__this, __arguments, generator) => {
846
893
  const useNotifySalesOrderShipped = () => {
847
894
  const { client } = useShipEngine();
848
895
  return reactQuery.useMutation({
849
- mutationFn: (_a) => __async$a(void 0, null, function* () {
896
+ mutationFn: (_a) => __async$b(void 0, null, function* () {
850
897
  var _b = _a, { salesOrderId } = _b, tracking = __objRest$2(_b, ["salesOrderId"]);
851
898
  const result = yield client.salesOrders.notifyShipped(salesOrderId, tracking);
852
899
  return result.data;
@@ -856,7 +903,7 @@ const useNotifySalesOrderShipped = () => {
856
903
  });
857
904
  };
858
905
 
859
- var __async$9 = (__this, __arguments, generator) => {
906
+ var __async$a = (__this, __arguments, generator) => {
860
907
  return new Promise((resolve, reject) => {
861
908
  var fulfilled = (value) => {
862
909
  try {
@@ -879,7 +926,7 @@ var __async$9 = (__this, __arguments, generator) => {
879
926
  const useParseAddress = () => {
880
927
  const { client } = useShipEngine();
881
928
  return reactQuery.useMutation({
882
- mutationFn: (_0) => __async$9(void 0, [_0], function* ({ address, text }) {
929
+ mutationFn: (_0) => __async$a(void 0, [_0], function* ({ address, text }) {
883
930
  const result = yield client.addresses.parse(text, address);
884
931
  return result.data;
885
932
  }),
@@ -888,7 +935,7 @@ const useParseAddress = () => {
888
935
  });
889
936
  };
890
937
 
891
- var __async$8 = (__this, __arguments, generator) => {
938
+ var __async$9 = (__this, __arguments, generator) => {
892
939
  return new Promise((resolve, reject) => {
893
940
  var fulfilled = (value) => {
894
941
  try {
@@ -911,7 +958,7 @@ var __async$8 = (__this, __arguments, generator) => {
911
958
  const useRefreshOrderSourceAsync = () => {
912
959
  const { client } = useShipEngine();
913
960
  return reactQuery.useMutation({
914
- mutationFn: (orderSourceId) => __async$8(void 0, null, function* () {
961
+ mutationFn: (orderSourceId) => __async$9(void 0, null, function* () {
915
962
  const result = yield client.orderSources.refresh(orderSourceId);
916
963
  return result.data;
917
964
  }),
@@ -922,9 +969,9 @@ const useRefreshOrderSource = () => {
922
969
  const { client } = useShipEngine();
923
970
  const { mutateAsync: refreshOrderSourceAsync } = useRefreshOrderSourceAsync();
924
971
  return reactQuery.useMutation({
925
- mutationFn: (orderSourceId) => __async$8(void 0, null, function* () {
972
+ mutationFn: (orderSourceId) => __async$9(void 0, null, function* () {
926
973
  yield refreshOrderSourceAsync(orderSourceId);
927
- const waitResult = yield retryUntil(() => __async$8(void 0, null, function* () {
974
+ const waitResult = yield retryUntil(() => __async$9(void 0, null, function* () {
928
975
  const { data: checkResult } = yield client.orderSources.get(orderSourceId);
929
976
  if (["preparing_update", "updating"].includes(checkResult.refreshInfo.status)) {
930
977
  throw new jsApi.SE.CodedError("Order source is still refreshing");
@@ -938,7 +985,7 @@ const useRefreshOrderSource = () => {
938
985
  });
939
986
  };
940
987
 
941
- var __async$7 = (__this, __arguments, generator) => {
988
+ var __async$8 = (__this, __arguments, generator) => {
942
989
  return new Promise((resolve, reject) => {
943
990
  var fulfilled = (value) => {
944
991
  try {
@@ -961,7 +1008,7 @@ var __async$7 = (__this, __arguments, generator) => {
961
1008
  const useRegisterCarrier = () => {
962
1009
  const { client } = useShipEngine();
963
1010
  return reactQuery.useMutation({
964
- mutationFn: (carrier) => __async$7(void 0, null, function* () {
1011
+ mutationFn: (carrier) => __async$8(void 0, null, function* () {
965
1012
  const result = yield client.fundingSources.registerCarrier(carrier);
966
1013
  return result.data;
967
1014
  }),
@@ -986,7 +1033,7 @@ const useGetShipmentRates = (shipmentId, createdAtStart) => {
986
1033
  });
987
1034
  };
988
1035
 
989
- var __async$6 = (__this, __arguments, generator) => {
1036
+ var __async$7 = (__this, __arguments, generator) => {
990
1037
  return new Promise((resolve, reject) => {
991
1038
  var fulfilled = (value) => {
992
1039
  try {
@@ -1009,7 +1056,7 @@ var __async$6 = (__this, __arguments, generator) => {
1009
1056
  const useUpdateAccountSettings = () => {
1010
1057
  const { client } = useShipEngine();
1011
1058
  return reactQuery.useMutation({
1012
- mutationFn: (settings) => __async$6(void 0, null, function* () {
1059
+ mutationFn: (settings) => __async$7(void 0, null, function* () {
1013
1060
  const result = yield client.accountSettings.update(settings);
1014
1061
  return result.data;
1015
1062
  }),
@@ -1018,7 +1065,7 @@ const useUpdateAccountSettings = () => {
1018
1065
  });
1019
1066
  };
1020
1067
 
1021
- var __async$5 = (__this, __arguments, generator) => {
1068
+ var __async$6 = (__this, __arguments, generator) => {
1022
1069
  return new Promise((resolve, reject) => {
1023
1070
  var fulfilled = (value) => {
1024
1071
  try {
@@ -1042,7 +1089,7 @@ const useUpdateAutoFunding = (carrierId) => {
1042
1089
  const { client } = useShipEngine();
1043
1090
  const queryClient = reactQuery.useQueryClient();
1044
1091
  return reactQuery.useMutation({
1045
- mutationFn: (options) => __async$5(void 0, null, function* () {
1092
+ mutationFn: (options) => __async$6(void 0, null, function* () {
1046
1093
  const result = yield client.carriers.updateAutoFunding(carrierId, options);
1047
1094
  return result.data;
1048
1095
  }),
@@ -1054,7 +1101,7 @@ const useUpdateAutoFunding = (carrierId) => {
1054
1101
  });
1055
1102
  };
1056
1103
 
1057
- var __async$4 = (__this, __arguments, generator) => {
1104
+ var __async$5 = (__this, __arguments, generator) => {
1058
1105
  return new Promise((resolve, reject) => {
1059
1106
  var fulfilled = (value) => {
1060
1107
  try {
@@ -1077,7 +1124,7 @@ var __async$4 = (__this, __arguments, generator) => {
1077
1124
  const useUpdateFundingSource = () => {
1078
1125
  const { client } = useShipEngine();
1079
1126
  return reactQuery.useMutation({
1080
- mutationFn: (_0) => __async$4(void 0, [_0], function* ({
1127
+ mutationFn: (_0) => __async$5(void 0, [_0], function* ({
1081
1128
  billingInfo,
1082
1129
  creditCardInfo,
1083
1130
  fundingSourceId
@@ -1094,6 +1141,38 @@ const useUpdateFundingSource = () => {
1094
1141
  });
1095
1142
  };
1096
1143
 
1144
+ var __async$4 = (__this, __arguments, generator) => {
1145
+ return new Promise((resolve, reject) => {
1146
+ var fulfilled = (value) => {
1147
+ try {
1148
+ step(generator.next(value));
1149
+ } catch (e) {
1150
+ reject(e);
1151
+ }
1152
+ };
1153
+ var rejected = (value) => {
1154
+ try {
1155
+ step(generator.throw(value));
1156
+ } catch (e) {
1157
+ reject(e);
1158
+ }
1159
+ };
1160
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
1161
+ step((generator = generator.apply(__this, __arguments)).next());
1162
+ });
1163
+ };
1164
+ const useUpdateRateCard = () => {
1165
+ const { client } = useShipEngine();
1166
+ return reactQuery.useMutation({
1167
+ mutationFn: (rateCard) => __async$4(void 0, null, function* () {
1168
+ const result = yield client.rateCards.update(rateCard);
1169
+ return result.data;
1170
+ }),
1171
+ mutationKey: ["useUpdateRateCard"],
1172
+ onError
1173
+ });
1174
+ };
1175
+
1097
1176
  var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
1098
1177
  var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
1099
1178
  var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
@@ -1270,6 +1349,7 @@ exports.useCreateSalesOrderShipment = useCreateSalesOrderShipment;
1270
1349
  exports.useCreateShipment = useCreateShipment;
1271
1350
  exports.useCreateWarehouse = useCreateWarehouse;
1272
1351
  exports.useDeleteWarehouse = useDeleteWarehouse;
1352
+ exports.useDownloadRateCard = useDownloadRateCard;
1273
1353
  exports.useGetAccountSettings = useGetAccountSettings;
1274
1354
  exports.useGetAutoFundingConfiguration = useGetAutoFundingConfiguration;
1275
1355
  exports.useGetCarrierById = useGetCarrierById;
@@ -1278,8 +1358,10 @@ exports.useGetCurrenciesByCarrier = useGetCurrenciesByCarrier;
1278
1358
  exports.useGetFundingSourceById = useGetFundingSourceById;
1279
1359
  exports.useGetInsuranceAccount = useGetInsuranceAccount;
1280
1360
  exports.useGetLabel = useGetLabel;
1361
+ exports.useGetRatePackageFormatsByCarrier = useGetRatePackageFormatsByCarrier;
1281
1362
  exports.useGetSalesOrder = useGetSalesOrder;
1282
1363
  exports.useGetSalesOrderShipment = useGetSalesOrderShipment;
1364
+ exports.useGetServicesByCarrier = useGetServicesByCarrier;
1283
1365
  exports.useGetShipment = useGetShipment;
1284
1366
  exports.useGetShipmentRates = useGetShipmentRates;
1285
1367
  exports.useGetWalletHistory = useGetWalletHistory;
@@ -1302,6 +1384,7 @@ exports.useShipEngine = useShipEngine;
1302
1384
  exports.useUpdateAccountSettings = useUpdateAccountSettings;
1303
1385
  exports.useUpdateAutoFunding = useUpdateAutoFunding;
1304
1386
  exports.useUpdateFundingSource = useUpdateFundingSource;
1387
+ exports.useUpdateRateCard = useUpdateRateCard;
1305
1388
  exports.useUpdateSalesOrderShipment = useUpdateSalesOrderShipment;
1306
1389
  exports.useUpdateWarehouse = useUpdateWarehouse;
1307
1390
  exports.useValidateAddresses = useValidateAddresses;
package/index.mjs CHANGED
@@ -111,7 +111,7 @@ const retryUntil = (callbackFn, retries = 10, timeoutBetweenAttempts = 1e3) => P
111
111
  throw error;
112
112
  });
113
113
 
114
- var __async$k = (__this, __arguments, generator) => {
114
+ var __async$l = (__this, __arguments, generator) => {
115
115
  return new Promise((resolve, reject) => {
116
116
  var fulfilled = (value) => {
117
117
  try {
@@ -134,7 +134,7 @@ var __async$k = (__this, __arguments, generator) => {
134
134
  const useAddFunds = (carrierId) => {
135
135
  const { client } = useShipEngine();
136
136
  return useMutation({
137
- mutationFn: (funds) => __async$k(void 0, null, function* () {
137
+ mutationFn: (funds) => __async$l(void 0, null, function* () {
138
138
  const result = yield client.carriers.addFunds(carrierId, funds);
139
139
  return result.data;
140
140
  }),
@@ -143,7 +143,7 @@ const useAddFunds = (carrierId) => {
143
143
  });
144
144
  };
145
145
 
146
- var __async$j = (__this, __arguments, generator) => {
146
+ var __async$k = (__this, __arguments, generator) => {
147
147
  return new Promise((resolve, reject) => {
148
148
  var fulfilled = (value) => {
149
149
  try {
@@ -166,7 +166,7 @@ var __async$j = (__this, __arguments, generator) => {
166
166
  const useCalculateRates = () => {
167
167
  const { client } = useShipEngine();
168
168
  return useMutation({
169
- mutationFn: (_0) => __async$j(void 0, [_0], function* ({ rateOptions, shipmentId }) {
169
+ mutationFn: (_0) => __async$k(void 0, [_0], function* ({ rateOptions, shipmentId }) {
170
170
  const result = yield client.rates.calculateByShipmentId(shipmentId, rateOptions);
171
171
  return result.data;
172
172
  }),
@@ -175,7 +175,7 @@ const useCalculateRates = () => {
175
175
  });
176
176
  };
177
177
 
178
- var __async$i = (__this, __arguments, generator) => {
178
+ var __async$j = (__this, __arguments, generator) => {
179
179
  return new Promise((resolve, reject) => {
180
180
  var fulfilled = (value) => {
181
181
  try {
@@ -198,7 +198,7 @@ var __async$i = (__this, __arguments, generator) => {
198
198
  const useConnectCarrier = () => {
199
199
  const { client } = useShipEngine();
200
200
  return useMutation({
201
- mutationFn: (params) => __async$i(void 0, null, function* () {
201
+ mutationFn: (params) => __async$j(void 0, null, function* () {
202
202
  const result = yield client.carriers.connect(params);
203
203
  return result.data;
204
204
  }),
@@ -207,7 +207,7 @@ const useConnectCarrier = () => {
207
207
  });
208
208
  };
209
209
 
210
- var __async$h = (__this, __arguments, generator) => {
210
+ var __async$i = (__this, __arguments, generator) => {
211
211
  return new Promise((resolve, reject) => {
212
212
  var fulfilled = (value) => {
213
213
  try {
@@ -230,7 +230,7 @@ var __async$h = (__this, __arguments, generator) => {
230
230
  const useCreateFundingSource = () => {
231
231
  const { client } = useShipEngine();
232
232
  return useMutation({
233
- mutationFn: (fundingSource) => __async$h(void 0, null, function* () {
233
+ mutationFn: (fundingSource) => __async$i(void 0, null, function* () {
234
234
  const result = yield client.fundingSources.create(fundingSource);
235
235
  return result.data;
236
236
  }),
@@ -254,7 +254,7 @@ var __objRest$5 = (source, exclude) => {
254
254
  }
255
255
  return target;
256
256
  };
257
- var __async$g = (__this, __arguments, generator) => {
257
+ var __async$h = (__this, __arguments, generator) => {
258
258
  return new Promise((resolve, reject) => {
259
259
  var fulfilled = (value) => {
260
260
  try {
@@ -277,7 +277,7 @@ var __async$g = (__this, __arguments, generator) => {
277
277
  const useCreateLabel = () => {
278
278
  const { client } = useShipEngine();
279
279
  return useMutation({
280
- mutationFn: (_a) => __async$g(void 0, null, function* () {
280
+ mutationFn: (_a) => __async$h(void 0, null, function* () {
281
281
  var _b = _a, { rateId } = _b, options = __objRest$5(_b, ["rateId"]);
282
282
  const result = yield client.labels.createByRateId(rateId, options);
283
283
  return result.data;
@@ -287,7 +287,7 @@ const useCreateLabel = () => {
287
287
  });
288
288
  };
289
289
 
290
- var __async$f = (__this, __arguments, generator) => {
290
+ var __async$g = (__this, __arguments, generator) => {
291
291
  return new Promise((resolve, reject) => {
292
292
  var fulfilled = (value) => {
293
293
  try {
@@ -310,7 +310,7 @@ var __async$f = (__this, __arguments, generator) => {
310
310
  const useCreateRateCard = () => {
311
311
  const { client } = useShipEngine();
312
312
  return useMutation({
313
- mutationFn: (rateCard) => __async$f(void 0, null, function* () {
313
+ mutationFn: (rateCard) => __async$g(void 0, null, function* () {
314
314
  const result = yield client.rateCards.create(rateCard);
315
315
  return result.data;
316
316
  }),
@@ -334,7 +334,7 @@ var __objRest$4 = (source, exclude) => {
334
334
  }
335
335
  return target;
336
336
  };
337
- var __async$e = (__this, __arguments, generator) => {
337
+ var __async$f = (__this, __arguments, generator) => {
338
338
  return new Promise((resolve, reject) => {
339
339
  var fulfilled = (value) => {
340
340
  try {
@@ -357,7 +357,7 @@ var __async$e = (__this, __arguments, generator) => {
357
357
  const useCreateSalesOrderShipment = () => {
358
358
  const { client } = useShipEngine();
359
359
  return useMutation({
360
- mutationFn: (_a) => __async$e(void 0, null, function* () {
360
+ mutationFn: (_a) => __async$f(void 0, null, function* () {
361
361
  var _b = _a, { salesOrderId } = _b, shipment = __objRest$4(_b, ["salesOrderId"]);
362
362
  const result = yield client.salesOrderShipments.create(salesOrderId, shipment);
363
363
  return result.data;
@@ -386,7 +386,7 @@ var __spreadValues = (a, b) => {
386
386
  return a;
387
387
  };
388
388
  var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
389
- var __async$d = (__this, __arguments, generator) => {
389
+ var __async$e = (__this, __arguments, generator) => {
390
390
  return new Promise((resolve, reject) => {
391
391
  var fulfilled = (value) => {
392
392
  try {
@@ -409,7 +409,7 @@ var __async$d = (__this, __arguments, generator) => {
409
409
  const useCreateShipment = () => {
410
410
  const { client } = useShipEngine();
411
411
  return useMutation({
412
- mutationFn: (shipment) => __async$d(void 0, null, function* () {
412
+ mutationFn: (shipment) => __async$e(void 0, null, function* () {
413
413
  var _a;
414
414
  if (shipment.warehouseId === void 0) {
415
415
  throw new SE.CodedError("errorMessages.noWarehouses", {
@@ -436,7 +436,7 @@ const useCreateShipment = () => {
436
436
  });
437
437
  };
438
438
 
439
- var __async$c = (__this, __arguments, generator) => {
439
+ var __async$d = (__this, __arguments, generator) => {
440
440
  return new Promise((resolve, reject) => {
441
441
  var fulfilled = (value) => {
442
442
  try {
@@ -459,7 +459,7 @@ var __async$c = (__this, __arguments, generator) => {
459
459
  const useCreateWarehouse = () => {
460
460
  const { client } = useShipEngine();
461
461
  return useMutation({
462
- mutationFn: (data) => __async$c(void 0, null, function* () {
462
+ mutationFn: (data) => __async$d(void 0, null, function* () {
463
463
  const result = yield client.warehouses.create(data);
464
464
  return result.data;
465
465
  }),
@@ -468,7 +468,7 @@ const useCreateWarehouse = () => {
468
468
  });
469
469
  };
470
470
 
471
- var __async$b = (__this, __arguments, generator) => {
471
+ var __async$c = (__this, __arguments, generator) => {
472
472
  return new Promise((resolve, reject) => {
473
473
  var fulfilled = (value) => {
474
474
  try {
@@ -491,7 +491,7 @@ var __async$b = (__this, __arguments, generator) => {
491
491
  const useDeleteWarehouse = () => {
492
492
  const { client } = useShipEngine();
493
493
  return useMutation({
494
- mutationFn: (_0) => __async$b(void 0, [_0], function* ({ warehouseId }) {
494
+ mutationFn: (_0) => __async$c(void 0, [_0], function* ({ warehouseId }) {
495
495
  const result = yield client.warehouses.delete(warehouseId);
496
496
  return result.data;
497
497
  }),
@@ -500,6 +500,19 @@ const useDeleteWarehouse = () => {
500
500
  });
501
501
  };
502
502
 
503
+ const useDownloadRateCard = (rateCardId) => {
504
+ const { client } = useShipEngine();
505
+ return useQuery({
506
+ enabled: !!rateCardId.length,
507
+ onError,
508
+ queryFn: () => {
509
+ return client.rateCards.download(rateCardId);
510
+ },
511
+ queryKey: ["useDownloadRateCard", rateCardId],
512
+ select: (result) => result.data
513
+ });
514
+ };
515
+
503
516
  const useGetAccountSettings = () => {
504
517
  const { client } = useShipEngine();
505
518
  return useQuery({
@@ -582,6 +595,23 @@ const useGetLabel = (labelId) => {
582
595
  });
583
596
  };
584
597
 
598
+ const useGetRatePackageFormatsByCarrier = (carrierId) => {
599
+ const { client } = useShipEngine();
600
+ return useQuery({
601
+ enabled: !!carrierId,
602
+ onError,
603
+ queryFn: () => {
604
+ if (carrierId)
605
+ return client.carriers.getRatePackageFormats(carrierId);
606
+ return Promise.reject(new Error("carrierId is required"));
607
+ },
608
+ queryKey: ["useGetRatePackageFormatsByCarrier", carrierId],
609
+ select: (result) => result.data.ratePackageFormats,
610
+ // Fresh for 5 minutes
611
+ staleTime: 5 * 60 * 1e3
612
+ });
613
+ };
614
+
585
615
  const useGetSalesOrder = (salesOrderId) => {
586
616
  const { client } = useShipEngine();
587
617
  return useQuery({
@@ -612,6 +642,23 @@ const useGetSalesOrderShipment = (shipmentId) => {
612
642
  });
613
643
  };
614
644
 
645
+ const useGetServicesByCarrier = (carrierId) => {
646
+ const { client } = useShipEngine();
647
+ return useQuery({
648
+ enabled: !!carrierId,
649
+ onError,
650
+ queryFn: () => {
651
+ if (carrierId)
652
+ return client.carriers.getServices(carrierId);
653
+ return Promise.reject(new Error("carrierId is required"));
654
+ },
655
+ queryKey: ["useGetServicesByCarrier", carrierId],
656
+ select: (result) => result.data.services,
657
+ // Fresh for 5 minutes
658
+ staleTime: 5 * 60 * 1e3
659
+ });
660
+ };
661
+
615
662
  const useGetShipment = (shipmentId) => {
616
663
  const { client } = useShipEngine();
617
664
  return useQuery({
@@ -820,7 +867,7 @@ var __objRest$2 = (source, exclude) => {
820
867
  }
821
868
  return target;
822
869
  };
823
- var __async$a = (__this, __arguments, generator) => {
870
+ var __async$b = (__this, __arguments, generator) => {
824
871
  return new Promise((resolve, reject) => {
825
872
  var fulfilled = (value) => {
826
873
  try {
@@ -843,7 +890,7 @@ var __async$a = (__this, __arguments, generator) => {
843
890
  const useNotifySalesOrderShipped = () => {
844
891
  const { client } = useShipEngine();
845
892
  return useMutation({
846
- mutationFn: (_a) => __async$a(void 0, null, function* () {
893
+ mutationFn: (_a) => __async$b(void 0, null, function* () {
847
894
  var _b = _a, { salesOrderId } = _b, tracking = __objRest$2(_b, ["salesOrderId"]);
848
895
  const result = yield client.salesOrders.notifyShipped(salesOrderId, tracking);
849
896
  return result.data;
@@ -853,7 +900,7 @@ const useNotifySalesOrderShipped = () => {
853
900
  });
854
901
  };
855
902
 
856
- var __async$9 = (__this, __arguments, generator) => {
903
+ var __async$a = (__this, __arguments, generator) => {
857
904
  return new Promise((resolve, reject) => {
858
905
  var fulfilled = (value) => {
859
906
  try {
@@ -876,7 +923,7 @@ var __async$9 = (__this, __arguments, generator) => {
876
923
  const useParseAddress = () => {
877
924
  const { client } = useShipEngine();
878
925
  return useMutation({
879
- mutationFn: (_0) => __async$9(void 0, [_0], function* ({ address, text }) {
926
+ mutationFn: (_0) => __async$a(void 0, [_0], function* ({ address, text }) {
880
927
  const result = yield client.addresses.parse(text, address);
881
928
  return result.data;
882
929
  }),
@@ -885,7 +932,7 @@ const useParseAddress = () => {
885
932
  });
886
933
  };
887
934
 
888
- var __async$8 = (__this, __arguments, generator) => {
935
+ var __async$9 = (__this, __arguments, generator) => {
889
936
  return new Promise((resolve, reject) => {
890
937
  var fulfilled = (value) => {
891
938
  try {
@@ -908,7 +955,7 @@ var __async$8 = (__this, __arguments, generator) => {
908
955
  const useRefreshOrderSourceAsync = () => {
909
956
  const { client } = useShipEngine();
910
957
  return useMutation({
911
- mutationFn: (orderSourceId) => __async$8(void 0, null, function* () {
958
+ mutationFn: (orderSourceId) => __async$9(void 0, null, function* () {
912
959
  const result = yield client.orderSources.refresh(orderSourceId);
913
960
  return result.data;
914
961
  }),
@@ -919,9 +966,9 @@ const useRefreshOrderSource = () => {
919
966
  const { client } = useShipEngine();
920
967
  const { mutateAsync: refreshOrderSourceAsync } = useRefreshOrderSourceAsync();
921
968
  return useMutation({
922
- mutationFn: (orderSourceId) => __async$8(void 0, null, function* () {
969
+ mutationFn: (orderSourceId) => __async$9(void 0, null, function* () {
923
970
  yield refreshOrderSourceAsync(orderSourceId);
924
- const waitResult = yield retryUntil(() => __async$8(void 0, null, function* () {
971
+ const waitResult = yield retryUntil(() => __async$9(void 0, null, function* () {
925
972
  const { data: checkResult } = yield client.orderSources.get(orderSourceId);
926
973
  if (["preparing_update", "updating"].includes(checkResult.refreshInfo.status)) {
927
974
  throw new SE.CodedError("Order source is still refreshing");
@@ -935,7 +982,7 @@ const useRefreshOrderSource = () => {
935
982
  });
936
983
  };
937
984
 
938
- var __async$7 = (__this, __arguments, generator) => {
985
+ var __async$8 = (__this, __arguments, generator) => {
939
986
  return new Promise((resolve, reject) => {
940
987
  var fulfilled = (value) => {
941
988
  try {
@@ -958,7 +1005,7 @@ var __async$7 = (__this, __arguments, generator) => {
958
1005
  const useRegisterCarrier = () => {
959
1006
  const { client } = useShipEngine();
960
1007
  return useMutation({
961
- mutationFn: (carrier) => __async$7(void 0, null, function* () {
1008
+ mutationFn: (carrier) => __async$8(void 0, null, function* () {
962
1009
  const result = yield client.fundingSources.registerCarrier(carrier);
963
1010
  return result.data;
964
1011
  }),
@@ -983,7 +1030,7 @@ const useGetShipmentRates = (shipmentId, createdAtStart) => {
983
1030
  });
984
1031
  };
985
1032
 
986
- var __async$6 = (__this, __arguments, generator) => {
1033
+ var __async$7 = (__this, __arguments, generator) => {
987
1034
  return new Promise((resolve, reject) => {
988
1035
  var fulfilled = (value) => {
989
1036
  try {
@@ -1006,7 +1053,7 @@ var __async$6 = (__this, __arguments, generator) => {
1006
1053
  const useUpdateAccountSettings = () => {
1007
1054
  const { client } = useShipEngine();
1008
1055
  return useMutation({
1009
- mutationFn: (settings) => __async$6(void 0, null, function* () {
1056
+ mutationFn: (settings) => __async$7(void 0, null, function* () {
1010
1057
  const result = yield client.accountSettings.update(settings);
1011
1058
  return result.data;
1012
1059
  }),
@@ -1015,7 +1062,7 @@ const useUpdateAccountSettings = () => {
1015
1062
  });
1016
1063
  };
1017
1064
 
1018
- var __async$5 = (__this, __arguments, generator) => {
1065
+ var __async$6 = (__this, __arguments, generator) => {
1019
1066
  return new Promise((resolve, reject) => {
1020
1067
  var fulfilled = (value) => {
1021
1068
  try {
@@ -1039,7 +1086,7 @@ const useUpdateAutoFunding = (carrierId) => {
1039
1086
  const { client } = useShipEngine();
1040
1087
  const queryClient = useQueryClient();
1041
1088
  return useMutation({
1042
- mutationFn: (options) => __async$5(void 0, null, function* () {
1089
+ mutationFn: (options) => __async$6(void 0, null, function* () {
1043
1090
  const result = yield client.carriers.updateAutoFunding(carrierId, options);
1044
1091
  return result.data;
1045
1092
  }),
@@ -1051,7 +1098,7 @@ const useUpdateAutoFunding = (carrierId) => {
1051
1098
  });
1052
1099
  };
1053
1100
 
1054
- var __async$4 = (__this, __arguments, generator) => {
1101
+ var __async$5 = (__this, __arguments, generator) => {
1055
1102
  return new Promise((resolve, reject) => {
1056
1103
  var fulfilled = (value) => {
1057
1104
  try {
@@ -1074,7 +1121,7 @@ var __async$4 = (__this, __arguments, generator) => {
1074
1121
  const useUpdateFundingSource = () => {
1075
1122
  const { client } = useShipEngine();
1076
1123
  return useMutation({
1077
- mutationFn: (_0) => __async$4(void 0, [_0], function* ({
1124
+ mutationFn: (_0) => __async$5(void 0, [_0], function* ({
1078
1125
  billingInfo,
1079
1126
  creditCardInfo,
1080
1127
  fundingSourceId
@@ -1091,6 +1138,38 @@ const useUpdateFundingSource = () => {
1091
1138
  });
1092
1139
  };
1093
1140
 
1141
+ var __async$4 = (__this, __arguments, generator) => {
1142
+ return new Promise((resolve, reject) => {
1143
+ var fulfilled = (value) => {
1144
+ try {
1145
+ step(generator.next(value));
1146
+ } catch (e) {
1147
+ reject(e);
1148
+ }
1149
+ };
1150
+ var rejected = (value) => {
1151
+ try {
1152
+ step(generator.throw(value));
1153
+ } catch (e) {
1154
+ reject(e);
1155
+ }
1156
+ };
1157
+ var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
1158
+ step((generator = generator.apply(__this, __arguments)).next());
1159
+ });
1160
+ };
1161
+ const useUpdateRateCard = () => {
1162
+ const { client } = useShipEngine();
1163
+ return useMutation({
1164
+ mutationFn: (rateCard) => __async$4(void 0, null, function* () {
1165
+ const result = yield client.rateCards.update(rateCard);
1166
+ return result.data;
1167
+ }),
1168
+ mutationKey: ["useUpdateRateCard"],
1169
+ onError
1170
+ });
1171
+ };
1172
+
1094
1173
  var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
1095
1174
  var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
1096
1175
  var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
@@ -1251,4 +1330,4 @@ const useVoidLabel = () => {
1251
1330
  });
1252
1331
  };
1253
1332
 
1254
- export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteWarehouse, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetSalesOrder, useGetSalesOrderShipment, useGetShipment, useGetShipmentRates, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateSalesOrderShipment, useUpdateWarehouse, useValidateAddresses, useVoidLabel };
1333
+ export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteWarehouse, useDownloadRateCard, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetRatePackageFormatsByCarrier, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useValidateAddresses, useVoidLabel };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/react-api",
3
- "version": "0.14.0",
3
+ "version": "0.15.0",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {