@blindpay/node 3.11.0 → 4.0.1

package/dist/resources/customers/index.d.ts

@@ -1,29 +1,30 @@
-import { P as PaginationParams, C as Country, B as BlindpayApiResponse, A as AccountClass, K as KycStatus, e as AccountPurpose, S as SourceOfFundsDocType, d as BusinessIndustry, E as EstimatedAnnualRevenue, f as SourceOfWealth, g as RecipientRelationship, h as SoleProprietorDocType, i as PurposeOfTransactions, j as PaginationMetadata, k as BusinessType } from '../../index.d-CGeWvXXq.js';
-import { I as InternalApiClient } from '../../api-client-5N_7-zad.js';
-import { S as StrictOmit } from '../../strict-omit-ByJhzKNC.js';
+import { P as PaginationParams, C as Country, B as BlindpayApiResponse, A as AccountClass, K as KycStatus, u as AccountPurpose, v as SourceOfFundsDocType, d as BusinessIndustry, E as EstimatedAnnualRevenue, w as SourceOfWealth, x as RecipientRelationship, y as SoleProprietorDocType, z as PurposeOfTransactions, l as PaginationMetadata, D as BusinessType } from '../../index.d-DK8eD9f3.js';
+import { I as InternalApiClient } from '../../api-client-BWImXDBx.js';
 
