@shipengine/elements 1.6.0 → 1.7.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.
Files changed (61) hide show
  1. package/index.cjs +1286 -1130
  2. package/index.js +1283 -1130
  3. package/package.json +1 -1
  4. package/src/components/collapsible-panel/collapsible-panel.d.ts +6 -1
  5. package/src/components/collapsible-panel/collapsible-panel.styles.d.ts +1 -1
  6. package/src/components/field/rate-card/cost-breakdown/cost-breakdown.d.ts +1 -1
  7. package/src/components/templates/address-form/address-schema.d.ts +2 -0
  8. package/src/components/templates/index.d.ts +1 -1
  9. package/src/components/templates/rate-form/rate-form.d.ts +2 -1
  10. package/src/components/templates/wallet-form/wallet-schema.d.ts +46 -2
  11. package/src/elements/external-carriers/external-carriers.d.ts +7 -5
  12. package/src/elements/index.d.ts +2 -1
  13. package/src/elements/label-layout/label-layout-element.d.ts +7 -1
  14. package/src/elements/labels-grid/labels-grid.d.ts +7 -1
  15. package/src/elements/manage-funding/manage-funding-element.d.ts +7 -1
  16. package/src/elements/manage-warehouses/manage-warehouses.d.ts +10 -44
  17. package/src/elements/payment-method-settings/payment-method-settings-element.d.ts +7 -1
  18. package/src/elements/purchase-label/purchase-label.d.ts +11 -5
  19. package/src/elements/shipengine-carriers/index.d.ts +1 -0
  20. package/src/elements/{list-carriers/list-carriers.d.ts → shipengine-carriers/shipengine-carriers.d.ts} +46 -37
  21. package/src/elements/shipments-grid/shipments-grid.d.ts +7 -1
  22. package/src/elements/theme-creator/theme-creator.d.ts +7 -1
  23. package/src/elements/unit-settings/unit-settings-element.d.ts +7 -1
  24. package/src/elements/view-shipment/view-shipment.d.ts +17 -13
  25. package/src/elements/void-label/void-label.d.ts +16 -11
  26. package/src/elements/wallet-history/wallet-history-element.d.ts +7 -1
  27. package/src/features/index.d.ts +1 -1
  28. package/src/features/label-layout/label-layout.d.ts +6 -1
  29. package/src/features/label-layout/use-label-layout.d.ts +3 -3
  30. package/src/features/manage-warehouses/index.d.ts +1 -0
  31. package/src/features/manage-warehouses/manage-warehouses.d.ts +16 -1
  32. package/src/features/manage-warehouses/use-manage-warehouses.d.ts +15 -0
  33. package/src/features/shipengine-carriers/hooks/use-carrier-metadata.d.ts +13 -0
  34. package/src/features/shipengine-carriers/index.d.ts +1 -0
  35. package/src/features/shipengine-carriers/shipengine-carriers-row/index.d.ts +1 -0
  36. package/src/features/{list-carriers/list-carriers-row/list-carriers-row.d.ts → shipengine-carriers/shipengine-carriers-row/shipengine-carriers-row.d.ts} +2 -2
  37. package/src/features/shipengine-carriers/shipengine-carriers.d.ts +10 -0
  38. package/src/features/unit-settings/index.d.ts +1 -0
  39. package/src/features/unit-settings/unit-settings.d.ts +9 -1
  40. package/src/features/unit-settings/use-unit-settings.d.ts +10 -0
  41. package/src/locales/en/index.d.ts +7 -1
  42. package/src/types/carrier-metadata.d.ts +3 -0
  43. package/src/utilities/feature-flags.d.ts +5 -2
  44. package/src/workflows/account-settings/account-settings.d.ts +14 -11
  45. package/src/workflows/account-settings/use-get-panel-props.d.ts +7 -1
  46. package/src/workflows/connect-carrier/connect-carrier.d.ts +7 -1
  47. package/src/workflows/manage-wallet-workflow/index.d.ts +1 -0
  48. package/src/workflows/manage-wallet-workflow/manage-wallet-workflow.d.ts +828 -0
  49. package/src/workflows/manage-wallet-workflow/use-get-wallet-panel-props.d.ts +4 -0
  50. package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.d.ts +2 -2
  51. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.d.ts +2 -1
  52. package/src/workflows/onboarding/onboarding.d.ts +11 -6
  53. package/src/elements/list-carriers/index.d.ts +0 -1
  54. package/src/features/list-carriers/hooks/use-carrier-metadata.d.ts +0 -10
  55. package/src/features/list-carriers/index.d.ts +0 -1
  56. package/src/features/list-carriers/list-carriers-row/index.d.ts +0 -1
  57. package/src/features/list-carriers/list-carriers.d.ts +0 -9
  58. /package/src/features/{list-carriers → shipengine-carriers}/hooks/index.d.ts +0 -0
  59. /package/src/features/{list-carriers → shipengine-carriers}/hooks/use-list-connected-carriers.d.ts +0 -0
  60. /package/src/features/{list-carriers/list-carriers-row/list-carriers-row.styles.d.ts → shipengine-carriers/shipengine-carriers-row/shipengine-carriers-row.styles.d.ts} +0 -0
  61. /package/src/features/{list-carriers/list-carriers.styles.d.ts → shipengine-carriers/shipengine-carriers.styles.d.ts} +0 -0
