@amos.com/node 0.1.66 → 0.1.68

package/openapi/schema.ts

@@ -152,7 +152,7 @@ export interface paths {
         put?: never;
         /**
          * Create an external account
-         * @description Creates an organization-scoped external account. X-Account-Id is ignored if sent.
+         * @description Creates an organization-scoped external account. X-Account-Id is ignored if sent. For bank accounts, send account_number to store the number locally and skip Vault; otherwise send encrypted_account_number to tokenize in Vault.
          */
         post: operations["CreateExternalAccount"];
         delete?: never;
@@ -345,7 +345,19 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Approve a legal entity application */
+        /**
+         * Start review or approve a legal entity application
+         * @description Call this twice.
+         *
+         *     When the application is `submitted`, this moves it to `under_review`.
+         *     No legal entity is created. Run identity verification for each
+         *     application principal while the application is `under_review`.
+         *
+         *     When the application is `under_review`, this creates the legal entity,
+         *     merchants, accounts, and principals and moves the application to
+         *     `approved`, only if every application principal has a successful
+         *     identity verification.
+         */
         post: operations["ApproveLegalEntityApplication"];
         delete?: never;
         options?: never;
@@ -1327,8 +1339,9 @@ export interface components {
             account_type?: string;
             bank_name?: string;
             currency?: string;
-            /** @description Plaintext bank account number. Stored encrypted at rest. Not returned in API responses. */
+            /** @description Plaintext bank account number. Stored encrypted at rest and not returned in API responses. When present, Vault tokenization is skipped (payment methods and external bank accounts). */
             account_number?: string;
+            /** @description Vault-encrypted account number. Required on create when account_number is omitted; ignored for tokenization when account_number is present. */
             encrypted_account_number?: string;
             routing_number?: string;
         };
@@ -1734,6 +1747,8 @@ export interface components {
             updated_at?: string;
         };
         /** @enum {string} */
+        LegalEntityApplicationStateType: "pending" | "submitted" | "needs_information" | "under_review" | "approved" | "denied";
+        /** @enum {string} */
         LegalEntityEntityType: "individual_sole_proprietorship" | "corporation" | "limited_liability_company" | "partnership" | "limited_partnership" | "general_partnership" | "tax_exempt_organization" | "government_agency";
         /** @enum {string} */
         LegalEntityOwnershipType: "public" | "private";
@@ -1790,7 +1805,7 @@ export interface components {
             billing_address_attributes?: components["schemas"]["BillingAddressInput"];
             card_profile_attributes: components["schemas"]["CardProfileInput"];
         };
-        /** @description Confirm an embedded intent with a bank account. When ACH verification is required for the intent amount, include plaid credentials and omit bank_account_profile_attributes; routing and account numbers are filled server-side from Plaid Auth. Otherwise provide encrypted_account_number and routing_number on bank_account_profile_attributes. */
+        /** @description Confirm an embedded intent with a bank account. When ACH verification is required for the intent amount, include plaid credentials and omit bank_account_profile_attributes; routing and account numbers are filled server-side from Plaid Auth. Otherwise provide routing_number and either account_number (stored locally, skips Vault) or encrypted_account_number on bank_account_profile_attributes. */
         EmbedConfirmBankAccountPaymentMethodInput: {
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1924,7 +1939,7 @@ export interface components {
         /** @enum {string} */
         WalletProviderType: "googlepay" | "applepay";
         /** @enum {string} */
-        WebhookEventType: "charge.cancelled" | "charge.created" | "charge.errored" | "charge.failed" | "charge.processing" | "charge.requires_capture" | "charge.requires_confirmation" | "charge.requires_review" | "charge.settlement_failed" | "charge.succeeded" | "customer.created" | "customer.updated" | "legal_entity.created" | "legal_entity.updated" | "legal_entity_principal.created" | "legal_entity_principal.updated" | "legal_entity_application.approved" | "legal_entity_application.denied" | "legal_entity_application.needs_information" | "legal_entity_application.pending" | "legal_entity_application.submitted" | "merchant.created" | "merchant.updated" | "payment_intent.cancelled" | "payment_intent.created" | "payment_intent.errored_authorization" | "payment_intent.errored_capture" | "payment_intent.errored_sale" | "payment_intent.processing_authorization" | "payment_intent.processing_capture" | "payment_intent.processing_sale" | "payment_intent.requires_capture" | "payment_intent.requires_confirmation" | "payment_intent.requires_payment_method" | "payment_intent.requires_review" | "payment_intent.succeeded" | "payout.accepted" | "payout.errored" | "payout.failed" | "payout.pending" | "payout.processing" | "payout.rejected" | "payout.succeeded" | "processor_transaction.completed" | "reconciliation.created" | "refund.cancelled" | "refund.created" | "refund.failed" | "refund.pending" | "refund.processing" | "refund.requires_review" | "refund.succeeded" | "setup_intent.cancelled" | "setup_intent.created" | "setup_intent.errored" | "setup_intent.failed" | "setup_intent.requires_confirmation" | "setup_intent.requires_payment_method" | "setup_intent.requires_review" | "setup_intent.succeeded" | "setup_intent.verifying" | "void.created" | "void.failed" | "void.pending" | "void.processing" | "void.requires_review" | "void.succeeded";
+        WebhookEventType: "charge.cancelled" | "charge.created" | "charge.errored" | "charge.failed" | "charge.processing" | "charge.requires_capture" | "charge.requires_confirmation" | "charge.requires_review" | "charge.settlement_failed" | "charge.succeeded" | "customer.created" | "customer.updated" | "legal_entity.active" | "legal_entity.created" | "legal_entity.updated" | "legal_entity_principal.created" | "legal_entity_principal.updated" | "legal_entity_application.approved" | "legal_entity_application.denied" | "legal_entity_application.needs_information" | "legal_entity_application.pending" | "legal_entity_application.submitted" | "legal_entity_application.under_review" | "merchant.created" | "merchant.updated" | "payment_intent.cancelled" | "payment_intent.created" | "payment_intent.errored_authorization" | "payment_intent.errored_capture" | "payment_intent.errored_sale" | "payment_intent.processing_authorization" | "payment_intent.processing_capture" | "payment_intent.processing_sale" | "payment_intent.requires_capture" | "payment_intent.requires_confirmation" | "payment_intent.requires_payment_method" | "payment_intent.requires_review" | "payment_intent.succeeded" | "payout.accepted" | "payout.errored" | "payout.failed" | "payout.pending" | "payout.processing" | "payout.rejected" | "payout.succeeded" | "processor_transaction.completed" | "reconciliation.created" | "refund.cancelled" | "refund.created" | "refund.failed" | "refund.pending" | "refund.processing" | "refund.requires_review" | "refund.succeeded" | "setup_intent.cancelled" | "setup_intent.created" | "setup_intent.errored" | "setup_intent.failed" | "setup_intent.requires_confirmation" | "setup_intent.requires_payment_method" | "setup_intent.requires_review" | "setup_intent.succeeded" | "setup_intent.verifying" | "void.created" | "void.failed" | "void.pending" | "void.processing" | "void.requires_review" | "void.succeeded";
         CreateLegalEntityApplicationInput: {
             legal_name?: string;
             entity_type?: components["schemas"]["LegalEntityEntityType"];
@@ -1986,8 +2001,11 @@ export interface components {
             /** Format: uuid */
             id?: string;
             legal_name?: string;
-            /** Format: uuid */
-            legal_entity_id?: string;
+            /**
+             * Format: uuid
+             * @description Set when the application is approved and the legal entity is created.
+             */
+            legal_entity_id?: string | null;
             entity_type?: components["schemas"]["LegalEntityEntityType"];
             ownership_type?: components["schemas"]["LegalEntityOwnershipType"];
             contact_email?: string;
@@ -1998,7 +2016,7 @@ export interface components {
             business_state?: string;
             business_postal_code?: string;
             business_country?: string;
-            state?: string;
+            state?: components["schemas"]["LegalEntityApplicationStateType"];
             tax_id_last4?: string;
             /** Format: date-time */
             approved_at?: string | null;
@@ -2344,7 +2362,9 @@ export interface components {
                 account_type?: string;
                 bank_name?: string;
                 currency?: string;
+                /** @description Plaintext bank account number. Stored encrypted at rest and not returned in API responses. When present, Vault tokenization is skipped. */
                 account_number?: string;
+                /** @description Vault-encrypted account number. Required on create when account_number is omitted; ignored for tokenization when account_number is present. */
                 encrypted_account_number?: string;
                 token?: string;
                 routing_number?: string;
@@ -2481,6 +2501,8 @@ export interface components {
             organization_id?: string;
             prefix?: string;
             public_id?: string;
+            /** Format: uuid */
+            payout_batch_id?: string | null;
             state?: components["schemas"]["PayoutStateType"];
             /** Format: date-time */
             created_at?: string;
@@ -3809,7 +3831,7 @@ export interface operations {
         };
         requestBody?: never;
         responses: {
-            /** @description Legal entity application approved successfully */
+            /** @description Application moved to under_review, or approved after identity verification */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -3818,7 +3840,7 @@ export interface operations {
                     "application/json": components["schemas"]["LegalEntityApplication"];
                 };
             };
-            /** @description Legal entity application could not be approved */
+            /** @description Application could not start review or complete approval */
             422: {
                 headers: {
                     [name: string]: unknown;
@@ -6091,6 +6113,7 @@ export const cardProfileFailure_reasonValues: ReadonlyArray<FlattenedDeepRequire
 export const chargeAllowed_reverse_actionValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["Charge"]["allowed_reverse_action"]> = ["void", "refund"];
 export const chargeStateValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["Charge"]["state"]> = ["cancelled", "errored", "failed", "processing", "requires_capture", "requires_confirmation", "requires_review", "settlement_failed", "succeeded"];
 export const externalAccountTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["ExternalAccount"]["type"]> = ["external_card", "external_bank_account"];
+export const legalEntityApplicationStateTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["LegalEntityApplicationStateType"]> = ["pending", "submitted", "needs_information", "under_review", "approved", "denied"];
 export const legalEntityEntityTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["LegalEntityEntityType"]> = ["individual_sole_proprietorship", "corporation", "limited_liability_company", "partnership", "limited_partnership", "general_partnership", "tax_exempt_organization", "government_agency"];
 export const legalEntityOwnershipTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["LegalEntityOwnershipType"]> = ["public", "private"];
 export const legalEntityDocumentTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["LegalEntityDocumentType"]> = ["irs_cp_575"];
@@ -6120,7 +6143,7 @@ export const subscriptionIntervalTypeValues: ReadonlyArray<FlattenedDeepRequired
 export const subscriptionPlanTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["SubscriptionPlanType"]> = ["fixed", "variable"];
 export const transactionSourceTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["TransactionSourceType"]> = ["api", "dashboard", "iframe", "system", "subscription", "admin"];
 export const walletProviderTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["WalletProviderType"]> = ["googlepay", "applepay"];
-export const webhookEventTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["WebhookEventType"]> = ["charge.cancelled", "charge.created", "charge.errored", "charge.failed", "charge.processing", "charge.requires_capture", "charge.requires_confirmation", "charge.requires_review", "charge.settlement_failed", "charge.succeeded", "customer.created", "customer.updated", "legal_entity.created", "legal_entity.updated", "legal_entity_principal.created", "legal_entity_principal.updated", "legal_entity_application.approved", "legal_entity_application.denied", "legal_entity_application.needs_information", "legal_entity_application.pending", "legal_entity_application.submitted", "merchant.created", "merchant.updated", "payment_intent.cancelled", "payment_intent.created", "payment_intent.errored_authorization", "payment_intent.errored_capture", "payment_intent.errored_sale", "payment_intent.processing_authorization", "payment_intent.processing_capture", "payment_intent.processing_sale", "payment_intent.requires_capture", "payment_intent.requires_confirmation", "payment_intent.requires_payment_method", "payment_intent.requires_review", "payment_intent.succeeded", "payout.accepted", "payout.errored", "payout.failed", "payout.pending", "payout.processing", "payout.rejected", "payout.succeeded", "processor_transaction.completed", "reconciliation.created", "refund.cancelled", "refund.created", "refund.failed", "refund.pending", "refund.processing", "refund.requires_review", "refund.succeeded", "setup_intent.cancelled", "setup_intent.created", "setup_intent.errored", "setup_intent.failed", "setup_intent.requires_confirmation", "setup_intent.requires_payment_method", "setup_intent.requires_review", "setup_intent.succeeded", "setup_intent.verifying", "void.created", "void.failed", "void.pending", "void.processing", "void.requires_review", "void.succeeded"];
+export const webhookEventTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["WebhookEventType"]> = ["charge.cancelled", "charge.created", "charge.errored", "charge.failed", "charge.processing", "charge.requires_capture", "charge.requires_confirmation", "charge.requires_review", "charge.settlement_failed", "charge.succeeded", "customer.created", "customer.updated", "legal_entity.active", "legal_entity.created", "legal_entity.updated", "legal_entity_principal.created", "legal_entity_principal.updated", "legal_entity_application.approved", "legal_entity_application.denied", "legal_entity_application.needs_information", "legal_entity_application.pending", "legal_entity_application.submitted", "legal_entity_application.under_review", "merchant.created", "merchant.updated", "payment_intent.cancelled", "payment_intent.created", "payment_intent.errored_authorization", "payment_intent.errored_capture", "payment_intent.errored_sale", "payment_intent.processing_authorization", "payment_intent.processing_capture", "payment_intent.processing_sale", "payment_intent.requires_capture", "payment_intent.requires_confirmation", "payment_intent.requires_payment_method", "payment_intent.requires_review", "payment_intent.succeeded", "payout.accepted", "payout.errored", "payout.failed", "payout.pending", "payout.processing", "payout.rejected", "payout.succeeded", "processor_transaction.completed", "reconciliation.created", "refund.cancelled", "refund.created", "refund.failed", "refund.pending", "refund.processing", "refund.requires_review", "refund.succeeded", "setup_intent.cancelled", "setup_intent.created", "setup_intent.errored", "setup_intent.failed", "setup_intent.requires_confirmation", "setup_intent.requires_payment_method", "setup_intent.requires_review", "setup_intent.succeeded", "setup_intent.verifying", "void.created", "void.failed", "void.pending", "void.processing", "void.requires_review", "void.succeeded"];
 export const organizationKindValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["Organization"]["kind"]> = ["direct", "payfac"];
 export const originApplepayRegistrationStateTypeValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["OriginApplepayRegistrationStateType"]> = ["pending", "skipped", "registered", "failed"];
 export const paymentIntentStateValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["PaymentIntent"]["state"]> = ["requires_payment_method", "requires_confirmation", "requires_capture", "processing_authorization", "processing_capture", "processing_sale", "requires_review", "succeeded", "cancelled", "errored_authorization", "errored_capture", "errored_sale"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amos.com/node",
-  "version": "0.1.66",
+  "version": "0.1.68",
   "description": "Node.js client for the Amos Pay API.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",