@spiffcommerce/core 26.31.0 → 26.32.0-beta.026a8c6e-0921-5dd4-9d21-8740a190975b

package/dist/index.d.ts

@@ -2613,7 +2613,7 @@ interface WorkflowManager {
     /**
      * Create or amend the recipient fo the transaction.
      */
-    updateRecipient(firstName?: string, lastName?: string, address?: string, suburb?: string, state?: string, email?: string, postalCode?: string, country?: string): Promise<void>;
+    updateRecipient(firstName?: string, lastName?: string, address?: string, suburb?: string, state?: string, email?: string, postalCode?: string, country?: string, mobile?: string): Promise<void>;
 }
 
 declare enum AssetType {
@@ -3634,6 +3634,7 @@ interface Recipient {
     email?: string;
     postalCode?: string;
     country?: string;
+    mobile?: string;
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;
@@ -4932,7 +4933,7 @@ declare class DigitalContentStepService implements StepService<DigitalContentSte
 declare const digitalContentStepService: DigitalContentStepService;
 
 declare class MockWorkflowManager implements WorkflowManager {
-    updateRecipient(_firstName?: string, _lastName?: string, _address?: string, _suburb?: string, _state?: string, _email?: string, _postalCode?: string, _country?: string): Promise<void>;
+    updateRecipient(_firstName?: string, _lastName?: string, _address?: string, _suburb?: string, _state?: string, _email?: string, _postalCode?: string, _country?: string, _mobile?: string): Promise<void>;
     approveTransaction(_note?: string): Promise<void>;
     rejectTransaction(_note?: string): Promise<void>;
     private client;
@@ -5685,4 +5686,103 @@ declare class MetafieldManager {
 }
 declare const metafieldManager: MetafieldManager;
 
-export { AddonHandle, Animatable, AnyStepData, ArrayInput, AspectType, Asset, AssetConfiguration, AssetNotFoundError, AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, Bundle$1 as Bundle, BundleDesignCreationCartAddMode, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, BundleStakeholder, CanvasCommand, CollectionProduct, ColorDefinition, ColorOption, ColorOptionGlobalPropertyHandle, ColorProfileProps, CommandContext, CommandState, Condition, ConditionalGlobalPropertiesChangedEventData, CreateElementCommand, CreateLayoutCommand, Customer, CustomerDetailsInput, DeleteElementCommand, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, DigitalContentStepData, DigitalContentStepHandle, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameService, FrameStep, FrameStepData, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyConfiguration, GlobalPropertyHandle, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, IllustrationStepHandle, ImageElement, InformationMessageType, InformationResult, InformationStepData, InformationStepHandle, Integration, IntegrationOptionResource, IntegrationProduct, IntegrationType, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutNotFoundError, LayoutRenderingPurpose, LayoutState, LayoutsState, MandatorySteps, MaterialEffectMode, MaterialStepData, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepData, ModelStepHandle, ModuleStepData, ModuleStepHandle, MoveCommand, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, OptionResource, Order, OrderItem, PapyrusComponent, ParseError, PictureStepData, PictureStepHandle, Placeable, PmsSearchResult, Point, Product, ProductCameraRig, ProductCollection, ProductCollectionProductSortKey, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepData, QuestionStepHandle, QueueablePromise, Recipient, Region, RegionElement, RenderableScene, ResizeCommand, ResourceNotFoundError, RotateCommand, SavedDesign, ScaleAxis, SelectionStorage, SendBackwardsCommand, ShapeStepData, ShapeStepHandle, ShareAction, ShareActionType, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, Step, StepAspect, StepAspectType, StepElements, StepGroup, StepHandle, StepStorage, StepType, TextAlgorithm, TextChangeCommand, TextChangeResult, TextGlobalPropertyHandle, TextInput, TextStepData, TextStepHandle, TextStepStorage, TextboxElement, Theme, ToastCallback, Transaction, Transform, TransformCollection$1 as TransformCollection, UnhandledBehaviorError, UnitOfMeasurement, UpdateImageSourceCommand, Variant, VariantResource, Vector3, Workflow, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowPanel, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, browserColorToHex, cmPerPixel, createDesign, currentDirection, dataUrlFromExternalUrl, designService, determineCorrectFontSizeAndLines, digitalContentStepService, domParser, duplicateBundle, duplicateTransaction, fetchAsString, findAngle, findElement, findPmsColors, frameDataCache, frameStepService, generate, generateCommands, generateSVGWithUnknownColors, generateStateFromDesignInputSteps, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getBoundedOffsets, getBundleThemeConfiguration, getCustomer, getCustomerBundles, getElementVertices, getFrameData, getIntegration, getNEPoint, getNWPoint, getOrderedTransactions, getOverrideThemeConfiguration, getPointOfRotation, getProductCollections, getSEPoint, getSvgElement, getTemplateBundles, getTemplateTransactions, getTransaction, getTransactionThemeConfiguration, getTransactionsForBundle, getTrueCoordinates, getUnorderedTransactions, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, isCloseToValue, loadFont, matchHexToPms, materialStepService, metafieldManager, mmPerPixel, modelStepService, modifySVGColors, moduleStepService, nameBundle, nameTransaction, optionService, outlineFontsInSvg, patternImageDataCache, persistenceService, pictureStepService, pmsToRgb, questionStepService, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, rgbToPms, rotateAroundPoint, sanitizeSvgTree, setBearerAuthenticationToken, setCanvasModule, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, svgColorValueToDefinition, svgStringDimensions, svgToDataUrl, textStepService, toast, xmlSerializer };
+declare enum AddressValidationResultConfirmationLevel {
+    Confirmed = "Confirmed",
+    Plausible = "Plausible",
+    Unlikely = "Unlikely"
+}
+interface AddressValidationResult {
+    /**
+     * Whether the resulting address is considered complete.
+     * An address is considered complete if no components were unexpected or missing.
+     */
+    addressComplete?: boolean;
+    address?: {
+        /**
+         * The full address, formatted in the standard format for the area.
+         */
+        formattedAddress?: string;
+        /** Country code; AU, US, UK, etc. */
+        regionCode?: string;
+        postalCode?: string;
+        /** The state/province etc. */
+        administrativeArea?: string;
+        /** Suburb/city */
+        locality?: string;
+        sublocality?: string;
+    };
+    /** The individual components of the address, and their associated validation information. */
+    components?: {
+        /** The text value of the component. */
+        name: string;
+        /**
+         * The type of component it is.
+         * See https://developers.google.com/maps/documentation/places/web-service/legacy/supported_types#table2 for a list of possible types.
+         */
+        type: string;
+        /** How strongly the validator believes the result to be correct. */
+        confirmationLevel?: AddressValidationResultConfirmationLevel;
+        /** Whether this component was inferred by the validator, i.e. it was not present on the original input. */
+        inferred?: boolean;
+        /** Whether this component had spelling corrected by the validator. */
+        spellCorrected?: boolean;
+        /** Whether this component had its original value completely replaced by the validator. */
+        replaced?: boolean;
+        /** Whether the validator believes this component to be unexpected for the supplied address. */
+        unexpected?: boolean;
+    }[];
+    /**
+     * Component types that were expected to be on the address, but were not present and could not be inferred by the validator.
+     * See https://developers.google.com/maps/documentation/places/web-service/legacy/supported_types#table2 for a list of possible types.
+     */
+    missingComponentTypes?: string[];
+}
+declare enum AddressValidationJobStatus {
+    Created = "Created",
+    Processing = "Processing",
+    Completed = "Completed",
+    Failed = "Failed",
+    Cancelled = "Cancelled"
+}
+interface AddressValidationJob {
+    id: string;
+    /** The entity this job was created for. */
+    entityId?: string;
+    /** The current status of this Job. */
+    status: AddressValidationJobStatus;
+    /** The datetime of when this Job was created. */
+    createdAt: string;
+    /** The datetime of when this Job was last updated. */
+    updatedAt: string;
+    /** The validation result. Only present if status is `Confirmed`. */
+    result?: AddressValidationResult;
+}
+/**
+ * Fetches Recipients and their associated Address Validation Jobs.
+ * The resulting array will be in the same order as the input `ids`. If a Recipient does not have an associated Job, it will be `undefined`.
+ * @param ids An array of Recipient id strings.
+ * @returns The associated Address Validation Jobs for the requested Recipients.
+ */
+declare const getRecipientsAddressValidationJobs: (ids: string[]) => Promise<(AddressValidationJob | undefined)[] | undefined>;
+/**
+ * Retrieves an up-to-date version of the requested Address Validation Jobs.
+ * If a Job has been completed, the validation result will be present on the object.
+ * @param ids An array of Address Validation Job id strings.
+ * @returns An array of Address Validation Jobs.
+ */
+declare const getAddressValidationJobs: (ids: string[]) => Promise<AddressValidationJob[] | undefined>;
+/**
+ * Validate a single Recipient's address.
+ * @param id The id of the Recipient.
+ * @returns The validation result.
+ */
+declare const validateRecipient: (id: string) => Promise<AddressValidationResult | undefined>;
+/**
+ * Requests to validate many Recipients' addresses asynchronously.
+ * @param ids The ids of the Recipients to validate.
+ * @returns An array of Address Validation Jobs.
+ * These will likely be incomplete; consider polling `getAddressValidationJobs` with the ids of the Jobs you get from this function.
+ */
+declare const validateRecipients: (ids: string[]) => Promise<AddressValidationJob[] | undefined>;
+
+export { AddonHandle, AddressValidationJob, AddressValidationJobStatus, AddressValidationResult, AddressValidationResultConfirmationLevel, Animatable, AnyStepData, ArrayInput, AspectType, Asset, AssetConfiguration, AssetNotFoundError, AssetObjectVersion, AssetType, BringForwardCommand, BringToBackCommand, BringToFrontCommand, Bundle$1 as Bundle, BundleDesignCreationCartAddMode, BundleDesignCreationMessage, BundleEvent, BundleEventData, BundleEventType, BundleStakeholder, CanvasCommand, CollectionProduct, ColorDefinition, ColorOption, ColorOptionGlobalPropertyHandle, ColorProfileProps, CommandContext, CommandState, Condition, ConditionalGlobalPropertiesChangedEventData, CreateElementCommand, CreateLayoutCommand, Customer, CustomerDetailsInput, DeleteElementCommand, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, DigitalContentStepData, DigitalContentStepHandle, EditedSteps, FileUploadGlobalPropertyHandle, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FontAlignmentCommand, FontColorCommand, FontSizeCommand, FontSourceCommand, FrameElement, FrameService, FrameStep, FrameStepData, FrameStepHandle, FrameThresholdSettings, GetNewWorkflowOptions, GetWorkflowOptions, GlobalPropertyConfiguration, GlobalPropertyHandle, GroupCommand, ILayout, IllustrationElement, IllustrationStepData, IllustrationStepHandle, ImageElement, InformationMessageType, InformationResult, InformationStepData, InformationStepHandle, Integration, IntegrationOptionResource, IntegrationProduct, IntegrationType, LayoutData, LayoutElement, LayoutElementFactory, LayoutElementType, LayoutNotFoundError, LayoutRenderingPurpose, LayoutState, LayoutsState, MandatorySteps, MaterialEffectMode, MaterialStepData, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepData, ModelStepHandle, ModuleStepData, ModuleStepHandle, MoveCommand, NodeType, ObjectInput, ObjectInputType, OptionGlobalPropertyHandle, OptionNotFoundError, OptionResource, Order, OrderItem, PapyrusComponent, ParseError, PictureStepData, PictureStepHandle, Placeable, PmsSearchResult, Point, Product, ProductCameraRig, ProductCollection, ProductCollectionProductSortKey, ProductWorkflow$1 as ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepData, QuestionStepHandle, QueueablePromise, Recipient, Region, RegionElement, RenderableScene, ResizeCommand, ResourceNotFoundError, RotateCommand, SavedDesign, ScaleAxis, SelectionStorage, SendBackwardsCommand, ShapeStepData, ShapeStepHandle, ShareAction, ShareActionType, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, Step, StepAspect, StepAspectType, StepElements, StepGroup, StepHandle, StepStorage, StepType, TextAlgorithm, TextChangeCommand, TextChangeResult, TextGlobalPropertyHandle, TextInput, TextStepData, TextStepHandle, TextStepStorage, TextboxElement, Theme, ToastCallback, Transaction, Transform, TransformCollection$1 as TransformCollection, UnhandledBehaviorError, UnitOfMeasurement, UpdateImageSourceCommand, Variant, VariantResource, Vector3, Workflow, WorkflowExperience, WorkflowExperienceEventType, WorkflowExperienceHoverEventData, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowPanel, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, browserColorToHex, cmPerPixel, createDesign, currentDirection, dataUrlFromExternalUrl, designService, determineCorrectFontSizeAndLines, digitalContentStepService, domParser, duplicateBundle, duplicateTransaction, fetchAsString, findAngle, findElement, findPmsColors, frameDataCache, frameStepService, generate, generateCommands, generateSVGWithUnknownColors, generateStateFromDesignInputSteps, getAddressValidationJobs, getAttributesFromArrayBuffer, getAxisAlignedBoundingBox, getBoundedOffsets, getBundleThemeConfiguration, getCustomer, getCustomerBundles, getElementVertices, getFrameData, getIntegration, getNEPoint, getNWPoint, getOrderedTransactions, getOverrideThemeConfiguration, getPointOfRotation, getProductCollections, getRecipientsAddressValidationJobs, getSEPoint, getSvgElement, getTemplateBundles, getTemplateTransactions, getTransaction, getTransactionThemeConfiguration, getTransactionsForBundle, getTrueCoordinates, getUnorderedTransactions, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, isCloseToValue, loadFont, matchHexToPms, materialStepService, metafieldManager, mmPerPixel, modelStepService, modifySVGColors, moduleStepService, nameBundle, nameTransaction, optionService, outlineFontsInSvg, patternImageDataCache, persistenceService, pictureStepService, pmsToRgb, questionStepService, registerFetchImplementation, registerWindowImplementation, rehydrateSerializedLayout, rgbToPms, rotateAroundPoint, sanitizeSvgTree, setBearerAuthenticationToken, setCanvasModule, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, svgColorValueToDefinition, svgStringDimensions, svgToDataUrl, textStepService, toast, validateRecipient, validateRecipients, xmlSerializer };