@socotra/ec-react-components 2.10.0 → 2.11.0-next.0

package/dist/index.d.ts

@@ -8,6 +8,8 @@ import { CreditDistributionReverseRequest } 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 { DisbursementCreateRequest } from '@socotra/ec-react-schemas';
+import { DisbursementRefRecord } from '@socotra/ec-react-schemas';
 import { ElementConfig } from '@socotra/ec-react-schemas';
 import { ElementRequest } from '@socotra/ec-react-schemas';
 import { ElementResponse } from '@socotra/ec-react-schemas';
@@ -61,6 +63,19 @@ export declare const ExistingPaymentForm: {
     displayName: string;
 };
 
+declare type GetDisbursementFormDefaultFieldsProps = {
+    disbursements: DisbursementRefRecord;
+    accountBalance: number;
+    currency: CurrencyType;
+    titles?: {
+        amount?: string;
+        type?: string;
+        transactionMethod?: string;
+        transactionMethods?: Record<TransactionMethodEnum, string>;
+        transactionNumber?: string;
+    };
+};
+
 declare type GetPaymentFormDefaultFieldsProps = {
     payments: PaymentConfigRecord;
     currency: CurrencyType;
@@ -82,6 +97,14 @@ export declare const InitializedTransactionForm: {
     displayName: string;
 };
 
+/**
+ * DisbursementForm is a form for creating a disbursement.
+ */
+export declare const NewDisbursementForm: {
+    ({ accountLocator, accountBalance, currency, validateOnSubmit, hideSubmitButton, submitButtonText, handleSubmit, isSubmitting, disabled, dataModel, id, titles, }: Props_10): JSX_2.Element;
+    displayName: string;
+};
+
 /**
  * PaymentForm is a form for making a payment.
  */
@@ -181,6 +204,59 @@ declare type Props = {
     };
 };
 
+declare type Props_10 = {
+    /**
+     * Account locator
+     */
+    accountLocator: string;
+    /**
+     * Account balance
+     */
+    accountBalance: number;
+    /**
+     * 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: DisbursementCreateRequest) => 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<GetDisbursementFormDefaultFieldsProps['titles']>;
+};
+
 declare type Props_2 = {
     /**
      * The quote object