@shipengine/elements 1.0.0 → 1.1.0

package/src/workflows/onboarding/onboarding.d.ts

@@ -466,9 +466,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     cancel: string;
                     close: string;
                     confirm: string;
+                    connect: string;
                     continue: string;
                     delete: string;
                     edit: string;
+                    /**
+                     * # Onboarding Component Props
+                     *
+                     * - These are the base props that will be passed into the `<Onboarding />` component.
+                     *
+                     * @see {@link Onboarding.Component | This prop types usage in the `<Onboarding />` component}
+                     */
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -489,14 +497,47 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         cityLocality: string;
                         stateProvince: string;
                         postalCode: string;
-                        phone: string;
-                        email: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
+                        phone: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
+                        email: string;
                         addressResidentialIndicator: string;
                     };
                     noResults: string;
                     subFields: {
                         optional: string;
                     };
+                    /**
+                     * # Onboarding Component
+                     *
+                     * - The `<Onboarding />` component is used to onboard a new user to the ShipEngine platform. This
+                     * component will allow the user to create a warehouse, register a carrier, and create a funding
+                     * source for their account. This is everything a user needs to begin fulfilling their shipments
+                     * using the ShipEngine Platform.
+                     *
+                     * @param ComponentProps The base props that will be passed into the `<Onboarding />` component.
+                     *
+                     * @returns Element An EmotionJSX.Element that will render the `<Onboarding />` component
+                     * with all the appropriate wrappers.
+                     *
+                     * @example
+                     * You can see how the `<Component />` is used in the `createElement` function call below.
+                     * ```tsx
+                     * export const Element = alchemy.createElement(Component, ErrorFallback, {
+                     *   css: {
+                     *     height: "100%",
+                     *     maxWidth: "800px",
+                     *     minWidth: "440px",
+                     *     overflow: "auto",
+                     *     scrollbarGutter: "stable both-edges",
+                     *     width: "100%",
+                     *   },
+                     *   resources: { en },
+                     * });
+                     * ```
+                     *
+                     * <br />
+                     *
+                     * @see {@link Onboarding.Element | The **Element** created to render `<Onboarding />`}
+                     */
                     parserFields: {
                         fullAddress: string;
                     };
@@ -619,6 +660,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     validation: string;
                 };
+                grid: {
+                    "row-count_one": string;
+                    "row-count_other": string;
+                    rows: string;
+                };
                 insuranceProviders: {
                     carrier: string;
                     none: string;
@@ -727,6 +773,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
             };
+            "connect-carrier": {
+                registrationForm: {
+                    title: string;
+                    isLoading: string;
+                    betaWarning: string;
+                };
+            };
             "account-settings": {
                 title: string;
                 sections: {