@@ -1,22 +1,22 @@
1
1
  /// <reference types="react" />
2
- import { ListCarriersFeatures } from "../../features/list-carriers";
2
+ import { ShipEngineCarriersFeatures } from "../../features/shipengine-carriers";
3
3
  /**
4
- * # List-Carriers Props
4
+ * # ShipEngine-Carriers Props
5
5
  *
6
- * @see {@link ListCarriers.Component | The `<List-Carriers />` component}
6
+ * @see {@link ShipEngineCarriers.Element | The `<ShipEngine-Carriers />` component}
7
7
  */
8
8
  export type ComponentProps = {
9
9
  /**
10
10
  * `features` is a set of feature flags you would like to enable or disable in this component.
11
11
  */
12
- features?: ListCarriersFeatures;
12
+ features?: ShipEngineCarriersFeatures;
13
13
  };
14
14
  /**
15
- * # List-Carriers Component
15
+ * # ShipEngine-Carriers Element
16
16
  *
17
- * @param ComponentProps The base props that will be passed into the `<List-Carriers />` component.
17
+ * @param ComponentProps The base props that will be passed into the `<ShipEngine-Carriers />` component.
18
18
  *
19
- * @returns Element A React element that renders the `<List-Carriers />` component allowing users
19
+ * @returns Element A React element that renders the `<ShipEngine-Carriers />` component allowing users
20
20
  * to view a list of carriers that are connected to their ShipEngine account. This component is
21
21
  * composed in the `<AccountSettings />` Element.
22
22
  *
@@ -25,14 +25,14 @@ export type ComponentProps = {
25
25
  * (() => {
26
26
  * const features = useFeatures("Global");
27
27
  *
28
- * return <ListCarriers.Component features={features} />;
28
+ * return <ShipEngineCarriers.Element features={features} />;
29
29
  * })();
30
30
  * ```
31
31
  *
32
32
  * <br />
33
33
  *
34
- * @see {@link ListCarriers.ComponentProps | The props that are passed into the `<List-Carriers />` component}
35
- * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<List-Carriers />` component}
34
+ * @see {@link ShipEngineCarriers.ComponentProps | The props that are passed into the `<ShipEngine-Carriers />` component}
35
+ * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ShipEngine-Carriers />` component}
36
36
  */
