@shipengine/elements 0.38.0 → 1.0.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 (142) hide show
  1. package/index.cjs +4520 -4443
  2. package/index.js +4519 -4446
  3. package/package.json +11 -14
  4. package/src/components/add-funds-form/add-funds-form.styles.d.ts +3 -3
  5. package/src/components/auto-funding-form/auto-funding-form.styles.d.ts +1 -1
  6. package/src/components/carrier-balance/carrier-balance.styles.d.ts +1 -1
  7. package/src/components/carrier-logo/carrier-logo.d.ts +11 -0
  8. package/src/components/carrier-logo/index.d.ts +1 -0
  9. package/src/components/collapsible-panel/collapsible-panel.d.ts +1 -1
  10. package/src/components/collapsible-panel/collapsible-panel.styles.d.ts +4 -4
  11. package/src/components/date-range-select/date-range-select.styles.d.ts +1 -1
  12. package/src/components/disclosure/disclosure.styles.d.ts +3 -3
  13. package/src/components/display-term/display-term.d.ts +5 -0
  14. package/src/components/display-term/display-term.styles.d.ts +23 -0
  15. package/src/components/display-term/index.d.ts +1 -0
  16. package/src/components/error-display/error-display.styles.d.ts +3 -3
  17. package/src/components/field/checkbox-input/checkbox-input.d.ts +1 -1
  18. package/src/components/field/credit-card-input/credit-card-input.d.ts +1 -1
  19. package/src/components/field/date-picker/date-picker.styles.d.ts +1 -1
  20. package/src/components/field/expiration-input/expiration-input.d.ts +1 -1
  21. package/src/components/field/field.styles.d.ts +1 -1
  22. package/src/components/field/money-input/money-input.d.ts +1 -1
  23. package/src/components/field/number-input/number-input.d.ts +1 -1
  24. package/src/components/field/rate-card/cost-breakdown/cost-breakdown.styles.d.ts +1 -1
  25. package/src/components/field/rate-card/rate-card.d.ts +1 -1
  26. package/src/components/field/rate-card/rate-card.styles.d.ts +1 -1
  27. package/src/components/field/rate-select/rate-select.styles.d.ts +1 -1
  28. package/src/components/field/select-auto-complete/select-auto-complete.d.ts +1 -1
  29. package/src/components/field/submit-button/submit-button.d.ts +1 -1
  30. package/src/components/field/switch/switch.d.ts +1 -1
  31. package/src/components/field/text-area/text-area.d.ts +1 -1
  32. package/src/components/field/text-input/text-input.d.ts +1 -1
  33. package/src/components/fund-and-purchase/fund-and-purchase.styles.d.ts +3 -3
  34. package/src/components/history/history-card/history-card.styles.d.ts +8 -8
  35. package/src/components/history/history-card-extension/history-card-extension.styles.d.ts +3 -3
  36. package/src/components/index.d.ts +2 -0
  37. package/src/components/inline-label/inline-label.d.ts +1 -1
  38. package/src/components/inline-label/inline-label.styles.d.ts +1 -1
  39. package/src/components/items-breakdown/items-breakdown.styles.d.ts +6 -6
  40. package/src/components/label/label.d.ts +1 -1
  41. package/src/components/label/label.styles.d.ts +1 -1
  42. package/src/components/label-layout/label-layout.styles.d.ts +12 -12
  43. package/src/components/link-action/link-action.d.ts +2 -2
  44. package/src/components/loader/loader.d.ts +1 -1
  45. package/src/components/loader/loader.styles.d.ts +11 -0
  46. package/src/components/preset-descriptor/preset-descriptor.styles.d.ts +1 -1
  47. package/src/components/save-status/save-status-styles.d.ts +4 -4
  48. package/src/components/section/section.d.ts +1 -1
  49. package/src/components/section/section.styles.d.ts +4 -4
  50. package/src/components/settings-card/settings-card.styles.d.ts +5 -5
  51. package/src/components/spacer/spacer.d.ts +1 -1
  52. package/src/components/templates/account-settings/account-settings.d.ts +0 -1
  53. package/src/components/templates/address-form/address-fields.styles.d.ts +1 -1
  54. package/src/components/templates/customs-items-display/customs-items-display.styles.d.ts +16 -16
  55. package/src/components/templates/display-carrier-terms/display-carrier-terms.d.ts +2 -2
  56. package/src/components/templates/display-carrier-terms/display-carrier-terms.styles.d.ts +25 -0
  57. package/src/components/templates/edit-billing-form/edit-billing-form.styles.d.ts +3 -3
  58. package/src/components/templates/index.d.ts +2 -6
  59. package/src/components/templates/label/label.styles.d.ts +2 -2
  60. package/src/components/templates/list-carriers/list-carriers.d.ts +2 -2
  61. package/src/components/templates/list-carriers/list-carriers.styles.d.ts +3 -3
  62. package/src/components/templates/list-carriers-row/list-carriers-row.styles.d.ts +3 -3
  63. package/src/components/templates/manage-warehouses/manage-warehouse.styles.d.ts +2 -2
  64. package/src/components/templates/rate-form/rate-form.d.ts +2 -2
  65. package/src/components/templates/rate-form/rate-form.styles.d.ts +1 -1
  66. package/src/components/templates/suspend-sales-order/suspend-sales-order.d.ts +1 -1
  67. package/src/components/templates/suspend-shipment/suspend-shipment.d.ts +1 -1
  68. package/src/components/templates/wallet-card/wallet-card.styles.d.ts +1 -1
  69. package/src/components/templates/wallet-form/wallet-form.styles.d.ts +1 -1
  70. package/src/components/templates/warehouse-form/warehouse-form.d.ts +2 -2
  71. package/src/elements/account-settings/account-settings.d.ts +35 -38
  72. package/src/elements/configure-shipment/hooks/use-rates-form.d.ts +0 -1
  73. package/src/elements/configure-shipment/hooks/use-request-preferred-rates.d.ts +1 -1
  74. package/src/elements/configure-shipment/hooks/use-request-rates.d.ts +1 -1
  75. package/src/elements/index.d.ts +0 -1
  76. package/src/elements/list-carriers/hooks/use-list-connected-carriers.d.ts +1 -1
  77. package/src/elements/list-carriers/list-carriers.d.ts +2 -2
  78. package/src/elements/purchase-label/hooks/use-load-shipment.d.ts +1 -1
  79. package/src/elements/purchase-label/purchase-label.d.ts +37 -10
  80. package/src/elements/view-shipment/view-shipment.d.ts +34 -11
  81. package/src/elements/void-label/void-label.d.ts +45 -36
  82. package/src/features/wallet-history/wallet-history.styles.d.ts +11 -11
  83. package/src/hooks/use-get-or-create-shipment.d.ts +1 -1
  84. package/src/index.d.ts +1 -0
  85. package/src/locales/en/index.d.ts +34 -7
  86. package/src/testing/extensions/queries/by-icon-name.d.ts +1 -1
  87. package/src/testing/extensions/queries/index.d.ts +6 -6
  88. package/src/testing/test-utils.d.ts +1 -2
  89. package/src/types/index.d.ts +1 -0
  90. package/src/types/patch.d.ts +13 -0
  91. package/src/utilities/assertions.d.ts +2 -0
  92. package/src/utilities/feature-flags.d.ts +1 -1
  93. package/src/utilities/index.d.ts +1 -0
  94. package/src/utilities/styles.d.ts +1 -1
  95. package/src/workflows/onboarding/components/account-registration-form/account-registration-form-schema.d.ts +10 -0
  96. package/src/workflows/onboarding/components/account-registration-form/account-registration-form.d.ts +4 -0
  97. package/src/workflows/onboarding/components/account-registration-form/index.d.ts +1 -0
  98. package/src/workflows/onboarding/components/account-registration-step/account-registration-step.d.ts +5 -0
  99. package/src/{components/templates/landing-page/landing-page.styles.d.ts → workflows/onboarding/components/account-registration-step/account-registration-step.styles.d.ts} +1 -1
  100. package/src/workflows/onboarding/components/account-registration-step/index.d.ts +2 -0
  101. package/src/workflows/onboarding/components/account-registration-step/use-account-registration-step.d.ts +7 -0
  102. package/src/workflows/onboarding/components/carrier-recovery-form/carrier-recovery-form-schema.d.ts +241 -0
  103. package/src/{components/templates → workflows/onboarding/components}/carrier-recovery-form/carrier-recovery-form.d.ts +4 -2
  104. package/src/{components/templates → workflows/onboarding/components}/carrier-recovery-form/carrier-recovery-form.styles.d.ts +1 -1
  105. package/src/workflows/onboarding/components/carrier-recovery-form/index.d.ts +1 -0
  106. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/funding-and-carrier-connection-step.d.ts +9 -0
  107. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/funding-and-carrier-connection-step.styles.d.ts +18 -0
  108. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/index.d.ts +2 -0
  109. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/use-funding-and-carrier-connection-step.d.ts +25 -0
  110. package/src/workflows/onboarding/components/onboarding-wizard/index.d.ts +1 -0
  111. package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.d.ts +27 -0
  112. package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.styles.d.ts +10 -0
  113. package/src/workflows/onboarding/components/ship-from-address-step/index.d.ts +2 -0
  114. package/src/workflows/onboarding/components/ship-from-address-step/ship-from-address-step.d.ts +7 -0
  115. package/src/workflows/onboarding/components/ship-from-address-step/use-ship-from-address-step.d.ts +9 -0
  116. package/src/workflows/onboarding/components/step-header/index.d.ts +1 -0
  117. package/src/workflows/onboarding/components/step-header/step-header.d.ts +5 -0
  118. package/src/workflows/onboarding/components/terms-agreement-form/index.d.ts +1 -0
  119. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form-schema.d.ts +10 -0
  120. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.d.ts +7 -0
  121. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.styles.d.ts +24 -0
  122. package/src/workflows/onboarding/components/terms-agreement-step/index.d.ts +1 -0
  123. package/src/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.d.ts +8 -0
  124. package/src/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.styles.d.ts +17 -0
  125. package/src/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.d.ts +18 -0
  126. package/src/{elements → workflows}/onboarding/onboarding.d.ts +55 -48
  127. package/src/components/templates/carrier-recovery-form/carrier-recovery-form-schema.d.ts +0 -241
  128. package/src/components/templates/carrier-recovery-form/index.d.ts +0 -2
  129. package/src/components/templates/carrier-terms-form/carrier-terms-form-schema.d.ts +0 -10
  130. package/src/components/templates/carrier-terms-form/carrier-terms-form.d.ts +0 -6
  131. package/src/components/templates/carrier-terms-form/carrier-terms-form.styles.d.ts +0 -65
  132. package/src/components/templates/carrier-terms-form/index.d.ts +0 -1
  133. package/src/components/templates/landing-page/index.d.ts +0 -1
  134. package/src/components/templates/landing-page/landing-page-form-schema.d.ts +0 -10
  135. package/src/components/templates/landing-page/landing-page-form.d.ts +0 -4
  136. package/src/components/templates/landing-page/landing-page.d.ts +0 -5
  137. package/src/components/templates/onboarding/onboarding.d.ts +0 -42
  138. package/src/components/templates/onboarding/onboarding.styles.d.ts +0 -31
  139. /package/src/{components/templates/onboarding → workflows}/index.d.ts +0 -0
  140. /package/src/{components/templates → workflows/onboarding/components}/completion-page/completion-page.d.ts +0 -0
  141. /package/src/{components/templates → workflows/onboarding/components}/completion-page/index.d.ts +0 -0
  142. /package/src/{elements → workflows}/onboarding/index.d.ts +0 -0
