payabli 2.2.31 → 3.0.0

data/lib/payabli/types/v_card_get_response_associated_vendor.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Information about the associated vendor.
+    class VCardGetResponseAssociatedVendor < Internal::Types::Model
+      field :vendor_number, -> { String }, optional: true, nullable: false, api_name: "VendorNumber"
+
+      field :name_1, -> { String }, optional: true, nullable: false, api_name: "Name1"
+
+      field :name_2, -> { String }, optional: true, nullable: false, api_name: "Name2"
+
+      field :ein, -> { String }, optional: true, nullable: false, api_name: "EIN"
+
+      field :phone, -> { String }, optional: true, nullable: false, api_name: "Phone"
+
+      field :email, -> { String }, optional: true, nullable: false, api_name: "Email"
+
+      field :remit_email, -> { String }, optional: true, nullable: false, api_name: "RemitEmail"
+
+      field :address_1, -> { String }, optional: true, nullable: false, api_name: "Address1"
+
+      field :address_2, -> { String }, optional: true, nullable: false, api_name: "Address2"
+
+      field :city, -> { String }, optional: true, nullable: false, api_name: "City"
+
+      field :state, -> { String }, optional: true, nullable: false, api_name: "State"
+
+      field :zip, -> { String }, optional: true, nullable: false, api_name: "Zip"
+
+      field :country, -> { String }, optional: true, nullable: false, api_name: "Country"
+
+      field :mcc, -> { String }, optional: true, nullable: false, api_name: "Mcc"
+
+      field :location_code, -> { String }, optional: true, nullable: false, api_name: "LocationCode"
+
+      field :contacts, -> { Internal::Types::Array[Payabli::Types::VCardGetResponseContact] }, optional: true, nullable: false, api_name: "Contacts"
+
+      field :billing_data, -> { Payabli::Types::VCardGetResponseAssociatedVendorBillingData }, optional: true, nullable: false, api_name: "BillingData"
+
+      field :payment_method, -> { String }, optional: true, nullable: false, api_name: "PaymentMethod"
+
+      field :vendor_status, -> { Integer }, optional: true, nullable: false, api_name: "VendorStatus"
+
+      field :vendor_id, -> { Integer }, optional: true, nullable: false, api_name: "VendorId"
+
+      field :enrollment_status, -> { String }, optional: true, nullable: false, api_name: "EnrollmentStatus"
+
+      field :summary, -> { Payabli::Types::VCardGetResponseAssociatedVendorSummary }, optional: true, nullable: false, api_name: "Summary"
+
+      field :paypoint_legalname, -> { String }, optional: true, nullable: false, api_name: "PaypointLegalname"
+
+      field :paypoint_dbaname, -> { String }, optional: true, nullable: false, api_name: "PaypointDbaname"
+
+      field :paypoint_entryname, -> { String }, optional: true, nullable: false, api_name: "PaypointEntryname"
+
+      field :parent_org_name, -> { String }, optional: true, nullable: false, api_name: "ParentOrgName"
+
+      field :parent_org_id, -> { Integer }, optional: true, nullable: false, api_name: "ParentOrgId"
+
+      field :created_date, -> { String }, optional: true, nullable: false, api_name: "CreatedDate"
+
+      field :last_updated, -> { String }, optional: true, nullable: false, api_name: "LastUpdated"
+
+      field :remit_address_1, -> { String }, optional: true, nullable: false, api_name: "remitAddress1"
+
+      field :remit_address_2, -> { String }, optional: true, nullable: false, api_name: "remitAddress2"
+
+      field :remit_city, -> { String }, optional: true, nullable: false, api_name: "remitCity"
+
+      field :remit_state, -> { String }, optional: true, nullable: false, api_name: "remitState"
+
+      field :remit_zip, -> { String }, optional: true, nullable: false, api_name: "remitZip"
+
+      field :remit_country, -> { String }, optional: true, nullable: false, api_name: "remitCountry"
+
+      field :payee_name_1, -> { String }, optional: true, nullable: false, api_name: "payeeName1"
+
+      field :payee_name_2, -> { String }, optional: true, nullable: false, api_name: "payeeName2"
+
+      field :custom_field_1, -> { String }, optional: true, nullable: false, api_name: "customField1"
+
+      field :custom_field_2, -> { String }, optional: true, nullable: false, api_name: "customField2"
+
+      field :customer_vendor_account, -> { String }, optional: true, nullable: false, api_name: "customerVendorAccount"
+
+      field :internal_reference_id, -> { Integer }, optional: true, nullable: false, api_name: "InternalReferenceId"
+
+      field :additional_data, -> { String }, optional: true, nullable: false, api_name: "additionalData"
+
+      field :external_paypoint_id, -> { String }, optional: true, nullable: false, api_name: "externalPaypointID"
+
+      field :stored_methods, -> { String }, optional: true, nullable: false, api_name: "StoredMethods"
+    end
+  end
+end