37
37
  export declare const Component: ({ features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
38
38
  export declare const Element: ({ resources, ...props }: ComponentProps & {
@@ -117,6 +117,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
117
117
  setup: {
118
118
  title: string;
119
119
  subtitle: string;
120
+ hiddenTermsSubtitle: string;
120
121
  descriptionTitle: string;
121
122
  description: string;
122
123
  };
@@ -246,6 +247,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
246
247
  needToAcknowledge: string;
247
248
  };
248
249
  rates: {
250
+ requestedShippingNotification: string;
249
251
  uspsMediaMailAcknowledgement: string;
250
252
  uspsFirstClassMailAcknowledgement_leof: string;
251
253
  rateSavings: string;
@@ -328,6 +330,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
328
330
  aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
329
331
  "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
330
332
  aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
333
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
334
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
331
335
  };
332
336
  termsAndAgreementTitles: {
333
337
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -335,6 +339,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
335
339
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
336
340
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
337
341
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
342
+ "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
343
+ UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
338
344
  };
339
345
  };
340
346
  "manage-defaults": {
@@ -382,9 +388,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
382
388
  isDefault: string;
383
389
  locationName: string;
384
390
  residentialAddress: string;
385
- returnTo: string; /**
386
- * `features` is a set of feature flags you would like to enable or disable in this component.
387
- */
391
+ returnTo: string;
388
392
  returnToAddressIsDifferent: string;
389
393
  setDefault: string;
390
394
  shipFrom: string;
@@ -398,6 +402,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
398
402
  };
399
403
  autoFunding: {
400
404
  edit: string;
405
+ /**
406
+ * # ShipEngine-Carriers Props
407
+ *
408
+ * @see {@link ShipEngineCarriers.Element | The `<ShipEngine-Carriers />` component}
409
+ */
401
410
  editSettings: string;
402
411
  error: {
403
412
  title: string;
@@ -472,7 +481,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
472
481
  };
473
482
  };
474
483
  };
475
- "list-carriers": {
484
+ "shipengine-carriers": {
476
485
  title: string;
477
486
  headers: {
478
487
  accountCarriers: string;
@@ -784,6 +793,29 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
784
793
  registrationForm: {
785
794
  error: string;
786
795
  title: string;
796
+ /**
797
+ * # ShipEngine-Carriers Element
798
+ *
799
+ * @param ComponentProps The base props that will be passed into the `<ShipEngine-Carriers />` component.
800
+ *
801
+ * @returns Element A React element that renders the `<ShipEngine-Carriers />` component allowing users
802
+ * to view a list of carriers that are connected to their ShipEngine account. This component is
803
+ * composed in the `<AccountSettings />` Element.
804
+ *
805
+ * @example
806
+ * ```tsx
807
+ * (() => {
808
+ * const features = useFeatures("Global");
809
+ *
810
+ * return <ShipEngineCarriers.Element features={features} />;
811
+ * })();
812
+ * ```
813
+ *
814
+ * <br />
815
+ *
816
+ * @see {@link ShipEngineCarriers.ComponentProps | The props that are passed into the `<ShipEngine-Carriers />` component}
817
+ * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ShipEngine-Carriers />` component}
818
+ */
787
819
  betaWarning: string;
788
820
  };
789
821
  search: string;
@@ -811,29 +843,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
811
843
  adjustmentHistory: string;
812
844
  warehouses: string;
813
845
  carriers: string;
814
- /**
815
- * # List-Carriers Component
816
- *
817
- * @param ComponentProps The base props that will be passed into the `<List-Carriers />` component.
818
- *
819
- * @returns Element A React element that renders the `<List-Carriers />` component allowing users
820
- * to view a list of carriers that are connected to their ShipEngine account. This component is
821
- * composed in the `<AccountSettings />` Element.
822
- *
823
- * @example
824
- * ```tsx
825
- * (() => {
826
- * const features = useFeatures("Global");
827
- *
828
- * return <ListCarriers.Component features={features} />;
829
- * })();
830
- * ```
831
- *
832
- * <br />
833
- *
834
- * @see {@link ListCarriers.ComponentProps | The props that are passed into the `<List-Carriers />` component}
835
- * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<List-Carriers />` component}
836
- */
837
846
  externalCarriers: string;
838
847
  labelLayout: string;
839
848
  unitSettings: string;
@@ -85,6 +85,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
85
85
  setup: {
86
86
  title: string;
87
87
  subtitle: string;
88
+ hiddenTermsSubtitle: string;
88
89
  descriptionTitle: string;
89
90
  description: string;
90
91
  };
@@ -214,6 +215,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
214
215
  needToAcknowledge: string;
215
216
  };
216
217
  rates: {
218
+ requestedShippingNotification: string;
217
219
  uspsMediaMailAcknowledgement: string;
218
220
  uspsFirstClassMailAcknowledgement_leof: string;
219
221
  rateSavings: string;
@@ -296,6 +298,8 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
296
298
  aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
297
299
  "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
298
300
  aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
301
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
302
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
299
303
  };
300
304
  termsAndAgreementTitles: {
301
305
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -303,6 +307,8 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
303
307
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
304
308
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
305
309
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
310
+ "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
311
+ UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
306
312
  };
307
313
  };
308
314
  "manage-defaults": {
@@ -438,7 +444,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
438
444
  };
439
445
  };
440
446
  };