@@ -19,9 +19,6 @@ export type ComponentProps = {
19
19
  * - The `<AccountSettings />` component is used to display the user's account settings, as well as
20
20
  * allowing them to make changes to various aspects of their account.
21
21
  *
22
- * @param onSaveSettings Any `void` function you wish to execute when the user saves any changes
23
- * to their account settings.
24
- *
25
22
  * @returns Element An EmotionJSX.Element that will render the `<AccountSettings />` component
26
23
  * with all the appropriate wrappers.
27
24
  *
@@ -52,9 +49,7 @@ export declare const Component: ({ onSaveSettings }: ComponentProps) => import("
52
49
  * The `<Component />` is the source JSX that is rendered when you make use of the `AccountSettings`
53
50
  * Element directly. Here is a brief example of how you would use it within your application.
54
51
  * ```tsx
55
- * <AccountSettings.Element
56
- * onSaveSettings={() => console.log('Settings Saved!')}
57
- * />
52
+ * <AccountSettings.Element/>
58
53
  * ```
59
54
  *
60
55
  * <br />
@@ -295,7 +290,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
295
290
  onboarding: {
296
291
  title: string;
297
292
  inlineTitle: string;
298
- landing: {
293
+ accountRegistration: {
299
294
  action: string;
300
295
  title: string;
301
296
  subtitle: string;
@@ -304,36 +299,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
304
299
  partnerMessageLine1: string;
305
300
  messageLine2: string;
306
301
  };
307
- steps: {
308
- register: string;
309
- carriers: string;
310
- /**
311
- * # Account Settings Component
312
- *
313
- * - The `<AccountSettings />` component is used to display the user's account settings, as well as
314
- * allowing them to make changes to various aspects of their account.
315
- *
316
- * @param onSaveSettings Any `void` function you wish to execute when the user saves any changes
317
- * to their account settings.
318
- *
319
- * @returns Element An EmotionJSX.Element that will render the `<AccountSettings />` component
320
- * with all the appropriate wrappers.
321
- *
322
- * @example
323
- * You can see how the `<Component />` is used in the `createElement` function call below.
324
- * ```tsx
325
- * export const Element = alchemy.createElement(Component, ErrorFallback, {
326
- * css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
327
- * resources: { en },
328
- * });
329
- * ```
330
- *
331
- * <br />
332
- *
333
- * @see {@link AccountSettings.Element | The **Element** created to render `<AccountSettings />`}
334
- */
335
- addresses: string;
336
- billing: string;
302
+ stepLabel: {
303
+ accountRegistration: string;
304
+ termsAgreement: string;
305
+ shipFromAddress: string;
306
+ fundingAndCarrierConnection: string;
337
307
  };
338
308
  warehouse: {
339
309
  title: string;
@@ -345,6 +315,22 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
345
315
  subtitle: string;
346
316
  action: string;
347
317
  };
318
+ termsAndAgreementLinkText: {
319
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
320
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
321
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
322
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
323
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
324
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
325
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
326
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
327
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
328
+ };
329
+ termsAndAgreementTitles: {
330
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
331
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
332
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
333
+ };
348
334
  };
349
335
  "manage-defaults": {
350
336
  label: {
@@ -492,6 +478,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
492
478
  fields: {
493
479
  name: string;
494
480
  company: string;
481
+ county: string;
495
482
  countryCode: string;
496
483
  addressLine1: string;
497
484
  addressLine2: string;
@@ -606,6 +593,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
606
593
  autoFundingSettings: string;
607
594
  carrier: string;
608
595
  carriers: string;
596
+ fundingSourceMetadata: string;
609
597
  label: string;
610
598
  salesOrder: string;
611
599
  shipment: string;
@@ -613,7 +601,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
613
601
  };
614
602
  unknown: string;
615
603
  noRatesAvailable: string;
616
- saveRateError: string;
617
604
  };
618
605
  errorTypes: {
619
606
  accountStatus: string;
@@ -639,6 +626,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
639
626
  carrier: string;
640
627
  carriers: string;
641
628
  connectingCarriers: string;
629
+ creatingFundingSource: string;
642
630
  data: string;
643
631
  importingSalesOrder: string;
644
632
  label: string;
@@ -700,6 +688,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
700
688
  platform: string;
701
689
  user: string;
702
690
  };
691
+ terms: {
692
+ fields: {
693
+ agreement: string;
694
+ };
695
+ agreeToTerms: string;
696
+ carriersTitle: string;
697
+ fundingSourceTitle: string;
698
+ };
703
699
  weight: {
704
700
  ounces: string;
705
701
  pounds_one: string;
@@ -715,6 +711,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
715
711
  gram: string;
716
712
  kilogram: string;
717
713
  };
714
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
718
715
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
719
716
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
720
717
  QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -24,7 +24,6 @@ export type UseRatesFormProps = {
24
24
  export declare const useRatesForm: ({ getPreferredRates, onBeforeRateSaved, onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, shipment, }: UseRatesFormProps) => {
25
25
  carriers: SE.Carrier[] | undefined;
26
26
  displayableRateErrors: string[] | undefined;
27
- displayableSaveRateErrors: string[] | undefined;
28
27
  errors: SE.CodedError[] | undefined;
29
28
  isLoading: boolean;
30
29
  labelErrors: string[] | undefined;
@@ -4,4 +4,4 @@ export type RequestPreferredRatesProps = {
4
4
  getPreferredRates?: UseRequestRatesProps["getPreferredRates"];
5
5
  };
6
6
  export type CalculatePreferredRatesData = Parameters<Required<UseRequestRatesProps>["getPreferredRates"]>;
7
- export declare const useRequestPreferredRates: ({ getPreferredRates }: RequestPreferredRatesProps) => import("react-query").UseMutationResult<import("..").PreferredRatesResponse | undefined, SE.CodedError[], [shipment: SE.SalesOrderShipment, isInternational: boolean], unknown>;
7
+ export declare const useRequestPreferredRates: ({ getPreferredRates }: RequestPreferredRatesProps) => import("@tanstack/react-query").UseMutationResult<import("..").PreferredRatesResponse | undefined, SE.CodedError[], [shipment: SE.SalesOrderShipment, isInternational: boolean], unknown>;
@@ -9,7 +9,7 @@ export declare const useRequestRates: ({ onRatesCalculated, getPreferredRates }:
9
9
  preferredRatesResponse: PreferredRatesResponse | undefined;
10
10
  ratesErrors: SE.CodedError[] | null;
11
11
  ratesResponse: SE.RateResponse | undefined;
12
- requestPreferredRates: import("react-query").UseMutateAsyncFunction<PreferredRatesResponse | undefined, SE.CodedError[], [shipment: SE.SalesOrderShipment, isInternational: boolean], unknown>;
12
+ requestPreferredRates: import("@tanstack/react-query").UseMutateAsyncFunction<PreferredRatesResponse | undefined, SE.CodedError[], [shipment: SE.SalesOrderShipment, isInternational: boolean], unknown>;
13
13
  requestRates: (shipment: SE.SalesOrderShipment, isInternational: boolean) => Promise<void>;
14
14
  resetRates: () => void;
15
15
  };
@@ -1,7 +1,6 @@
1
1
  export * from "./account-settings";
2
2
  export * from "./list-carriers";
3
3
  export * from "./manage-warehouses";
4
- export * from "./onboarding";
5
4
  export * from "./purchase-label";
6
5
  export * from "./view-shipment";
7
6
  export * from "./void-label";
@@ -7,5 +7,5 @@ export declare const useListConnectedCarriers: () => {
7
7
  data: ConnectedCarrierMetadata[];
8
8
  error: import("@shipengine/alchemy").CodedError[] | null;
9
9
  isLoading: boolean;
10
- refetch: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<import("@shipengine/alchemy").Carrier[], import("@shipengine/alchemy").CodedError[]>>;
10
+ refetch: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/alchemy").Carrier[], import("@shipengine/alchemy").CodedError[]>>;
11
11
  };
@@ -1,4 +1,4 @@
1
- import { OnboardingProps } from "../../components/templates/onboarding";
1
+ import { ListCarriersFeatures } from "../../components/templates/list-carriers";
2
2
  /**
3
3
  * # List-Carriers Props
4
4
  *
@@ -8,7 +8,7 @@ export type ComponentProps = {
8
8
  /**
9
9
  * `features` is a set of feature flags you would like to enable or disable in this component.
10
10
  */
11
- features?: OnboardingProps["features"];
11
+ features?: ListCarriersFeatures;
12
12
  };
13
13
  /**
14
14
  * # List-Carriers Component
@@ -4,6 +4,6 @@ export type UseLoadShipmentProps = {
4
4
  export declare const useLoadShipment: ({ shipmentId }: UseLoadShipmentProps) => {
5
5
  errors: import("@shipengine/alchemy").CodedError[] | undefined;
6
6
  isLoading: boolean;
7
- refetchShipment: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<import("@shipengine/alchemy").SalesOrderShipment, import("@shipengine/alchemy").CodedError[]>>;
7
+ refetchShipment: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/alchemy").SalesOrderShipment, import("@shipengine/alchemy").CodedError[]>>;
8
8
  shipment: import("@shipengine/alchemy").SalesOrderShipment | undefined;
9
9
  };
@@ -432,7 +432,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
432
432
  onboarding: {
433
433
  title: string;
434
434
  inlineTitle: string;
435
- landing: {
435
+ accountRegistration: {
436
436
  action: string;
437
437
  title: string;
438
438
  subtitle: string;
@@ -441,11 +441,11 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
441
441
  partnerMessageLine1: string;
442
442
  messageLine2: string;
443
443
  };
444
- steps: {
445
- register: string;
446
- carriers: string;
447
- addresses: string;
448
- billing: string;
444
+ stepLabel: {
445
+ accountRegistration: string;
446
+ termsAgreement: string;
447
+ shipFromAddress: string;
448
+ fundingAndCarrierConnection: string;
449
449
  };
450
450
  warehouse: {
451
451
  title: string;
@@ -453,13 +453,29 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
453
453
  inlineMessage: string;
454
454
  };
455
455
  success: {
456
- /**
457
- * `features` is a set of feature flags you would like to enable or disable in this component.
458
- */
459
456
  title: string;
460
457
  subtitle: string;
461
458
  action: string;
462
459
  };
460
+ termsAndAgreementLinkText: {
461
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
462
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
463
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
464
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
465
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
466
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
467
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
468
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
469
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
470
+ };
471
+ termsAndAgreementTitles: {
472
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
473
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
474
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
475
+ }; /**
476
+ * `onBeforeRateSave` is an async/sync callback function that will be invoked before each time a user
477
+ * saves a rate.
478
+ */
463
479
  };
464
480
  "manage-defaults": {
465
481
  label: {
@@ -597,6 +613,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
597
613
  fields: {
598
614
  name: string;
599
615
  company: string;
616
+ county: string;
600
617
  countryCode: string;
601
618
  addressLine1: string;
602
619
  addressLine2: string;
@@ -711,6 +728,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
711
728
  autoFundingSettings: string;
712
729
  carrier: string;
713
730
  carriers: string;
731
+ fundingSourceMetadata: string;
714
732
  label: string;
715
733
  salesOrder: string;
716
734
  shipment: string;
@@ -718,7 +736,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
718
736
  };
719
737
  unknown: string;
720
738
  noRatesAvailable: string;
721
- saveRateError: string;
722
739
  };
723
740
  errorTypes: {
724
741
  accountStatus: string;
@@ -744,6 +761,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
744
761
  carrier: string;
745
762
  carriers: string;
746
763
  connectingCarriers: string;
764
+ creatingFundingSource: string;
747
765
  data: string;
748
766
  importingSalesOrder: string;
749
767
  label: string;
@@ -805,6 +823,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
805
823
  platform: string;
806
824
  user: string;
807
825
  };
826
+ terms: {
827
+ fields: {
828
+ agreement: string;
829
+ };
830
+ agreeToTerms: string;
831
+ carriersTitle: string;
832
+ fundingSourceTitle: string;
833
+ };
808
834
  weight: {
809
835
  ounces: string;
810
836
  pounds_one: string;
@@ -820,6 +846,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
820
846
  gram: string;
821
847
  kilogram: string;
822
848
  };
849
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
823
850
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
824
851
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
825
852
  QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -329,7 +329,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
329
329
  onboarding: {
330
330
  title: string;
331
331
  inlineTitle: string;
332
- landing: {
332
+ accountRegistration: {
333
333
  action: string;
334
334
  title: string;
335
335
  subtitle: string;
@@ -338,11 +338,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
338
338
  partnerMessageLine1: string;
339
339
  messageLine2: string;
340
340
  };
341
- steps: {
342
- register: string;
343
- carriers: string;
344
- addresses: string;
345
- billing: string;
341
+ stepLabel: {
342
+ accountRegistration: string;
343
+ termsAgreement: string;
344
+ shipFromAddress: string;
345
+ fundingAndCarrierConnection: string;
346
346
  };
347
347
  warehouse: {
348
348
  title: string;
@@ -354,6 +354,22 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
354
354
  subtitle: string;
355
355
  action: string;
356
356
  };
357
+ termsAndAgreementLinkText: {
358
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
359
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
360
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
361
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
362
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
363
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
364
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
365
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
366
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
367
+ };
368
+ termsAndAgreementTitles: {
369
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
370
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
371
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
372
+ };
357
373
  };
358
374
  "manage-defaults": {
359
375
  label: {
@@ -497,6 +513,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
497
513
  fields: {
498
514
  name: string;
499
515
  company: string;
516
+ county: string;
500
517
  countryCode: string;
501
518
  addressLine1: string;
502
519
  addressLine2: string;
@@ -505,10 +522,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
505
522
  postalCode: string;
506
523
  phone: string;
507
524
  email: string;
508
- /**
509
- * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
510
- * `Print Label` button.
511
- */
512
525
  addressResidentialIndicator: string;
513
526
  };
514
527
  noResults: string;
@@ -615,6 +628,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
615
628
  autoFundingSettings: string;
616
629
  carrier: string;
617
630
  carriers: string;
631
+ fundingSourceMetadata: string;
618
632
  label: string;
619
633
  salesOrder: string;
620
634
  shipment: string;
@@ -622,7 +636,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
622
636
  };
623
637
  unknown: string;
624
638
  noRatesAvailable: string;
625
- saveRateError: string;
626
639
  };
627
640
  errorTypes: {
628
641
  accountStatus: string;
@@ -648,6 +661,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
648
661
  carrier: string;
649
662
  carriers: string;
650
663
  connectingCarriers: string;
664
+ creatingFundingSource: string;
651
665
  data: string;
652
666
  importingSalesOrder: string;
653
667
  label: string;
@@ -709,6 +723,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
709
723
  platform: string;
710
724
  user: string;
711
725
  };
726
+ terms: {
727
+ fields: {
728
+ agreement: string;
729
+ };
730
+ agreeToTerms: string;
731
+ carriersTitle: string;
732
+ fundingSourceTitle: string;
733
+ };
712
734
  weight: {
713
735
  ounces: string;
714
736
  pounds_one: string;
@@ -724,6 +746,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
724
746
  gram: string;
725
747
  kilogram: string;
726
748
  };
749
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
727
750
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
728
751
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
729
752
  QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -327,7 +327,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
327
327
  onboarding: {
328
328
  title: string;
329
329
  inlineTitle: string;
330
- landing: {
330
+ accountRegistration: {
331
331
  action: string;
332
332
  title: string;
333
333
  subtitle: string;
@@ -336,15 +336,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
336
336
  partnerMessageLine1: string;
337
337
  messageLine2: string;
338
338
  };
339
- steps: {
340
- register: string;
341
- carriers: string;
342
- addresses: string;
343
- billing: string;
339
+ stepLabel: {
340
+ accountRegistration: string;
341
+ termsAgreement: string;
342
+ shipFromAddress: string;
343
+ fundingAndCarrierConnection: string;
344
344
  };
345
345
  warehouse: {
346
346
  title: string;
347
- subtitle: string;
347
+ subtitle: string; /**
348
+ * `onComplete` is a callback function that will be invoked when the request to void a given
349
+ * shipping label is completed.
350
+ */
348
351
  inlineMessage: string;
349
352
  };
350
353
  success: {
@@ -352,6 +355,22 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
352
355
  subtitle: string;
353
356
  action: string;
354
357
  };
358
+ termsAndAgreementLinkText: {
359
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
360
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
361
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
362
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
363
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
364
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
365
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
366
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
367
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
368
+ };
369
+ termsAndAgreementTitles: {
370
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
371
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
372
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
373
+ };
355
374
  };
356
375
  "manage-defaults": {
357
376
  label: {
@@ -489,11 +508,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
489
508
  fields: {
490
509
  name: string;
491
510
  company: string;
511
+ county: string;
492
512
  countryCode: string;
493
513
  addressLine1: string;
494
- addressLine2: string; /**
495
- * `features` is a set of feature flags you would like to enable or disable in this component.
496
- */
514
+ addressLine2: string;
497
515
  cityLocality: string;
498
516
  stateProvince: string;
499
517
  postalCode: string;
@@ -515,6 +533,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
515
533
  modified: string;
516
534
  title: string;
517
535
  originalAddress: string;
536
+ /**
537
+ * `onViewShipment` is a callback function that will be invoked when the user clicks the
538
+ * `View Shipment` button. This will take you back to the
539
+ * {@link ViewShipment.Element | `View Shipment Element`} for the given shipment, where you
540
+ * will be able to see the voided label listed.
541
+ */
518
542
  matchedAddress: string;
519
543
  unableToValidate: string;
520
544
  use: {
@@ -527,31 +551,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
527
551
  validated: string;
528
552
  };
529
553
  };
530
- /**
531
- * # Void Label Component
532
- *
533
- * - The `<VoidLabel />` component is used to void a given shipping label. When a label is voided,
534
- * you then get the option to view the associated shipment via the `View Shipment` Element, or
535
- * you can purchase another label for the shipment via the `Purchase Label` Element.
536
- *
537
- * @param ComponentProps The base props that will be passed into the `<VoidLabel />` component.
538
- *
539
- * @returns Element An EmotionJSX.Element that will render the `<VoidLabel />` component
540
- * with all the appropriate wrappers.
541
- *
542
- * @example
543
- * You can see how the `<Component />` is used in the `createElement` function call below.
544
- * ```tsx
545
- * export const Element = alchemy.createElement(Component, ErrorFallback, {
546
- * css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
547
- * resources: { en },
548
- * });
549
- * ```
550
- *
551
- * <br />
552
- *
553
- * @see {@link VoidLabel.Element | The **Element** created to render `<VoidLabel />`}
554
- */
555
554
  billing: {
556
555
  fields: {
557
556
  differentBillingAddress: string;
@@ -630,6 +629,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
630
629
  autoFundingSettings: string;
631
630
  carrier: string;
632
631
  carriers: string;
632
+ fundingSourceMetadata: string;
633
633
  label: string;
634
634
  salesOrder: string;
635
635
  shipment: string;
@@ -637,7 +637,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
637
637
  };
638
638
  unknown: string;
639
639
  noRatesAvailable: string;
640
- saveRateError: string;
641
640
  };
642
641
  errorTypes: {
643
642
  accountStatus: string;
@@ -663,6 +662,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
663
662
  carrier: string;
664
663
  carriers: string;
665
664
  connectingCarriers: string;
665
+ creatingFundingSource: string;
666
666
  data: string;
667
667
  importingSalesOrder: string;
668
668
  label: string;
@@ -724,6 +724,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
724
724
  platform: string;
725
725
  user: string;
726
726
  };
727
+ terms: {
728
+ fields: {
729
+ agreement: string;
730
+ };
731
+ agreeToTerms: string;
732
+ carriersTitle: string;
733
+ fundingSourceTitle: string;
734
+ };
727
735
  weight: {
728
736
  ounces: string;
729
737
  pounds_one: string;
@@ -739,6 +747,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
739
747
  gram: string;
740
748
  kilogram: string;
741
749
  };
750
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
742
751
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
743
752
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
744
753
  QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;