data/lib/payabli/types/v_card_get_response_associated_vendor_billing_data.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Billing data for the vendor.
+    class VCardGetResponseAssociatedVendorBillingData < Internal::Types::Model
+      field :id, -> { Integer }, optional: true, nullable: false
+
+      field :account_id, -> { String }, optional: true, nullable: false, api_name: "accountId"
+
+      field :nickname, -> { String }, optional: true, nullable: false
+
+      field :bank_name, -> { String }, optional: true, nullable: false, api_name: "bankName"
+
+      field :routing_account, -> { String }, optional: true, nullable: false, api_name: "routingAccount"
+
+      field :account_number, -> { String }, optional: true, nullable: false, api_name: "accountNumber"
+
+      field :type_account, -> { String }, optional: true, nullable: false, api_name: "typeAccount"
+
+      field :bank_account_holder_name, -> { String }, optional: true, nullable: false, api_name: "bankAccountHolderName"
+
+      field :bank_account_holder_type, -> { String }, optional: true, nullable: false, api_name: "bankAccountHolderType"
+
+      field :bank_account_function, -> { Integer }, optional: true, nullable: false, api_name: "bankAccountFunction"
+
+      field :verified, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :status, -> { Integer }, optional: true, nullable: false
+
+      field :services, -> { Internal::Types::Array[Object] }, optional: true, nullable: false
+
+      field :default, -> { Internal::Types::Boolean }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/v_card_get_response_associated_vendor_summary.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Summary of vendor's billing and transaction status.
+    class VCardGetResponseAssociatedVendorSummary < Internal::Types::Model
+      field :active_bills, -> { Integer }, optional: true, nullable: false, api_name: "ActiveBills"
+
+      field :pending_bills, -> { Integer }, optional: true, nullable: false, api_name: "PendingBills"
+
+      field :in_transit_bills, -> { Integer }, optional: true, nullable: false, api_name: "InTransitBills"
+
+      field :paid_bills, -> { Integer }, optional: true, nullable: false, api_name: "PaidBills"
+
+      field :overdue_bills, -> { Integer }, optional: true, nullable: false, api_name: "OverdueBills"
+
+      field :approved_bills, -> { Integer }, optional: true, nullable: false, api_name: "ApprovedBills"
+
+      field :disapproved_bills, -> { Integer }, optional: true, nullable: false, api_name: "DisapprovedBills"
+
+      field :total_bills, -> { Integer }, optional: true, nullable: false, api_name: "TotalBills"
+
+      field :active_bills_amount, -> { Integer }, optional: true, nullable: false, api_name: "ActiveBillsAmount"
+
+      field :pending_bills_amount, -> { Integer }, optional: true, nullable: false, api_name: "PendingBillsAmount"
+
+      field :in_transit_bills_amount, -> { Integer }, optional: true, nullable: false, api_name: "InTransitBillsAmount"
+
+      field :paid_bills_amount, -> { Integer }, optional: true, nullable: false, api_name: "PaidBillsAmount"
+
+      field :overdue_bills_amount, -> { Integer }, optional: true, nullable: false, api_name: "OverdueBillsAmount"
+
+      field :approved_bills_amount, -> { Integer }, optional: true, nullable: false, api_name: "ApprovedBillsAmount"
+
+      field :disapproved_bills_amount, -> { Integer }, optional: true, nullable: false, api_name: "DisapprovedBillsAmount"
+
+      field :total_bills_amount, -> { Integer }, optional: true, nullable: false, api_name: "TotalBillsAmount"
+    end
+  end
+end