441
- "list-carriers": {
447
+ "shipengine-carriers": {
442
448
  title: string;
443
449
  headers: {
444
450
  accountCarriers: string;
@@ -95,6 +95,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
95
95
  setup: {
96
96
  title: string;
97
97
  subtitle: string;
98
+ hiddenTermsSubtitle: string;
98
99
  descriptionTitle: string;
99
100
  description: string;
100
101
  };
@@ -224,6 +225,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
224
225
  needToAcknowledge: string;
225
226
  };
226
227
  rates: {
228
+ requestedShippingNotification: string;
227
229
  uspsMediaMailAcknowledgement: string;
228
230
  uspsFirstClassMailAcknowledgement_leof: string;
229
231
  rateSavings: string;
@@ -306,6 +308,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
306
308
  aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
307
309
  "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
308
310
  aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
311
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
312
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
309
313
  };
310
314
  termsAndAgreementTitles: {
311
315
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -313,6 +317,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
313
317
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
314
318
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
315
319
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
320
+ "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
321
+ UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
316
322
  };
317
323
  };
318
324
  "manage-defaults": {
@@ -448,7 +454,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
448
454
  };
449
455
  };
450
456
  };
451
- "list-carriers": {
457
+ "shipengine-carriers": {
452
458
  title: string;
453
459
  headers: {
454
460
  accountCarriers: string;
@@ -82,6 +82,7 @@ export declare const Element: ({ resources, ...props }: object & {
82
82
  setup: {
83
83
  title: string;
84
84
  subtitle: string;
85
+ hiddenTermsSubtitle: string;
85
86
  descriptionTitle: string;
86
87
  description: string;
87
88
  };
@@ -211,6 +212,7 @@ export declare const Element: ({ resources, ...props }: object & {
211
212
  needToAcknowledge: string;
212
213
  };
213
214
  rates: {
215
+ requestedShippingNotification: string;
214
216
  uspsMediaMailAcknowledgement: string;
215
217
  uspsFirstClassMailAcknowledgement_leof: string;
216
218
  rateSavings: string;
@@ -293,6 +295,8 @@ export declare const Element: ({ resources, ...props }: object & {
293
295
  aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
294
296
  "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
295
297
  aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
298
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
299
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
296
300
  };
297
301
  termsAndAgreementTitles: {
298
302
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -300,6 +304,8 @@ export declare const Element: ({ resources, ...props }: object & {
300
304
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
301
305
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
302
306
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
307
+ "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
308
+ UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
303
309
  };
304
310
  };
305
311
  "manage-defaults": {
@@ -435,7 +441,7 @@ export declare const Element: ({ resources, ...props }: object & {
435
441
  };
436
442
  };
437
443
  };
438
- "list-carriers": {
444
+ "shipengine-carriers": {
439
445
  title: string;
440
446
  headers: {
441
447
  accountCarriers: string;
@@ -162,7 +162,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
162
162
  highVolumeForms: string;
163
163
  multipleShippingServices: string;
164
164
  sections: {
165
- labels: string;
165
+ labels: string; /**
166
+ * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
167
+ * `Void Label` button.
168
+ */
166
169
  };
167
170
  noLabels: string;
168
171
  };
@@ -171,25 +174,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
171
174
  setup: {
172
175
  title: string;
173
176
  subtitle: string;
177
+ hiddenTermsSubtitle: string;
174
178
  descriptionTitle: string;
175
179
  description: string;
176
180
  };
177
181
  billing: {
178
- title: string; /**
179
- * # View Shipment Component Props
180
- *
181
- * - These are the base props that will be passed into the `<ViewShipment />` component.
182
- *
183
- * @see {@link ViewShipment.Component | This prop types usage in the `<ViewShipment />` component}
184
- */
182
+ title: string;
185
183
  cardSubTitle: string;
186
184
  addressSubTitle: string;
187
185
  info: string;
188
186
  };
189
187
  carriers: {
190
- title: string; /**
191
- * `features` is a set of feature flags you would like to enable or disable in this component.
192
- */
188
+ title: string;
193
189
  subtitle: string;
194
190
  };
195
191
  notifications: {
@@ -197,7 +193,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
197
193
  title: string;
198
194
  };
199
195
  info: {
200
- title: string;
196
+ title: string; /**
197
+ * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
198
+ * `Purchase Label` button.
199
+ */
201
200
  description: string;
202
201
  };
203
202
  poBox: {
@@ -310,6 +309,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
310
309
  needToAcknowledge: string;
311
310
  };
312
311
  rates: {
312
+ requestedShippingNotification: string;
313
313
  uspsMediaMailAcknowledgement: string;
314
314
  uspsFirstClassMailAcknowledgement_leof: string;
315
315
  rateSavings: string;
@@ -392,6 +392,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
392
392
  aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
393
393
  "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
394
394
  aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
395
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
396
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
395
397
  };
396
398
  termsAndAgreementTitles: {
397
399
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -399,6 +401,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
399
401
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
400
402
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
401
403
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
404
+ "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
405
+ UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
402
406
  };
403
407
  };
404
408
  "manage-defaults": {
@@ -540,7 +544,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
540
544
  };
541
545
  };
542
546
  };
543
- "list-carriers": {
547
+ "shipengine-carriers": {
544
548
  title: string;
545
549
  headers: {
546
550
  accountCarriers: string;
@@ -168,7 +168,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
168
168
  highVolumeForms: string;
169
169
  multipleShippingServices: string;
170
170
  sections: {
171
- labels: string;
171
+ labels: string; /**
172
+ * `onSuccess` is a callback function that will be invoked when the request to void a given
173
+ * shipping label is successful.
174
+ */
172
175
  };
173
176
  noLabels: string;
174
177
  };
@@ -177,6 +180,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
177
180
  setup: {
178
181
  title: string;
179
182
  subtitle: string;
183
+ hiddenTermsSubtitle: string;
180
184
  descriptionTitle: string;
181
185
  description: string;
182
186
  };
@@ -193,9 +197,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
193
197
  notifications: {
194
198
  error: {
195
199
  title: string;
196
- }; /**
197
- * `labelId` is the unique identifier for the label you wish to void.
198
- */
200
+ };
199
201
  info: {
200
202
  title: string;
201
203
  description: string;
@@ -308,6 +310,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
308
310
  needToAcknowledge: string;
309
311
  };
310
312
  rates: {
313
+ requestedShippingNotification: string;
311
314
  uspsMediaMailAcknowledgement: string;
312
315
  uspsFirstClassMailAcknowledgement_leof: string;
313
316
  rateSavings: string;
@@ -393,6 +396,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
393
396
  aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
394
397
  "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
395
398
  aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
399
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
400
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
396
401
  };
397
402
  termsAndAgreementTitles: {
398
403
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -400,6 +405,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
400
405
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
401
406
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
402
407
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
408
+ "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
409
+ UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
403
410
  };
404
411
  };
405
412
  "manage-defaults": {
@@ -474,6 +481,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
474
481
  purchaseAmount: string;
475
482
  readSettings: string;
476
483
  };
484
+ /**
485
+ * `onComplete` is a callback function that will be invoked when the request to void a given
486
+ * shipping label is completed.
487
+ */
477
488
  addFunds: {
478
489
  custom: string;
479
490
  error: {
@@ -488,12 +499,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
488
499
  other: string;
489
500
  };
490
501
  fundAndPurchase: {
491
- /**
492
- * `onViewShipment` is a callback function that will be invoked when the user clicks the
493
- * `View Shipment` button. This will take you back to the
494
- * {@link ViewShipment.Element | `View Shipment Element`} for the given shipment, where you
495
- * will be able to see the voided label listed.
496
- */
497
502
  finalBalance: string;
498
503
  insufficientFunds: string;
499
504
  insufficientFundsTitle: string;
@@ -541,7 +546,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
541
546
  };
542
547
  };
543
548
  };
544
- "list-carriers": {
549
+ "shipengine-carriers": {
545
550
  title: string;
546
551
  headers: {
547
552
  accountCarriers: string;
@@ -82,6 +82,7 @@ export declare const Element: ({ resources, ...props }: object & {
82
82
  setup: {
83
83
  title: string;
84
84
  subtitle: string;
85
+ hiddenTermsSubtitle: string;
85
86
  descriptionTitle: string;
86
87
  description: string;
87
88
  };
@@ -211,6 +212,7 @@ export declare const Element: ({ resources, ...props }: object & {
211
212
  needToAcknowledge: string;
212
213
  };
213
214
  rates: {
215
+ requestedShippingNotification: string;
214
216
  uspsMediaMailAcknowledgement: string;
215
217
  uspsFirstClassMailAcknowledgement_leof: string;
216
218
  rateSavings: string;
@@ -293,6 +295,8 @@ export declare const Element: ({ resources, ...props }: object & {
293
295
  aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
294
296
  "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
295
297
  aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
298
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
299
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
296
300
  };
297
301
  termsAndAgreementTitles: {
298
302
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -300,6 +304,8 @@ export declare const Element: ({ resources, ...props }: object & {
300
304
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
301
305
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
302
306
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
307
+ "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
308
+ UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
303
309
  };
304
310
  };
305
311
  "manage-defaults": {
@@ -435,7 +441,7 @@ export declare const Element: ({ resources, ...props }: object & {
435
441
  };
436
442
  };
437
443
  };
438
- "list-carriers": {
444
+ "shipengine-carriers": {
439
445
  title: string;
440
446
  headers: {
441
447
  accountCarriers: string;
@@ -4,5 +4,5 @@ export * from "./manage-funding";
4
4
  export * from "./unit-settings";
5
5
  export * from "./payment-method-settings";
6
6
  export * from "./manage-warehouses";
7
- export * from "./list-carriers";
7
+ export * from "./shipengine-carriers";
8
8
  export * from "./external-carriers";
@@ -1,2 +1,7 @@
1
- export declare const Settings: () => import("@emotion/react/jsx-runtime").JSX.Element;
1
+ import { SE } from "@shipengine/alchemy";
2
+ export type LabelLayoutSettingsProps = {
3
+ accountSettings?: SE.AccountSettings;
4
+ updateAccountSettings: (newAccountSetting: Partial<SE.AccountSettings>) => Promise<void>;
5
+ };
6
+ export declare const Settings: ({ accountSettings, updateAccountSettings }: LabelLayoutSettingsProps) => import("@emotion/react/jsx-runtime").JSX.Element;
2
7
  export declare const Purchase: () => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -1,7 +1,7 @@
1
1
  import { SE } from "@shipengine/alchemy";
2
2
  export declare const useLabelLayout: () => {
3
3
  accountSettings: SE.AccountSettings | undefined;
4
- errors: SE.CodedError[] | null;
5
- loading: boolean;
6
- updateAccountSettings: (newLabelLayout: SE.LabelLayout) => Promise<void>;
4
+ isUpdatingLabelLayout: boolean;
5
+ updateAccountSettings: (newAccountSetting: Partial<SE.AccountSettings>) => Promise<void>;
6
+ updateLabelLayoutErrors: SE.CodedError[] | null;
7
7
  };
@@ -1 +1,2 @@
1
1
  export * from "./manage-warehouses";
2
+ export * from "./use-manage-warehouses";
@@ -1 +1,16 @@
1
- export declare const ManageWarehouses: () => import("@emotion/react/jsx-runtime").JSX.Element;
1
+ import { SE } from "@shipengine/alchemy";
2
+ export type UpdateWarehouseData = {
3
+ warehouseId: string;
4
+ } & Partial<SE.Warehouse>;
5
+ export type ManageWarehousesProps = {
6
+ createWarehouse: (params: Partial<SE.Warehouse>) => Promise<any>;
7
+ deleteWarehouse: (params: {
8
+ warehouseId: string;
9
+ }) => Promise<void>;
10
+ isLoadingWarehouses: boolean;
11
+ listWarehouseErrors: SE.CodedError[] | null;
12
+ refreshListWarehouses: () => void;
13
+ updateWarehouse: (params: UpdateWarehouseData) => Promise<void>;
14
+ warehouses?: SE.Warehouse[];
15
+ };
16
+ export declare const ManageWarehouses: ({ createWarehouse, deleteWarehouse, isLoadingWarehouses, listWarehouseErrors, refreshListWarehouses, updateWarehouse, warehouses, }: ManageWarehousesProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1,15 @@
1
+ export declare const useManageWarehouses: () => {
2
+ createWarehouse: import("@tanstack/react-query").UseMutateAsyncFunction<import("@shipengine/alchemy").Warehouse, import("@shipengine/alchemy").CodedError[], Partial<import("@shipengine/alchemy").Warehouse>, unknown>;
3
+ createWarehouseErrors: import("@shipengine/alchemy").CodedError[] | null;
4
+ deleteWarehouse: import("@tanstack/react-query").UseMutateAsyncFunction<void, import("@shipengine/alchemy").CodedError[], import("@shipengine/alchemy").DeleteWarehouseData, unknown>;
5
+ deleteWarehouseErrors: import("@shipengine/alchemy").CodedError[] | null;
6
+ isCreatingWarehouse: boolean;
7
+ isDeletingWarehouse: boolean;
8
+ isLoadingWarehouses: boolean;
9
+ isUpdatingWarehouse: boolean;
10
+ listWarehouseErrors: import("@shipengine/alchemy").CodedError[] | null;
11
+ refreshListWarehouses: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/alchemy").Warehouse[], import("@shipengine/alchemy").CodedError[]>>;
12
+ updateWarehouse: import("@tanstack/react-query").UseMutateAsyncFunction<void, import("@shipengine/alchemy").CodedError[], import("@shipengine/alchemy").UpdateWarehouseData, unknown>;
13
+ updateWarehouseErrors: import("@shipengine/alchemy").CodedError[] | null;
14
+ warehouses: import("@shipengine/alchemy").Warehouse[] | undefined;
15
+ };
@@ -0,0 +1,13 @@
1
+ import { CarrierConnection } from "@shipengine/alchemy";
2
+ export type CarrierMetadataHook = {
3
+ carrierCodes?: CarrierConnection["carrierCode"][];
4
+ countryCode?: string;
5
+ };
6
+ /**
7
+ * @internal
8
+ *
9
+ * # Carrier Metadata Hook
10
+ *
11
+ * @category Hooks
12
+ */
13
+ export declare const useCarrierMetadata: ({ carrierCodes, countryCode }: CarrierMetadataHook) => import("../../../types").CarrierMetadata[];
@@ -0,0 +1 @@
1
+ export * from "./shipengine-carriers";
@@ -0,0 +1 @@
1
+ export * from "./shipengine-carriers-row";
@@ -1,9 +1,9 @@
1
1
  import { CodedError } from "@shipengine/alchemy";
2
2
  import { AddCarrierFormPayload } from "../../../components/templates/add-carrier-form";
3
3
  import { ConnectedCarrierMetadata } from "../hooks/use-list-connected-carriers";
4
- export type ListCarriersRowProps = {
4
+ export type ShipEngineCarriersRowProps = {
5
5
  connectedCarrier: ConnectedCarrierMetadata;
6
6
  registerCarrier: (payload?: AddCarrierFormPayload) => Promise<void>;
7
7
  registerCarrierErrors?: CodedError[] | null;
8
8
  };
9
- export declare const ListCarriersRow: ({ connectedCarrier: { carrier, isConnected }, registerCarrier, registerCarrierErrors, }: ListCarriersRowProps) => import("@emotion/react/jsx-runtime").JSX.Element;
9
+ export declare const ShipEngineCarriersRow: ({ connectedCarrier: { carrier, isConnected }, registerCarrier, registerCarrierErrors, }: ShipEngineCarriersRowProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1,10 @@
1
+ export type ShipEngineCarriersFeatures = {
2
+ carriers: {
3
+ enabledCarriers: ("aramex_au_walleted" | "canada_post_walleted" | "canpar_walleted" | "couriersplease_walleted" | "sendle_walleted" | "dhl_express_walleted" | "dhl_express_worldwide" | "dpd_germany_walleted" | "dpdwallet" | "globalpost" | "hermes" | "purolator_walleted" | "stamps_com" | "ups_walleted" | "ups" | "yodel_walleted")[];
4
+ };
5
+ };
6
+ export type ShipEngineCarriersProps = {
7
+ features?: ShipEngineCarriersFeatures;
8
+ showFunds?: boolean;
9
+ };
10
+ export declare const ShipEngineCarriers: ({ features, showFunds, }: ShipEngineCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -1 +1,2 @@
1
1
  export * from "./unit-settings";
2
+ export * from "./use-unit-settings";