@socotra/ec-react-components 2.7.0 → 2.8.0-next.0

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { AccountRequest } from '@socotra/ec-react-schemas';
 import { AccountResponse } from '@socotra/ec-react-schemas';
 import { ConstraintEvaluationResponse } from '@socotra/ec-react-schemas';
 import { CoverageTermsConfigRecord } from '@socotra/ec-react-schemas';
+import { CurrencyType } from '@socotra/ec-react-schemas';
 import { DataModel } from '@socotra/ec-react-schemas';
 import { DataTypeConfigRecord } from '@socotra/ec-react-schemas';
 import { ElementConfig } from '@socotra/ec-react-schemas';
@@ -14,12 +15,15 @@ import { ModifyChangeInstructionCreateRequest } from '@socotra/ec-react-schemas'
 import { ModifyChangeInstructionResponse } from '@socotra/ec-react-schemas';
 import { ParamsChangeInstructionCreateRequest } from '@socotra/ec-react-schemas';
 import { ParamsChangeInstructionResponse } from '@socotra/ec-react-schemas';
+import { PaymentConfigRecord } from '@socotra/ec-react-schemas';
+import { PaymentRequest as PaymentRequest_2 } from '@socotra/ec-react-schemas';
 import { PolicyResponse } from '@socotra/ec-react-schemas';
 import { ProductConfig } from '@socotra/ec-react-schemas';
 import { QuoteDependencyMapResponse } from '@socotra/ec-react-schemas';
 import { QuoteRequest } from '@socotra/ec-react-schemas';
 import { QuoteResponse } from '@socotra/ec-react-schemas';
 import { SegmentResponse } from '@socotra/ec-react-schemas';
+import { TransactionMethodEnum } from '@socotra/ec-react-schemas';
 import { TransactionSnapshotResponse } from '@socotra/ec-react-schemas';
 
 /**
@@ -34,7 +38,7 @@ export declare const AccountForm: {
  * `DraftTransactionForm` is a form for updating a transaction on an issued policy. It requires a transaction in a `draft` state, a `transactionSnapshot`, `paramsChangeInstruction` (created when the transaction is created), and data types / product model / coverage terms from the tenant data model.
  */
 export declare const DraftTransactionForm: {
-    ({ transactionSnapshot, handleSubmit, paramsChangeInstruction, modifyChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, titles, }: Props_6): JSX_2.Element;
+    ({ transactionSnapshot, handleSubmit, paramsChangeInstruction, modifyChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, titles, }: Props_7): JSX_2.Element;
     displayName: string;
 };
 
@@ -46,11 +50,36 @@ export declare const ElementForm: {
     displayName: string;
 };
 
+export declare const ExistingPaymentForm: {
+    (): JSX_2.Element;
+    displayName: string;
+};
+
+declare type GetPaymentFormDefaultFieldsProps = {
+    payments: PaymentConfigRecord;
+    currency: CurrencyType;
+    titles?: {
+        amount?: string;
+        type?: string;
+        transactionMethod?: string;
+        transactionMethods?: Record<TransactionMethodEnum, string>;
+        transactionNumber?: string;
+    };
+};
+
 /**
  * `InitializedTransactionForm` is a form for updating a transaction on an issued policy. It requires a transaction in an `initialized` state, the current `segment`, and data types / product model / coverage terms from the tenant data model.
  */
 export declare const InitializedTransactionForm: {
-    ({ elementResponse, handleSubmit, paramsChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, titles, }: Props_5): JSX_2.Element;
+    ({ elementResponse, handleSubmit, paramsChangeInstruction, preventFormResetOnDisabled, disabled, hideSubmitButton, validateOnSubmit, isSubmitting, submitButtonText, id, dataTypes, productModel, coverageTerms, titles, }: Props_6): JSX_2.Element;
+    displayName: string;
+};
+
+/**
+ * PaymentForm is a form for making a payment.
+ */
+export declare const NewPaymentForm: {
+    ({ accountLocator, invoiceLocator, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, dataModel, id, titles, }: Props_5): JSX_2.Element;
     displayName: string;
 };
 
@@ -338,6 +367,59 @@ declare type Props_4 = {
 };
 
 declare type Props_5 = {
+    /**
+     * Account locator
+     */
+    accountLocator: string;
+    /**
+     * Invoice locator
+     */
+    invoiceLocator: string;
+    /**
+     * The currency of the invoice
+     */
+    currency: CurrencyType;
+    /**
+     * The resolved data model retrieved from data model response
+     */
+    dataModel: DataModel;
+    /**
+     * The function to call when the form is submitted. It will create an PaymentRequest from the form data.
+     */
+    handleSubmit: (data: PaymentRequest_2) => void;
+    /**
+     * Set to true when the form is submitting to set fields to readonly and disable the submit button
+     */
+    isSubmitting?: boolean;
+    /**
+     * Disables the form
+     */
+    disabled?: boolean;
+    /**
+     * Hides the submit button
+     */
+    hideSubmitButton?: boolean;
+    /**
+     * Whether to validate the form on submit
+     */
+    validateOnSubmit?: boolean;
+    /**
+     * The text to display on the submit button
+     */
+    submitButtonText?: string;
+    /**
+     * ID for the form wrapper
+     * */
+    id?: string;
+    /**
+     * Titles
+     */
+    titles?: {
+        formTitle?: string;
+    } & Partial<GetPaymentFormDefaultFieldsProps['titles']>;
+};
+
+declare type Props_6 = {
     /**
      * The transaction snapshot object
      */
@@ -404,7 +486,7 @@ declare type Props_5 = {
     };
 };
 
-declare type Props_6 = {
+declare type Props_7 = {
     /**
      * The transaction snapshot object
      */