data/lib/payabli/types/v_card_get_response_contact.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Contact information structure.
+    class VCardGetResponseContact < Internal::Types::Model
+      field :contact_name, -> { String }, optional: true, nullable: false, api_name: "ContactName"
+
+      field :contact_email, -> { String }, optional: true, nullable: false, api_name: "ContactEmail"
+
+      field :contact_title, -> { String }, optional: true, nullable: false, api_name: "ContactTitle"
+
+      field :contact_phone, -> { String }, optional: true, nullable: false, api_name: "ContactPhone"
+    end
+  end
+end

data/lib/payabli/types/v_card_transaction_query_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response body for queries about virtual card transactions.
+    class VCardTransactionQueryResponse < Internal::Types::Model
+      field :summary, -> { Payabli::Types::VCardSummary }, optional: false, nullable: false, api_name: "Summary"
+
+      field :records, -> { Internal::Types::Array[Payabli::Types::VCardTransactionRecord] }, optional: false, nullable: false, api_name: "Records"
+    end
+  end
+end

data/lib/payabli/types/v_card_transaction_record.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A virtual card transaction record returned by the query.
+    class VCardTransactionRecord < Internal::Types::Model
+      field :identifier, -> { String }, optional: false, nullable: true, api_name: "Identifier"
+
+      field :card_token, -> { String }, optional: false, nullable: true, api_name: "CardToken"
+
+      field :last_four, -> { String }, optional: false, nullable: true, api_name: "LastFour"
+
+      field :expiration_date, -> { String }, optional: false, nullable: true, api_name: "ExpirationDate"
+
+      field :mcc, -> { String }, optional: false, nullable: true, api_name: "Mcc"
+
+      field :payout_id, -> { Integer }, optional: false, nullable: true, api_name: "PayoutId"
+
+      field :customer_id, -> { Integer }, optional: false, nullable: true, api_name: "CustomerId"
+
+      field :vendor_id, -> { Integer }, optional: false, nullable: true, api_name: "VendorId"
+
+      field :misc_data_1, -> { String }, optional: false, nullable: true, api_name: "MiscData1"
+
+      field :misc_data_2, -> { String }, optional: false, nullable: true, api_name: "MiscData2"
+
+      field :current_uses, -> { Integer }, optional: false, nullable: true, api_name: "CurrentUses"
+
+      field :amount, -> { Integer }, optional: false, nullable: true, api_name: "Amount"
+
+      field :balance, -> { Integer }, optional: false, nullable: true, api_name: "Balance"
+
+      field :paypoint_id, -> { Integer }, optional: false, nullable: true, api_name: "PaypointId"
+
+      field :paypoint_legal, -> { String }, optional: false, nullable: true, api_name: "PaypointLegal"
+
+      field :paypoint_dba, -> { String }, optional: false, nullable: true, api_name: "PaypointDba"
+
+      field :external_paypoint_id, -> { String }, optional: false, nullable: true, api_name: "ExternalPaypointID"
+
+      field :org_name, -> { String }, optional: false, nullable: true, api_name: "OrgName"
+
+      field :type, -> { String }, optional: false, nullable: true, api_name: "Type"
+
+      field :status, -> { String }, optional: false, nullable: true, api_name: "Status"
+
+      field :created_on, -> { String }, optional: false, nullable: true, api_name: "CreatedOn"
+
+      field :transaction_amount, -> { String }, optional: false, nullable: true, api_name: "TransactionAmount"
+
+      field :posted_amount, -> { String }, optional: false, nullable: true, api_name: "PostedAmount"
+
+      field :posted_on, -> { String }, optional: false, nullable: true, api_name: "PostedOn"
+
+      field :merchant_name, -> { String }, optional: false, nullable: true, api_name: "MerchantName"
+
+      field :authorization_status, -> { String }, optional: false, nullable: true, api_name: "AuthorizationStatus"
+
+      field :reason_to_decline, -> { String }, optional: false, nullable: true, api_name: "ReasonToDecline"
+    end
+  end
+end

data/lib/payabli/types/validate_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response for card validation endpoint
+    class ValidateResponse < Internal::Types::Model
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :is_success, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSuccess"
+
+      field :response_data, -> { Payabli::Types::ValidateResponseData }, optional: false, nullable: false, api_name: "responseData"
+    end
+  end
+end