-type CustomerProofOfAddressDocType = "UTILITY_BILL" | "BANK_STATEMENT" | "RENTAL_AGREEMENT" | "TAX_DOCUMENT" | "GOVERNMENT_CORRESPONDENCE";
-type CustomerIdentificationDocument = "PASSPORT" | "ID_CARD" | "DRIVERS";
-type CustomerAmlStatus = "clear" | "hit" | "error";
-type CustomerAmlHits = {
+type StrictOmit<T, K extends keyof T> = Omit<T, K>;
+
+type ProofOfAddressDocType = "UTILITY_BILL" | "BANK_STATEMENT" | "RENTAL_AGREEMENT" | "TAX_DOCUMENT" | "GOVERNMENT_CORRESPONDENCE";
+type IdentificationDocument = "PASSPORT" | "ID_CARD" | "DRIVERS";
+type AmlStatus = "clear" | "hit" | "error";
+type AmlHits = {
     has_sanction_match: boolean;
     has_pep_match: boolean;
     has_watchlist_match: boolean;
     has_crimelist_match: boolean;
     has_adversemedia_match: boolean;
 };
-type CustomerFraudWarning = {
+type FraudWarning = {
     id: string | null;
     name: string | null;
     operation: string | null;
     score: number | null;
 };
-type CustomerOwnerTaxType = "SSN" | "ITIN";
-type CustomerKycType = "light" | "standard" | "enhanced";
-type CustomerOwnerRole = "beneficial_controlling" | "beneficial_owner" | "controlling_person";
-type CustomerOwner = {
+type OwnerTaxType = "SSN" | "ITIN";
+type KycType = "light" | "standard" | "enhanced";
+type OwnerRole = "beneficial_controlling" | "beneficial_owner" | "controlling_person";
+type Owner = {
     id: string;
-    role: CustomerOwnerRole;
+    role: OwnerRole;
     first_name: string;
     last_name: string;
     date_of_birth: string;
@@ -35,22 +36,22 @@ type CustomerOwner = {
     country: Country;
     postal_code: string;
     id_doc_country: Country;
-    id_doc_type: CustomerIdentificationDocument;
+    id_doc_type: IdentificationDocument;
     id_doc_front_file: string;
     id_doc_back_file: string | null;
-    proof_of_address_doc_type: CustomerProofOfAddressDocType;
+    proof_of_address_doc_type: ProofOfAddressDocType;
     proof_of_address_doc_file: string | null;
     ownership_percentage: number | null;
     title: string | null;
-    tax_type?: CustomerOwnerTaxType | null;
+    tax_type?: OwnerTaxType | null;
     instance_id?: string;
     customer_id?: string;
 };
-type CustomerIndividualWithStandardKYC = {
+type IndividualWithStandardKYC = {
     id: string;
     is_tos_accepted: boolean;
     type: Extract<AccountClass, "individual">;
-    kyc_type: Extract<CustomerKycType, "standard">;
+    kyc_type: Extract<KycType, "standard">;
     kyc_status: KycStatus;
     kyc_warnings: Array<{
         code: string | null;
@@ -69,13 +70,13 @@ type CustomerIndividualWithStandardKYC = {
     ip_address: string | null;
     image_url: string | null;
     phone_number: string;
-    proof_of_address_doc_type: CustomerProofOfAddressDocType;
+    proof_of_address_doc_type: ProofOfAddressDocType;
     proof_of_address_doc_file: string;
     first_name: string;
     last_name: string;
     date_of_birth: string;
     id_doc_country: Country;
-    id_doc_type: CustomerIdentificationDocument;
+    id_doc_type: IdentificationDocument;
     id_doc_front_file: string;
     id_doc_back_file: string;
     aiprise_validation_key: string;
@@ -88,9 +89,9 @@ type CustomerIndividualWithStandardKYC = {
         daily: number;
         monthly: number;
     };
-    fraud_warnings?: CustomerFraudWarning[] | null;
-    aml_status?: CustomerAmlStatus | null;
-    aml_hits?: CustomerAmlHits | null;
+    fraud_warnings?: FraudWarning[] | null;
+    aml_status?: AmlStatus | null;
+    aml_hits?: AmlHits | null;
     account_purpose?: AccountPurpose | null;
     account_purpose_other?: string | null;
     occupation?: string | null;
@@ -107,11 +108,11 @@ type CustomerIndividualWithStandardKYC = {
     sole_proprietor_doc_type?: SoleProprietorDocType | null;
     publicly_traded?: boolean | null;
 };
-type CustomerIndividualWithEnhancedKYC = {
+type IndividualWithEnhancedKYC = {
     id: string;
     is_tos_accepted: boolean;
     type: Extract<AccountClass, "individual">;
-    kyc_type: Extract<CustomerKycType, "enhanced">;
+    kyc_type: Extract<KycType, "enhanced">;
     kyc_status: KycStatus;
     kyc_warnings: Array<{
         code: string | null;
@@ -130,13 +131,13 @@ type CustomerIndividualWithEnhancedKYC = {
     ip_address: string | null;
     image_url: string | null;
     phone_number: string | null;
-    proof_of_address_doc_type: CustomerProofOfAddressDocType;
+    proof_of_address_doc_type: ProofOfAddressDocType;
     proof_of_address_doc_file: string;
     first_name: string;
     last_name: string;
     date_of_birth: string;
     id_doc_country: Country;
-    id_doc_type: CustomerIdentificationDocument;
+    id_doc_type: IdentificationDocument;
     id_doc_front_file: string;
     id_doc_back_file: string | null;
     aiprise_validation_key: string;
@@ -154,9 +155,9 @@ type CustomerIndividualWithEnhancedKYC = {
         daily: number;
         monthly: number;
     };
-    fraud_warnings?: CustomerFraudWarning[] | null;
-    aml_status?: CustomerAmlStatus | null;
-    aml_hits?: CustomerAmlHits | null;
+    fraud_warnings?: FraudWarning[] | null;
+    aml_status?: AmlStatus | null;
+    aml_hits?: AmlHits | null;
     account_purpose?: AccountPurpose | null;
     account_purpose_other?: string | null;
     occupation?: string | null;
@@ -171,12 +172,12 @@ type CustomerIndividualWithEnhancedKYC = {
     sole_proprietor_doc_type?: SoleProprietorDocType | null;
     publicly_traded?: boolean | null;
 };
-type CustomerBusinessWithStandardKYB = {
+type BusinessWithStandardKYB = {
     id: string;
     is_tos_accepted: boolean;
     is_fbo: boolean;
     type: Extract<AccountClass, "business">;
-    kyc_type: Extract<CustomerKycType, "standard">;
+    kyc_type: Extract<KycType, "standard">;
     kyc_status: KycStatus;
     kyc_warnings: Array<{
         code: string | null;
@@ -195,13 +196,13 @@ type CustomerBusinessWithStandardKYB = {
     ip_address: string | null;
     image_url: string | null;
     phone_number: string | null;
-    proof_of_address_doc_type: CustomerProofOfAddressDocType;
+    proof_of_address_doc_type: ProofOfAddressDocType;
     proof_of_address_doc_file: string;
     legal_name: string;
     alternate_name: string | null;
     formation_date: string;
     website: string | null;
-    owners: CustomerOwner[];
+    owners: Owner[];
     incorporation_doc_file: string;
     proof_of_ownership_doc_file: string;
     external_id: string | null;
@@ -215,9 +216,9 @@ type CustomerBusinessWithStandardKYB = {
         daily: number;
         monthly: number;
     };
-    fraud_warnings?: CustomerFraudWarning[] | null;
-    aml_status?: CustomerAmlStatus | null;
-    aml_hits?: CustomerAmlHits | null;
+    fraud_warnings?: FraudWarning[] | null;
+    aml_status?: AmlStatus | null;
+    aml_hits?: AmlHits | null;
     account_purpose?: AccountPurpose | null;
     account_purpose_other?: string | null;
     occupation?: string | null;
@@ -231,7 +232,7 @@ type CustomerBusinessWithStandardKYB = {
     recipient_relationship?: RecipientRelationship | null;
     sole_proprietor_doc_type?: SoleProprietorDocType | null;
 };
-type CreateCustomerIndividualWithStandardKYCInput = {
+type CreateIndividualWithStandardKYCInput = {
     country: Country;
     email: string;
     account_purpose?: AccountPurpose | null;
@@ -244,14 +245,14 @@ type CreateCustomerIndividualWithStandardKYCInput = {
     id_doc_back_file?: string | null;
     id_doc_country?: Country | null;
     id_doc_front_file?: string | null;
-    id_doc_type?: CustomerIdentificationDocument | null;
+    id_doc_type?: IdentificationDocument | null;
     image_url?: string | null;
     ip_address?: string | null;
     last_name?: string | null;
     phone_number?: string | null;
     postal_code?: string | null;
     proof_of_address_doc_file?: string | null;
-    proof_of_address_doc_type?: CustomerProofOfAddressDocType | null;
+    proof_of_address_doc_type?: ProofOfAddressDocType | null;
     selfie_file?: string | null;
     source_of_funds_doc_file?: string | null;
     source_of_funds_doc_type?: SourceOfFundsDocType | null;
@@ -264,10 +265,10 @@ type CreateCustomerIndividualWithStandardKYCInput = {
     recipient_relationship?: RecipientRelationship | null;
     sole_proprietor_doc_type?: SoleProprietorDocType | null;
 };
-type CreateCustomerIndividualWithStandardKYCResponse = {
+type CreateIndividualWithStandardKYCResponse = {
     id: string;
 };
-type CreateCustomerIndividualWithEnhancedKYCInput = {
+type CreateIndividualWithEnhancedKYCInput = {
     country: Country;
     email: string;
     account_purpose?: AccountPurpose | null;
@@ -280,14 +281,14 @@ type CreateCustomerIndividualWithEnhancedKYCInput = {
     id_doc_back_file?: string | null;
     id_doc_country?: Country | null;
     id_doc_front_file?: string | null;
-    id_doc_type?: CustomerIdentificationDocument | null;
+    id_doc_type?: IdentificationDocument | null;
     image_url?: string | null;
     ip_address?: string | null;
     last_name?: string | null;
     phone_number?: string | null;
     postal_code?: string | null;
     proof_of_address_doc_file?: string | null;
-    proof_of_address_doc_type?: CustomerProofOfAddressDocType | null;
+    proof_of_address_doc_type?: ProofOfAddressDocType | null;
     purpose_of_transactions?: PurposeOfTransactions | null;
     purpose_of_transactions_explanation?: string | null;
     selfie_file?: string | null;
@@ -302,10 +303,10 @@ type CreateCustomerIndividualWithEnhancedKYCInput = {
     recipient_relationship?: RecipientRelationship | null;
     sole_proprietor_doc_type?: SoleProprietorDocType | null;
 };
-type CreateCustomerIndividualWithEnhancedKYCResponse = {
+type CreateIndividualWithEnhancedKYCResponse = {
     id: string;
 };
-type CreateCustomerBusinessWithStandardKYBInput = {
+type CreateBusinessWithStandardKYBInput = {
     country: Country;
     email: string;
     account_purpose?: AccountPurpose | null;
@@ -323,11 +324,11 @@ type CreateCustomerBusinessWithStandardKYBInput = {
     incorporation_doc_file?: string | null;
     ip_address?: string | null;
     legal_name?: string | null;
-    owners?: Array<StrictOmit<CustomerOwner, "id">> | null;
+    owners?: Array<StrictOmit<Owner, "id">> | null;
     phone_number?: string | null;
     postal_code?: string | null;
     proof_of_address_doc_file?: string | null;
-    proof_of_address_doc_type?: CustomerProofOfAddressDocType | null;
+    proof_of_address_doc_type?: ProofOfAddressDocType | null;
     proof_of_ownership_doc_file?: string | null;
     publicly_traded?: boolean | null;
     source_of_funds_doc_file?: string | null;
@@ -342,7 +343,7 @@ type CreateCustomerBusinessWithStandardKYBInput = {
     recipient_relationship?: RecipientRelationship | null;
     sole_proprietor_doc_type?: SoleProprietorDocType | null;
 };
-type CreateCustomerBusinessWithStandardKYBResponse = {
+type CreateBusinessWithStandardKYBResponse = {
     id: string;
 };
 type ListCustomersInput = PaginationParams & {
@@ -354,11 +355,11 @@ type ListCustomersInput = PaginationParams & {
     country?: Country;
 };
 type ListCustomersResponse = {
-    data: Array<CustomerIndividualWithStandardKYC | CustomerIndividualWithEnhancedKYC | CustomerBusinessWithStandardKYB>;
+    data: Array<IndividualWithStandardKYC | IndividualWithEnhancedKYC | BusinessWithStandardKYB>;
     pagination: PaginationMetadata;
 };
 type GetCustomerInput = string;
-type GetCustomerResponse = CustomerIndividualWithStandardKYC | CustomerIndividualWithEnhancedKYC | CustomerBusinessWithStandardKYB;
+type GetCustomerResponse = IndividualWithStandardKYC | IndividualWithEnhancedKYC | BusinessWithStandardKYB;
 type UpdateCustomerInput = {
     customer_id: string;
     account_purpose?: AccountPurpose | null;
@@ -379,17 +380,17 @@ type UpdateCustomerInput = {
     id_doc_back_file?: string;
     id_doc_country?: Country;
     id_doc_front_file?: string;
-    id_doc_type?: CustomerIdentificationDocument;
+    id_doc_type?: IdentificationDocument;
     image_url?: string;
     incorporation_doc_file?: string;
     ip_address?: string;
     last_name?: string;
     legal_name?: string;
-    owners?: Array<StrictOmit<CustomerOwner, "id">>;
+    owners?: Array<StrictOmit<Owner, "id">>;
     phone_number?: string;
     postal_code?: string;
     proof_of_address_doc_file?: string;
-    proof_of_address_doc_type?: CustomerProofOfAddressDocType;
+    proof_of_address_doc_type?: ProofOfAddressDocType;
     proof_of_ownership_doc_file?: string;
     publicly_traded?: boolean | null;
     purpose_of_transactions?: PurposeOfTransactions;
@@ -421,46 +422,46 @@ type GetCustomerLimitsResponse = {
         };
     };
 };
-type GetCustomerLimitIncreaseRequestsInput = string;
-type CustomerLimitIncreaseRequestStatus = "in_review" | "approved" | "rejected";
-type CustomerLimitIncreaseRequestSupportingDocumentType = "individual_bank_statement" | "individual_tax_return" | "individual_proof_of_income" | "business_bank_statement" | "business_financial_statements" | "business_tax_return";
-type GetCustomerLimitIncreaseRequestsResponse = Array<{
+type GetLimitIncreaseRequestsInput = string;
+type LimitIncreaseRequestStatus = "in_review" | "approved" | "rejected";
+type LimitIncreaseRequestSupportingDocumentType = "individual_bank_statement" | "individual_tax_return" | "individual_proof_of_income" | "business_bank_statement" | "business_financial_statements" | "business_tax_return";
+type GetLimitIncreaseRequestsResponse = Array<{
     id: string;
     customer_id: string;
-    status: CustomerLimitIncreaseRequestStatus;
+    status: LimitIncreaseRequestStatus;
     daily: number;
     monthly: number;
     per_transaction: number;
     supporting_document_file: string;
-    supporting_document_type: CustomerLimitIncreaseRequestSupportingDocumentType;
+    supporting_document_type: LimitIncreaseRequestSupportingDocumentType;
     created_at: string;
     updated_at: string;
     approved_per_transaction?: number | null;
     approved_daily?: number | null;
     approved_monthly?: number | null;
 }>;
-type RequestCustomerLimitIncreaseInput = {
+type RequestLimitIncreaseInput = {
     customer_id: string;
     daily: number;
     monthly: number;
     per_transaction: number;
     supporting_document_file: string;
-    supporting_document_type: CustomerLimitIncreaseRequestSupportingDocumentType;
+    supporting_document_type: LimitIncreaseRequestSupportingDocumentType;
 };
-type RequestCustomerLimitIncreaseResponse = {
+type RequestLimitIncreaseResponse = {
     id: string;
 };
 declare function createCustomersResource(instanceId: string, client: InternalApiClient): {
     list(params?: ListCustomersInput): Promise<BlindpayApiResponse<ListCustomersResponse>>;
-    createIndividualWithStandardKYC(data: CreateCustomerIndividualWithStandardKYCInput): Promise<BlindpayApiResponse<CreateCustomerIndividualWithStandardKYCResponse>>;
-    createIndividualWithEnhancedKYC(data: CreateCustomerIndividualWithEnhancedKYCInput): Promise<BlindpayApiResponse<CreateCustomerIndividualWithEnhancedKYCResponse>>;
-    createBusinessWithStandardKYB(data: CreateCustomerBusinessWithStandardKYBInput): Promise<BlindpayApiResponse<CreateCustomerBusinessWithStandardKYBResponse>>;
+    createIndividualWithStandardKYC(data: CreateIndividualWithStandardKYCInput): Promise<BlindpayApiResponse<CreateIndividualWithStandardKYCResponse>>;
+    createIndividualWithEnhancedKYC(data: CreateIndividualWithEnhancedKYCInput): Promise<BlindpayApiResponse<CreateIndividualWithEnhancedKYCResponse>>;
+    createBusinessWithStandardKYB(data: CreateBusinessWithStandardKYBInput): Promise<BlindpayApiResponse<CreateBusinessWithStandardKYBResponse>>;
     get(customer_id: GetCustomerInput): Promise<BlindpayApiResponse<GetCustomerResponse>>;
     update({ customer_id, ...data }: UpdateCustomerInput): Promise<BlindpayApiResponse<void>>;
     delete(customer_id: DeleteCustomerInput): Promise<BlindpayApiResponse<void>>;
     getLimits(customer_id: GetCustomerLimitsInput): Promise<BlindpayApiResponse<GetCustomerLimitsResponse>>;
-    getLimitIncreaseRequests(customer_id: GetCustomerLimitIncreaseRequestsInput): Promise<BlindpayApiResponse<GetCustomerLimitIncreaseRequestsResponse>>;
-    requestLimitIncrease({ customer_id, ...data }: RequestCustomerLimitIncreaseInput): Promise<BlindpayApiResponse<RequestCustomerLimitIncreaseResponse>>;
+    getLimitIncreaseRequests(customer_id: GetLimitIncreaseRequestsInput): Promise<BlindpayApiResponse<GetLimitIncreaseRequestsResponse>>;
+    requestLimitIncrease({ customer_id, ...data }: RequestLimitIncreaseInput): Promise<BlindpayApiResponse<RequestLimitIncreaseResponse>>;
 };
 
-export { type CreateCustomerBusinessWithStandardKYBInput, type CreateCustomerBusinessWithStandardKYBResponse, type CreateCustomerIndividualWithEnhancedKYCInput, type CreateCustomerIndividualWithEnhancedKYCResponse, type CreateCustomerIndividualWithStandardKYCInput, type CreateCustomerIndividualWithStandardKYCResponse, type CustomerAmlHits, type CustomerAmlStatus, type CustomerBusinessWithStandardKYB, type CustomerFraudWarning, type CustomerIdentificationDocument, type CustomerIndividualWithEnhancedKYC, type CustomerIndividualWithStandardKYC, type CustomerKycType, type CustomerLimitIncreaseRequestStatus, type CustomerLimitIncreaseRequestSupportingDocumentType, type CustomerOwner, type CustomerOwnerRole, type CustomerOwnerTaxType, type CustomerProofOfAddressDocType, type DeleteCustomerInput, type GetCustomerInput, type GetCustomerLimitIncreaseRequestsInput, type GetCustomerLimitIncreaseRequestsResponse, type GetCustomerLimitsInput, type GetCustomerLimitsResponse, type GetCustomerResponse, type ListCustomersInput, type ListCustomersResponse, type RequestCustomerLimitIncreaseInput, type RequestCustomerLimitIncreaseResponse, type UpdateCustomerInput, createCustomersResource };
+export { type AmlHits, type AmlStatus, type BusinessWithStandardKYB, type CreateBusinessWithStandardKYBInput, type CreateBusinessWithStandardKYBResponse, type CreateIndividualWithEnhancedKYCInput, type CreateIndividualWithEnhancedKYCResponse, type CreateIndividualWithStandardKYCInput, type CreateIndividualWithStandardKYCResponse, type DeleteCustomerInput, type FraudWarning, type GetCustomerInput, type GetCustomerLimitsInput, type GetCustomerLimitsResponse, type GetCustomerResponse, type GetLimitIncreaseRequestsInput, type GetLimitIncreaseRequestsResponse, type IdentificationDocument, type IndividualWithEnhancedKYC, type IndividualWithStandardKYC, type KycType, type LimitIncreaseRequestStatus, type LimitIncreaseRequestSupportingDocumentType, type ListCustomersInput, type ListCustomersResponse, type Owner, type OwnerRole, type OwnerTaxType, type ProofOfAddressDocType, type RequestLimitIncreaseInput, type RequestLimitIncreaseResponse, type UpdateCustomerInput, createCustomersResource };