@justifi/webcomponents 5.7.2 → 5.7.3

package/dist/types/components.d.ts

@@ -60,7 +60,13 @@ export namespace Components {
         "getBusiness": Function;
     }
     interface BusinessDocumentsOnFile {
+        /**
+          * @default []
+         */
         "documents": any;
+        /**
+          * @default false
+         */
         "isLoading": boolean;
     }
     interface CardForm {
@@ -77,9 +83,21 @@ export namespace Components {
     }
     interface CustomPopper {
         "anchorRef": HTMLElement | SVGElement;
+        /**
+          * @default [0, 10]
+         */
         "offset": [number, number];
+        /**
+          * @default 'bottom'
+         */
         "placement": Placement;
+        /**
+          * @default 'absolute'
+         */
         "strategy": PositioningStrategy;
+        /**
+          * @default 'click'
+         */
         "trigger": string;
     }
     interface FormAlert {
@@ -102,6 +120,9 @@ export namespace Components {
         "helpText"?: string;
         "inputHandler": (name: string, value: string) => void;
         "label": string;
+        /**
+          * @default this.currentDate
+         */
         "maxDate"?: string;
         "name": string;
         "showTime"?: boolean;
@@ -130,6 +151,9 @@ export namespace Components {
         "name": string;
     }
     interface FormControlMonetary {
+        /**
+          * @default '0'
+         */
         "defaultValue"?: string;
         "disabled"?: boolean;
         "errorText"?: string;
@@ -147,6 +171,9 @@ export namespace Components {
         "helpText"?: string;
         "inputHandler": (name: string, value: string) => void;
         "label": string;
+        /**
+          * @default CURRENCY_MASK.DECIMAL
+         */
         "maskOptions": any;
         "name": string;
     }
@@ -243,6 +270,9 @@ export namespace Components {
     }
     interface JustifiAdditionalStatement {
         "disputeResponse": any;
+        /**
+          * @default {}
+         */
         "documentErrors": any;
         "validateAndSubmit": (onSuccess: (formData: any, documentList: DisputeEvidenceDocument[], formStep: DisputeResponseFormStep) => void) => Promise<void>;
     }
@@ -297,8 +327,17 @@ export namespace Components {
     interface JustifiBusinessForm {
         "authToken": string;
         "businessId": string;
+        /**
+          * @default 'Business Information'
+         */
         "formTitle"?: string;
+        /**
+          * @default false
+         */
         "hideErrors"?: boolean;
+        /**
+          * @default false
+         */
         "removeTitle"?: boolean;
     }
     interface JustifiBusinessOwnersFormStep {
@@ -343,6 +382,9 @@ export namespace Components {
     }
     interface JustifiCancellationPolicy {
         "disputeResponse": any;
+        /**
+          * @default {}
+         */
         "documentErrors": any;
         "validateAndSubmit": (onSuccess: (formData: any, documentList: DisputeEvidenceDocument[], formStep: DisputeResponseFormStep) => void) => Promise<void>;
     }
@@ -375,6 +417,9 @@ export namespace Components {
     interface JustifiCheckoutsList {
         "accountId": string;
         "authToken": string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
     }
     interface JustifiCheckoutsListFilters {
@@ -382,12 +427,24 @@ export namespace Components {
         "paymentMode"?: ICheckoutPaymentModeParam;
     }
     interface JustifiConfigProvider {
+        /**
+          * @default ''
+         */
         "accountId"?: string;
+        /**
+          * @default PROXY_API_ORIGIN
+         */
         "apiOrigin"?: string;
+        /**
+          * @default IFRAME_ORIGIN
+         */
         "iframeOrigin"?: string;
     }
     interface JustifiCustomerDetails {
         "disputeResponse": any;
+        /**
+          * @default {}
+         */
         "documentErrors": any;
         "validateAndSubmit": (onSuccess: (formData: any, documentList: DisputeEvidenceDocument[], formStep: DisputeResponseFormStep) => void) => Promise<void>;
     }
@@ -409,6 +466,9 @@ export namespace Components {
         "isLoading": boolean;
     }
     interface JustifiDisputeResponse {
+        /**
+          * @default PROXY_API_ORIGIN
+         */
         "apiOrigin"?: string;
         "authToken": string;
         "disputeId": string;
@@ -420,6 +480,9 @@ export namespace Components {
     onSuccess: (disputeResponse: any) => void,
     onError: (disputeResponse: any) => void
   }) => Promise<IApiResponse<any>>;
+        /**
+          * @default {}
+         */
         "disputeResponse": any;
         "submitDisputeResponse": (args: {
     payload: any,
@@ -434,11 +497,17 @@ export namespace Components {
     }
     interface JustifiDuplicateCharge {
         "disputeResponse": any;
+        /**
+          * @default {}
+         */
         "documentErrors": any;
         "validateAndSubmit": (onSuccess: (formData: any, documentList: DisputeEvidenceDocument[], formStep: DisputeResponseFormStep) => void) => Promise<void>;
     }
     interface JustifiElectronicEvidence {
         "disputeResponse": any;
+        /**
+          * @default {}
+         */
         "documentErrors": any;
         "validateAndSubmit": (onSuccess: (formData: any, documentList: DisputeEvidenceDocument[], formStep: DisputeResponseFormStep) => void) => Promise<void>;
     }
@@ -484,7 +553,13 @@ export namespace Components {
         "accountId": string;
         "authToken": string;
         "businessId": string;
+        /**
+          * @default false
+         */
         "shipping": boolean;
+        /**
+          * @default 'Submit Order'
+         */
         "submitButtonText": string;
     }
     interface JustifiOwnerForm {
@@ -514,6 +589,9 @@ export namespace Components {
         "paymentAmount": number;
         "paymentMethodGroupId"?: string;
         "resolvePaymentMethod": (insuranceValidation: any) => Promise<PaymentMethodPayload>;
+        /**
+          * @default []
+         */
         "savedPaymentMethods": any[];
         "showAch": boolean;
         "showBnpl": boolean;
@@ -522,12 +600,21 @@ export namespace Components {
         "validate": () => Promise<{ isValid: boolean; errors?: any; }>;
     }
     interface JustifiPaymentProvisioning {
+        /**
+          * @default false
+         */
         "allowOptionalFields"?: boolean;
         "authToken": string;
         "businessId": string;
+        /**
+          * @default 'Business Information'
+         */
         "formTitle"?: string;
     }
     interface JustifiPaymentProvisioningCore {
+        /**
+          * @default false
+         */
         "allowOptionalFields"?: boolean;
         "authToken": string;
         "businessId": string;
@@ -544,6 +631,9 @@ export namespace Components {
         "totalSteps": number;
     }
     interface JustifiPaymentProvisioningFormSteps {
+        /**
+          * @default false
+         */
         "allowOptionalFields"?: boolean;
         "authToken": string;
         "businessId": string;
@@ -553,12 +643,18 @@ export namespace Components {
     }
     interface JustifiPaymentTransactionsList {
         "authToken": string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "paymentId": string;
     }
     interface JustifiPaymentsList {
         "accountId": string;
         "authToken": string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
     }
     interface JustifiPaymentsListFilters {
@@ -574,12 +670,18 @@ export namespace Components {
     }
     interface JustifiPayoutTransactionsList {
         "authToken": string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "payoutId": string;
     }
     interface JustifiPayoutsList {
         "accountId": string;
         "authToken": string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
     }
     interface JustifiPayoutsListFilters {
@@ -588,18 +690,27 @@ export namespace Components {
     }
     interface JustifiProductOrService {
         "disputeResponse": any;
+        /**
+          * @default {}
+         */
         "documentErrors": any;
         "validateAndSubmit": (onSuccess: (formData: any, documentList: DisputeEvidenceDocument[], formStep: DisputeResponseFormStep) => void) => Promise<void>;
     }
     interface JustifiRefundPayment {
         "accountId": string;
         "authToken": string;
+        /**
+          * @default false
+         */
         "hideSubmitButton"?: boolean;
         "paymentId": string;
         "refundPayment": (event?: CustomEvent) => Promise<IRefund>;
     }
     interface JustifiRefundPolicy {
         "disputeResponse": any;
+        /**
+          * @default {}
+         */
         "documentErrors": any;
         "validateAndSubmit": (onSuccess: (formData: any, documentList: DisputeEvidenceDocument[], formStep: DisputeResponseFormStep) => void) => Promise<void>;
     }
@@ -654,12 +765,18 @@ export namespace Components {
     }
     interface JustifiShippingDetails {
         "disputeResponse": any;
+        /**
+          * @default {}
+         */
         "documentErrors": any;
         "validateAndSubmit": (onSuccess: (formData: any, documentList: DisputeEvidenceDocument[], formStep: DisputeResponseFormStep) => void) => Promise<void>;
     }
     interface JustifiTerminalOrdersList {
         "accountId": string;
         "authToken": string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
     }
     interface JustifiTerminalOrdersListFilters {
@@ -671,6 +788,9 @@ export namespace Components {
     interface JustifiTerminalsList {
         "accountId": string;
         "authToken": string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
     }
     interface JustifiTerminalsListFilters {
@@ -688,6 +808,9 @@ export namespace Components {
         "hideCardBillingForm"?: boolean;
         "hideSubmitButton"?: boolean;
         "paymentMethodGroupId": string;
+        /**
+          * @default 'Submit'
+         */
         "submitButtonText": string;
         "tokenizePaymentMethod": (event?: CustomEvent) => Promise<PaymentMethodPayload>;
         "validate": () => Promise<{ isValid: boolean; errors?: any; }>;
@@ -719,7 +842,13 @@ export namespace Components {
         "ownerDefaultValue": any;
     }
     interface PaginationMenu {
+        /**
+          * @default ExtendedPagingDefaults
+         */
         "paging": PaginationProps['paging'];
+        /**
+          * @default {}
+         */
         "params": PaginationProps['params'];
     }
     interface PaymentDetailsCore {
@@ -754,6 +883,9 @@ export namespace Components {
         "description": string;
         "helpUrl": string;
         "imageUrl": string;
+        /**
+          * @default Infinity
+         */
         "limit": number;
         "modelName": TerminalModelName;
     }
@@ -2662,7 +2794,13 @@ declare namespace LocalJSX {
         "onError-event"?: (event: BusinessDetailsCoreCustomEvent<ComponentErrorEvent>) => void;
     }
     interface BusinessDocumentsOnFile {
+        /**
+          * @default []
+         */
         "documents"?: any;
+        /**
+          * @default false
+         */
         "isLoading"?: boolean;
     }
     interface CardForm {
@@ -2679,11 +2817,23 @@ declare namespace LocalJSX {
     }
     interface CustomPopper {
         "anchorRef"?: HTMLElement | SVGElement;
+        /**
+          * @default [0, 10]
+         */
         "offset"?: [number, number];
         "onHideEvent"?: (event: CustomPopperCustomEvent<any>) => void;
         "onShowEvent"?: (event: CustomPopperCustomEvent<any>) => void;
+        /**
+          * @default 'bottom'
+         */
         "placement"?: Placement;
+        /**
+          * @default 'absolute'
+         */
         "strategy"?: PositioningStrategy;
+        /**
+          * @default 'click'
+         */
         "trigger"?: string;
     }
     interface FormAlert {
@@ -2708,6 +2858,9 @@ declare namespace LocalJSX {
         "helpText"?: string;
         "inputHandler"?: (name: string, value: string) => void;
         "label"?: string;
+        /**
+          * @default this.currentDate
+         */
         "maxDate"?: string;
         "name"?: string;
         "onFormControlBlur"?: (event: FormControlDateCustomEvent<any>) => void;
@@ -2743,6 +2896,9 @@ declare namespace LocalJSX {
         "name"?: string;
     }
     interface FormControlMonetary {
+        /**
+          * @default '0'
+         */
         "defaultValue"?: string;
         "disabled"?: boolean;
         "errorText"?: string;
@@ -2762,6 +2918,9 @@ declare namespace LocalJSX {
         "helpText"?: string;
         "inputHandler"?: (name: string, value: string) => void;
         "label"?: string;
+        /**
+          * @default CURRENCY_MASK.DECIMAL
+         */
         "maskOptions"?: any;
         "name"?: string;
         "onFormControlBlur"?: (event: FormControlMonetaryProvisioningCustomEvent<any>) => void;
@@ -2874,6 +3033,9 @@ declare namespace LocalJSX {
     }
     interface JustifiAdditionalStatement {
         "disputeResponse"?: any;
+        /**
+          * @default {}
+         */
         "documentErrors"?: any;
     }
     interface JustifiBillingForm {
@@ -2929,11 +3091,20 @@ declare namespace LocalJSX {
     interface JustifiBusinessForm {
         "authToken"?: string;
         "businessId"?: string;
+        /**
+          * @default 'Business Information'
+         */
         "formTitle"?: string;
+        /**
+          * @default false
+         */
         "hideErrors"?: boolean;
         "onClick-event"?: (event: JustifiBusinessFormCustomEvent<ComponentClickEvent>) => void;
         "onError-event"?: (event: JustifiBusinessFormCustomEvent<ComponentErrorEvent>) => void;
         "onSubmit-event"?: (event: JustifiBusinessFormCustomEvent<ComponentSubmitEvent>) => void;
+        /**
+          * @default false
+         */
         "removeTitle"?: boolean;
     }
     interface JustifiBusinessOwnersFormStep {
@@ -2986,6 +3157,9 @@ declare namespace LocalJSX {
     }
     interface JustifiCancellationPolicy {
         "disputeResponse"?: any;
+        /**
+          * @default {}
+         */
         "documentErrors"?: any;
     }
     interface JustifiCheckout {
@@ -3018,6 +3192,9 @@ declare namespace LocalJSX {
     interface JustifiCheckoutsList {
         "accountId"?: string;
         "authToken"?: string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "onError-event"?: (event: JustifiCheckoutsListCustomEvent<ComponentErrorEvent>) => void;
     }
@@ -3026,12 +3203,24 @@ declare namespace LocalJSX {
         "paymentMode"?: ICheckoutPaymentModeParam;
     }
     interface JustifiConfigProvider {
+        /**
+          * @default ''
+         */
         "accountId"?: string;
+        /**
+          * @default PROXY_API_ORIGIN
+         */
         "apiOrigin"?: string;
+        /**
+          * @default IFRAME_ORIGIN
+         */
         "iframeOrigin"?: string;
     }
     interface JustifiCustomerDetails {
         "disputeResponse"?: any;
+        /**
+          * @default {}
+         */
         "documentErrors"?: any;
     }
     interface JustifiDetails {
@@ -3057,6 +3246,9 @@ declare namespace LocalJSX {
         "onSubmit-event"?: (event: JustifiDisputeNotificationCustomEvent<ComponentSubmitEvent>) => void;
     }
     interface JustifiDisputeResponse {
+        /**
+          * @default PROXY_API_ORIGIN
+         */
         "apiOrigin"?: string;
         "authToken"?: string;
         "disputeId"?: string;
@@ -3069,6 +3261,9 @@ declare namespace LocalJSX {
     onSuccess: (disputeResponse: any) => void,
     onError: (disputeResponse: any) => void
   }) => Promise<IApiResponse<any>>;
+        /**
+          * @default {}
+         */
         "disputeResponse"?: any;
         "onClick-event"?: (event: JustifiDisputeResponseCoreCustomEvent<ComponentClickEvent>) => void;
         "onComplete-form-step-event"?: (event: JustifiDisputeResponseCoreCustomEvent<ComponentFormStepCompleteEvent>) => void;
@@ -3087,10 +3282,16 @@ declare namespace LocalJSX {
     }
     interface JustifiDuplicateCharge {
         "disputeResponse"?: any;
+        /**
+          * @default {}
+         */
         "documentErrors"?: any;
     }
     interface JustifiElectronicEvidence {
         "disputeResponse"?: any;
+        /**
+          * @default {}
+         */
         "documentErrors"?: any;
     }
     interface JustifiGrossPaymentChart {
@@ -3138,7 +3339,13 @@ declare namespace LocalJSX {
         "businessId"?: string;
         "onError-event"?: (event: JustifiOrderTerminalsCustomEvent<ComponentErrorEvent1>) => void;
         "onSubmit-event"?: (event: JustifiOrderTerminalsCustomEvent<any>) => void;
+        /**
+          * @default false
+         */
         "shipping"?: boolean;
+        /**
+          * @default 'Submit Order'
+         */
         "submitButtonText"?: string;
     }
     interface JustifiOwnerForm {
@@ -3165,6 +3372,9 @@ declare namespace LocalJSX {
         "insuranceToggled"?: boolean;
         "paymentAmount"?: number;
         "paymentMethodGroupId"?: string;
+        /**
+          * @default []
+         */
         "savedPaymentMethods"?: any[];
         "showAch"?: boolean;
         "showBnpl"?: boolean;
@@ -3172,13 +3382,22 @@ declare namespace LocalJSX {
         "showSavedPaymentMethods"?: boolean;
     }
     interface JustifiPaymentProvisioning {
+        /**
+          * @default false
+         */
         "allowOptionalFields"?: boolean;
         "authToken"?: string;
         "businessId"?: string;
+        /**
+          * @default 'Business Information'
+         */
         "formTitle"?: string;
         "onError-event"?: (event: JustifiPaymentProvisioningCustomEvent<ComponentErrorEvent>) => void;
     }
     interface JustifiPaymentProvisioningCore {
+        /**
+          * @default false
+         */
         "allowOptionalFields"?: boolean;
         "authToken"?: string;
         "businessId"?: string;
@@ -3198,6 +3417,9 @@ declare namespace LocalJSX {
         "totalSteps"?: number;
     }
     interface JustifiPaymentProvisioningFormSteps {
+        /**
+          * @default false
+         */
         "allowOptionalFields"?: boolean;
         "authToken"?: string;
         "businessId"?: string;
@@ -3207,6 +3429,9 @@ declare namespace LocalJSX {
     }
     interface JustifiPaymentTransactionsList {
         "authToken"?: string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "onClick-event"?: (event: JustifiPaymentTransactionsListCustomEvent<ComponentClickEvent1>) => void;
         "onError-event"?: (event: JustifiPaymentTransactionsListCustomEvent<ComponentErrorEvent1>) => void;
@@ -3215,6 +3440,9 @@ declare namespace LocalJSX {
     interface JustifiPaymentsList {
         "accountId"?: string;
         "authToken"?: string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "onError-event"?: (event: JustifiPaymentsListCustomEvent<ComponentErrorEvent>) => void;
     }
@@ -3232,6 +3460,9 @@ declare namespace LocalJSX {
     }
     interface JustifiPayoutTransactionsList {
         "authToken"?: string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "onClick-event"?: (event: JustifiPayoutTransactionsListCustomEvent<ComponentClickEvent1>) => void;
         "onError-event"?: (event: JustifiPayoutTransactionsListCustomEvent<ComponentErrorEvent1>) => void;
@@ -3240,6 +3471,9 @@ declare namespace LocalJSX {
     interface JustifiPayoutsList {
         "accountId"?: string;
         "authToken"?: string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "onError-event"?: (event: JustifiPayoutsListCustomEvent<ComponentErrorEvent>) => void;
     }
@@ -3249,11 +3483,17 @@ declare namespace LocalJSX {
     }
     interface JustifiProductOrService {
         "disputeResponse"?: any;
+        /**
+          * @default {}
+         */
         "documentErrors"?: any;
     }
     interface JustifiRefundPayment {
         "accountId"?: string;
         "authToken"?: string;
+        /**
+          * @default false
+         */
         "hideSubmitButton"?: boolean;
         "onError-event"?: (event: JustifiRefundPaymentCustomEvent<ComponentErrorEvent1>) => void;
         "onSubmit-event"?: (event: JustifiRefundPaymentCustomEvent<ComponentSubmitEvent1>) => void;
@@ -3261,6 +3501,9 @@ declare namespace LocalJSX {
     }
     interface JustifiRefundPolicy {
         "disputeResponse"?: any;
+        /**
+          * @default {}
+         */
         "documentErrors"?: any;
     }
     interface JustifiSaveNewPaymentMethod {
@@ -3316,11 +3559,17 @@ declare namespace LocalJSX {
     }
     interface JustifiShippingDetails {
         "disputeResponse"?: any;
+        /**
+          * @default {}
+         */
         "documentErrors"?: any;
     }
     interface JustifiTerminalOrdersList {
         "accountId"?: string;
         "authToken"?: string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "onError-event"?: (event: JustifiTerminalOrdersListCustomEvent<ComponentErrorEvent1>) => void;
     }
@@ -3333,6 +3582,9 @@ declare namespace LocalJSX {
     interface JustifiTerminalsList {
         "accountId"?: string;
         "authToken"?: string;
+        /**
+          * @default defaultColumnsKeys
+         */
         "columns"?: string;
         "onError-event"?: (event: JustifiTerminalsListCustomEvent<ComponentErrorEvent>) => void;
     }
@@ -3352,6 +3604,9 @@ declare namespace LocalJSX {
         "onError-event"?: (event: JustifiTokenizePaymentMethodCustomEvent<ComponentErrorEvent1>) => void;
         "onSubmit-event"?: (event: JustifiTokenizePaymentMethodCustomEvent<ComponentSubmitEvent1>) => void;
         "paymentMethodGroupId"?: string;
+        /**
+          * @default 'Submit'
+         */
         "submitButtonText"?: string;
     }
     interface LegalAddressDetails {
@@ -3381,7 +3636,13 @@ declare namespace LocalJSX {
         "ownerDefaultValue"?: any;
     }
     interface PaginationMenu {
+        /**
+          * @default ExtendedPagingDefaults
+         */
         "paging"?: PaginationProps['paging'];
+        /**
+          * @default {}
+         */
         "params"?: PaginationProps['params'];
     }
     interface PaymentDetailsCore {
@@ -3424,6 +3685,9 @@ declare namespace LocalJSX {
         "description"?: string;
         "helpUrl"?: string;
         "imageUrl"?: string;
+        /**
+          * @default Infinity
+         */
         "limit"?: number;
         "modelName"?: TerminalModelName;
         "onSelectedQuantityChange"?: (event: TerminalQuantitySelectorCustomEvent<{ modelName: TerminalModelName, quantity: number }>) => void;