data/lib/payabli/types/validate_response_data.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response data for card validation
+    class ValidateResponseData < Internal::Types::Model
+      field :auth_code, -> { String }, optional: false, nullable: false, api_name: "authCode"
+
+      field :reference_id, -> { String }, optional: false, nullable: false, api_name: "referenceId"
+
+      field :result_code, -> { Integer }, optional: false, nullable: false, api_name: "resultCode"
+
+      field :result_text, -> { String }, optional: false, nullable: false, api_name: "resultText"
+
+      field :avs_response_text, -> { String }, optional: false, nullable: false, api_name: "avsResponseText"
+
+      field :cvv_response_text, -> { String }, optional: false, nullable: false, api_name: "cvvResponseText"
+
+      field :customer_id, -> { Integer }, optional: false, nullable: false, api_name: "customerId"
+
+      field :method_reference_id, -> { String }, optional: true, nullable: false, api_name: "methodReferenceId"
+    end
+  end
+end

data/lib/payabli/types/vendor_data_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Object describing the vendor owner of payment method. Required when saving an ACH payment method on behalf of a
+    # vendor (for Pay Out transactions).
+    class VendorDataRequest < Internal::Types::Model
+      field :vendor_id, -> { Integer }, optional: true, nullable: false, api_name: "vendorId"
+
+      field :vendor_number, -> { String }, optional: true, nullable: false, api_name: "vendorNumber"
+    end
+  end
+end

data/lib/payabli/types/vendor_enrich_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response from the vendor enrichment endpoint.
+    class VendorEnrichResponse < Internal::Types::Model
+      field :response_code, -> { Integer }, optional: true, nullable: false, api_name: "responseCode"
+
+      field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+
+      field :room_id, -> { Integer }, optional: true, nullable: false, api_name: "roomId"
+
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :response_data, -> { Payabli::Types::VendorEnrichResponseData }, optional: true, nullable: false, api_name: "responseData"
+    end
+  end
+end

data/lib/payabli/types/vendor_enrich_response_data.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Enrichment result details.
+    class VendorEnrichResponseData < Internal::Types::Model
+      field :enrichment_id, -> { String }, optional: true, nullable: false, api_name: "enrichmentId"
+
+      field :status, -> { String }, optional: true, nullable: false
+
+      field :stages_triggered, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "stagesTriggered"
+
+      field :vendor_payout_ready, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "vendorPayoutReady"
+
+      field :enrichment_data, -> { Payabli::Types::VendorEnrichmentData }, optional: true, nullable: false, api_name: "enrichmentData"
+    end
+  end
+end

data/lib/payabli/types/vendor_enrichment_data.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Container for enrichment stage results.
+    class VendorEnrichmentData < Internal::Types::Model
+      field :invoice_scan, -> { Payabli::Types::VendorEnrichmentInvoiceScan }, optional: true, nullable: false, api_name: "invoiceScan"
+
+      field :web_search, -> { Payabli::Types::VendorEnrichmentWebSearch }, optional: true, nullable: false, api_name: "webSearch"
+    end
+  end
+end

data/lib/payabli/types/vendor_enrichment_invoice_scan.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Vendor contact information and payment acceptance info extracted from an invoice.
+    class VendorEnrichmentInvoiceScan < Internal::Types::Model
+      field :vendor_name, -> { String }, optional: true, nullable: false, api_name: "vendorName"
+
+      field :street, -> { String }, optional: true, nullable: false
+
+      field :city, -> { String }, optional: true, nullable: false
+
+      field :state, -> { String }, optional: true, nullable: false
+
+      field :zip_code, -> { String }, optional: true, nullable: false, api_name: "zipCode"
+
+      field :country, -> { String }, optional: true, nullable: false
+
+      field :phone, -> { String }, optional: true, nullable: false
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :payment_link, -> { String }, optional: true, nullable: false, api_name: "paymentLink"
+
+      field :card_accepted, -> { String }, optional: true, nullable: false, api_name: "cardAccepted"
+
+      field :ach_accepted, -> { String }, optional: true, nullable: false, api_name: "achAccepted"
+
+      field :check_accepted, -> { String }, optional: true, nullable: false, api_name: "checkAccepted"
+
+      field :invoice_number, -> { String }, optional: true, nullable: false, api_name: "invoiceNumber"
+
+      field :amount_due, -> { Integer }, optional: true, nullable: false, api_name: "amountDue"
+
+      field :due_date, -> { String }, optional: true, nullable: false, api_name: "dueDate"
+    end
+  end
+end

data/lib/payabli/types/vendor_enrichment_web_search.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Vendor contact information and payment acceptance info found through web search.
+    class VendorEnrichmentWebSearch < Internal::Types::Model
+      field :phone, -> { String }, optional: true, nullable: false
+
+      field :phone_type, -> { String }, optional: true, nullable: false, api_name: "phoneType"
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :email_type, -> { String }, optional: true, nullable: false, api_name: "emailType"
+
+      field :street, -> { String }, optional: true, nullable: false
+
+      field :city, -> { String }, optional: true, nullable: false
+
+      field :state, -> { String }, optional: true, nullable: false
+
+      field :zip_code, -> { String }, optional: true, nullable: false, api_name: "zipCode"
+
+      field :country, -> { String }, optional: true, nullable: false
+
+      field :address_type, -> { String }, optional: true, nullable: false, api_name: "addressType"
+
+      field :payment_link, -> { String }, optional: true, nullable: false, api_name: "paymentLink"
+
+      field :payment_link_type, -> { String }, optional: true, nullable: false, api_name: "paymentLinkType"
+
+      field :card_accepted, -> { String }, optional: true, nullable: false, api_name: "cardAccepted"
+
+      field :ach_accepted, -> { String }, optional: true, nullable: false, api_name: "achAccepted"
+
+      field :check_accepted, -> { String }, optional: true, nullable: false, api_name: "checkAccepted"
+    end
+  end
+end

data/lib/payabli/types/vendor_response_stored_method.rb

@@ -32,6 +32,8 @@ module Payabli
 
       field :method_type, -> { String }, optional: false, nullable: true, api_name: "MethodType"
 
+      field :wallet_type, -> { String }, optional: false, nullable: true, api_name: "WalletType"
+
       field :last_updated, -> { String }, optional: false, nullable: true, api_name: "LastUpdated"
 
       field :card_updated_on, -> { String }, optional: false, nullable: true, api_name: "CardUpdatedOn"

data/lib/payabli/types/verify_account_details_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response wrapper for the bank account verification details endpoint.
+    class VerifyAccountDetailsResponse < Internal::Types::Model
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :response_data, -> { Payabli::Types::BankAccountVerificationDetailsResponse }, optional: true, nullable: false, api_name: "responseData"
+    end
+  end
+end

data/lib/payabli/types/void_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response for MoneyIn/void endpoint
+    class VoidResponse < Internal::Types::Model
+      field :response_code, -> { Integer }, optional: false, nullable: false, api_name: "responseCode"
+
+      field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+
+      field :room_id, -> { Integer }, optional: false, nullable: false, api_name: "roomId"
+
+      field :is_success, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :response_data, -> { Payabli::Types::VoidResponseData }, optional: false, nullable: false, api_name: "responseData"
+    end
+  end
+end

data/lib/payabli/types/void_response_data.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response data for void transactions
+    class VoidResponseData < Internal::Types::Model
+      field :auth_code, -> { String }, optional: false, nullable: false, api_name: "authCode"
+
+      field :reference_id, -> { String }, optional: false, nullable: false, api_name: "referenceId"
+
+      field :result_code, -> { Integer }, optional: false, nullable: false, api_name: "resultCode"
+
+      field :result_text, -> { String }, optional: false, nullable: false, api_name: "resultText"
+
+      field :avs_response_text, -> { String }, optional: true, nullable: false, api_name: "avsResponseText"
+
+      field :cvv_response_text, -> { String }, optional: true, nullable: false, api_name: "cvvResponseText"
+
+      field :customer_id, -> { Integer }, optional: true, nullable: false, api_name: "customerId"
+
+      field :method_reference_id, -> { String }, optional: true, nullable: false, api_name: "methodReferenceId"
+    end
+  end
+end

data/lib/payabli/types/web_header_parameter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class WebHeaderParameter < Internal::Types::Model
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :value, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/whenprovided.rb

@@ -7,7 +7,6 @@ module Payabli
 
       THIRTY_DAYS_OR_LESS = "30 Days or Less"
       THIRTY_ONE_TO_60_DAYS = "31 to 60 Days"
-      SIXTY_DAYS = "60+ Days"
     end
   end
 end