payabli 2.2.32 → 3.0.1

data/lib/payabli/types/stat_basic_extended_query_record.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class StatBasicExtendedQueryRecord < Internal::Types::Model
+      field :stat_x, -> { String }, optional: false, nullable: false, api_name: "statX"
+
+      field :out_customers, -> { Integer }, optional: false, nullable: false, api_name: "outCustomers"
+
+      field :out_new_customers, -> { Integer }, optional: false, nullable: false, api_name: "outNewCustomers"
+
+      field :out_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outTransactions"
+
+      field :out_subscriptions_paid, -> { Integer }, optional: false, nullable: false, api_name: "outSubscriptionsPaid"
+
+      field :out_card_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outCardTransactions"
+
+      field :out_v_card_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outVCardTransactions"
+
+      field :out_ach_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outACHTransactions"
+
+      field :out_check_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outCheckTransactions"
+
+      field :out_pending_method_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outPendingMethodTransactions"
+
+      field :out_transactions_volume, -> { Integer }, optional: false, nullable: false, api_name: "outTransactionsVolume"
+
+      field :out_subscriptions_paid_volume, -> { Integer }, optional: false, nullable: false, api_name: "outSubscriptionsPaidVolume"
+
+      field :out_card_volume, -> { Integer }, optional: false, nullable: false, api_name: "outCardVolume"
+
+      field :out_v_card_volume, -> { Integer }, optional: false, nullable: false, api_name: "outVCardVolume"
+
+      field :out_ach_volume, -> { Integer }, optional: false, nullable: false, api_name: "outACHVolume"
+
+      field :out_check_volume, -> { Integer }, optional: false, nullable: false, api_name: "outCheckVolume"
+
+      field :out_pending_method_volume, -> { Integer }, optional: false, nullable: false, api_name: "outPendingMethodVolume"
+
+      field :in_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inTransactions"
+
+      field :in_subscriptions_paid, -> { Integer }, optional: false, nullable: false, api_name: "inSubscriptionsPaid"
+
+      field :in_customers, -> { Integer }, optional: false, nullable: false, api_name: "inCustomers"
+
+      field :in_new_customers, -> { Integer }, optional: false, nullable: false, api_name: "inNewCustomers"
+
+      field :in_card_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inCardTransactions"
+
+      field :in_ach_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inACHTransactions"
+
+      field :in_check_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inCheckTransactions"
+
+      field :in_cash_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inCashTransactions"
+
+      field :in_wallet_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inWalletTransactions"
+
+      field :in_card_charge_backs, -> { Integer }, optional: false, nullable: false, api_name: "inCardChargeBacks"
+
+      field :in_ach_returns, -> { Integer }, optional: false, nullable: false, api_name: "inACHReturns"
+
+      field :in_transactions_volume, -> { Integer }, optional: false, nullable: false, api_name: "inTransactionsVolume"
+
+      field :in_subscriptions_paid_volume, -> { Integer }, optional: false, nullable: false, api_name: "inSubscriptionsPaidVolume"
+
+      field :in_card_volume, -> { Integer }, optional: false, nullable: false, api_name: "inCardVolume"
+
+      field :in_ach_volume, -> { Integer }, optional: false, nullable: false, api_name: "inACHVolume"
+
+      field :in_check_volume, -> { Integer }, optional: false, nullable: false, api_name: "inCheckVolume"
+
+      field :in_cash_volume, -> { Integer }, optional: false, nullable: false, api_name: "inCashVolume"
+
+      field :in_wallet_volume, -> { Integer }, optional: false, nullable: false, api_name: "inWalletVolume"
+
+      field :in_card_charge_back_volume, -> { Integer }, optional: false, nullable: false, api_name: "inCardChargeBackVolume"
+
+      field :in_ach_returns_volume, -> { Integer }, optional: false, nullable: false, api_name: "inACHReturnsVolume"
+    end
+  end
+end

data/lib/payabli/types/stat_basic_query_record.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class StatBasicQueryRecord < Internal::Types::Model
+      field :stat_x, -> { String }, optional: false, nullable: false, api_name: "statX"
+
+      field :in_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inTransactions"
+
+      field :in_transactions_volume, -> { Integer }, optional: false, nullable: false, api_name: "inTransactionsVolume"
+
+      field :in_wallet_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inWalletTransactions"
+
+      field :in_wallet_volume, -> { Integer }, optional: false, nullable: false, api_name: "inWalletVolume"
+    end
+  end
+end

data/lib/payabli/types/statistics_vendor_query_record.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class StatisticsVendorQueryRecord < Internal::Types::Model
+      field :stat_x, -> { String }, optional: false, nullable: false, api_name: "statX"
+
+      field :active, -> { Integer }, optional: false, nullable: false
+
+      field :active_volume, -> { Integer }, optional: false, nullable: false, api_name: "activeVolume"
+
+      field :sent_to_approval, -> { Integer }, optional: false, nullable: false, api_name: "sentToApproval"
+
+      field :sent_to_approval_volume, -> { Integer }, optional: false, nullable: false, api_name: "sentToApprovalVolume"
+
+      field :to_approval, -> { Integer }, optional: false, nullable: false, api_name: "toApproval"
+
+      field :to_approval_volume, -> { Integer }, optional: false, nullable: false, api_name: "toApprovalVolume"
+
+      field :approved, -> { Integer }, optional: false, nullable: false
+
+      field :approved_volume, -> { Integer }, optional: false, nullable: false, api_name: "approvedVolume"
+
+      field :disapproved, -> { Integer }, optional: false, nullable: false
+
+      field :disapproved_volume, -> { Integer }, optional: false, nullable: false, api_name: "disapprovedVolume"
+
+      field :cancelled, -> { Integer }, optional: false, nullable: false
+
+      field :cancelled_volume, -> { Integer }, optional: false, nullable: false, api_name: "cancelledVolume"
+
+      field :in_transit, -> { Integer }, optional: false, nullable: false, api_name: "inTransit"
+
+      field :in_transit_volume, -> { Integer }, optional: false, nullable: false, api_name: "inTransitVolume"
+
+      field :paid, -> { Integer }, optional: false, nullable: false
+
+      field :paid_volume, -> { Integer }, optional: false, nullable: false, api_name: "paidVolume"
+    end
+  end
+end

data/lib/payabli/types/string_string_key_value_pair.rb

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

data/lib/payabli/types/subscription_query_records.rb

@@ -57,6 +57,8 @@ module Payabli
 
       field :sub_status, -> { Integer }, optional: true, nullable: false, api_name: "SubStatus"
 
+      field :subscription_type, -> { Payabli::Types::SubscriptionType }, optional: true, nullable: false, api_name: "SubscriptionType"
+
       field :total_amount, -> { Integer }, optional: true, nullable: false, api_name: "TotalAmount"
 
       field :total_cycles, -> { Integer }, optional: true, nullable: false, api_name: "TotalCycles"

data/lib/payabli/types/subscription_stats_query_record.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class SubscriptionStatsQueryRecord < Internal::Types::Model
+      field :interval, -> { String }, optional: false, nullable: false
+
+      field :count, -> { Integer }, optional: false, nullable: false
+
+      field :volume, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/subscription_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module SubscriptionType
+      extend Payabli::Internal::Types::Enum
+
+      REGULAR = "Regular"
+      BALANCE_DRIVEN = "BalanceDriven"
+    end
+  end
+end

data/lib/payabli/types/temporary.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module Temporary
+      # Temporary is an alias for Boolean
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/payabli/types/terms.rb

@@ -3,21 +3,29 @@
 module Payabli
   module Types
     module Terms
-      # Terms is an alias for String
+      extend Payabli::Internal::Types::Enum
 
-      # @option str [String]
-      #
-      # @return [untyped]
-      def self.load(str)
-        ::JSON.parse(str)
-      end
-
-      # @option value [untyped]
-      #
-      # @return [String]
-      def self.dump(value)
-        ::JSON.generate(value)
-      end
+      PIA = "PIA"
+      CIA = "CIA"
+      UR = "UR"
+      NET_10 = "NET10"
+      NET_20 = "NET20"
+      NET_30 = "NET30"
+      NET_45 = "NET45"
+      NET_60 = "NET60"
+      NET_90 = "NET90"
+      EOM = "EOM"
+      MFI = "MFI"
+      FIVE_MFI = "5MFI"
+      TEN_MFI = "10MFI"
+      FIFTEEN_MFI = "15MFI"
+      TWENTY_MFI = "20MFI"
+      TWO_10_NET_30 = "2/10NET30"
+      UF = "UF"
+      TEN_UF = "10UF"
+      TWENTY_UF = "20UF"
+      TWENTY_FIVE_UF = "25UF"
+      FIFTY_UF = "50UF"
     end
   end
 end

data/lib/payabli/types/{ach.rb → tokenize_ach.rb}

@@ -2,10 +2,12 @@
 
 module Payabli
   module Types
-    class Ach < Internal::Types::Model
+    class TokenizeAch < Internal::Types::Model
+      field :method_, -> { String }, optional: false, nullable: false, api_name: "method"
+
       field :ach_account, -> { String }, optional: false, nullable: false, api_name: "achAccount"
 
-      field :ach_account_type, -> { Payabli::Types::Achaccounttype }, optional: true, nullable: false, api_name: "achAccountType"
+      field :ach_account_type, -> { Payabli::Types::Achaccounttype }, optional: false, nullable: false, api_name: "achAccountType"
 
       field :ach_code, -> { String }, optional: true, nullable: false, api_name: "achCode"
 
@@ -16,8 +18,6 @@ module Payabli
       field :ach_routing, -> { String }, optional: false, nullable: false, api_name: "achRouting"
 
       field :device, -> { String }, optional: true, nullable: false
-
-      field :method_, -> { String }, optional: false, nullable: false, api_name: "method"
     end
   end
 end

data/lib/payabli/types/tokenize_card.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class TokenizeCard < Internal::Types::Model
+      field :method_, -> { String }, optional: false, nullable: false, api_name: "method"
+
+      field :cardcvv, -> { String }, optional: true, nullable: false
+
+      field :cardexp, -> { String }, optional: false, nullable: false
+
+      field :card_holder, -> { String }, optional: false, nullable: false, api_name: "cardHolder"
+
+      field :cardnumber, -> { String }, optional: false, nullable: false
+
+      field :cardzip, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/trans_request_body.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class TransRequestBody < Internal::Types::Model
+      field :account_id, -> { String }, optional: true, nullable: false, api_name: "accountId"
+
+      field :customer_data, -> { Payabli::Types::PayorDataRequest }, optional: true, nullable: false, api_name: "customerData"
+
+      field :entry_point, -> { String }, optional: true, nullable: false, api_name: "entryPoint"
+
+      field :invoice_data, -> { Payabli::Types::BillData }, optional: true, nullable: false, api_name: "invoiceData"
+
+      field :ipaddress, -> { String }, optional: true, nullable: false
+
+      field :order_description, -> { String }, optional: true, nullable: false, api_name: "orderDescription"
+
+      field :order_id, -> { String }, optional: true, nullable: false, api_name: "orderId"
+
+      field :payment_details, -> { Payabli::Types::PaymentDetail }, optional: false, nullable: false, api_name: "paymentDetails"
+
+      field :payment_method, -> { Payabli::Types::PaymentMethod }, optional: false, nullable: false, api_name: "paymentMethod"
+
+      field :source, -> { String }, optional: true, nullable: false
+
+      field :subdomain, -> { String }, optional: true, nullable: false
+
+      field :subscription_id, -> { Integer }, optional: true, nullable: false, api_name: "subscriptionId"
+    end
+  end
+end

data/lib/payabli/types/transaction_detail_customer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Customer information associated with the transaction
+    class TransactionDetailCustomer < Internal::Types::Model
+      field :identifiers, -> { Internal::Types::Array[String] }, optional: false, nullable: true
+
+      field :first_name, -> { String }, optional: false, nullable: false, api_name: "firstName"
+
+      field :last_name, -> { String }, optional: false, nullable: false, api_name: "lastName"
+
+      field :company_name, -> { String }, optional: false, nullable: true, api_name: "companyName"
+
+      field :billing_address_1, -> { String }, optional: false, nullable: true, api_name: "billingAddress1"
+
+      field :billing_address_2, -> { String }, optional: false, nullable: true, api_name: "billingAddress2"
+
+      field :billing_city, -> { String }, optional: false, nullable: true, api_name: "billingCity"
+
+      field :billing_state, -> { String }, optional: false, nullable: true, api_name: "billingState"
+
+      field :billing_zip, -> { String }, optional: false, nullable: true, api_name: "billingZip"
+
+      field :billing_country, -> { String }, optional: false, nullable: true, api_name: "billingCountry"
+
+      field :billing_phone, -> { String }, optional: false, nullable: true, api_name: "billingPhone"
+
+      field :billing_email, -> { String }, optional: false, nullable: true, api_name: "billingEmail"
+
+      field :customer_number, -> { String }, optional: false, nullable: true, api_name: "customerNumber"
+
+      field :shipping_address_1, -> { String }, optional: false, nullable: true, api_name: "shippingAddress1"
+
+      field :shipping_address_2, -> { String }, optional: false, nullable: true, api_name: "shippingAddress2"
+
+      field :shipping_city, -> { String }, optional: false, nullable: true, api_name: "shippingCity"
+
+      field :shipping_state, -> { String }, optional: false, nullable: true, api_name: "shippingState"
+
+      field :shipping_zip, -> { String }, optional: false, nullable: true, api_name: "shippingZip"
+
+      field :shipping_country, -> { String }, optional: false, nullable: true, api_name: "shippingCountry"
+
+      field :customer_id, -> { Integer }, optional: false, nullable: false, api_name: "customerId"
+
+      field :customer_status, -> { Integer }, optional: false, nullable: false, api_name: "customerStatus"
+
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: true, api_name: "additionalData"
+    end
+  end
+end

data/lib/payabli/types/transaction_detail_event.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Event associated with transaction processing
+    class TransactionDetailEvent < Internal::Types::Model
+      field :trans_event, -> { String }, optional: false, nullable: false, api_name: "transEvent"
+
+      field :event_data, -> { String }, optional: false, nullable: false, api_name: "eventData"
+
+      field :event_time, -> { String }, optional: false, nullable: false, api_name: "eventTime"
+    end
+  end
+end

data/lib/payabli/types/transaction_detail_invoice_data.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Invoice information if transaction is associated with an invoice
+    class TransactionDetailInvoiceData < Internal::Types::Model
+      field :invoice_number, -> { String }, optional: false, nullable: true, api_name: "invoiceNumber"
+
+      field :invoice_date, -> { String }, optional: false, nullable: true, api_name: "invoiceDate"
+
+      field :invoice_due_date, -> { String }, optional: false, nullable: true, api_name: "invoiceDueDate"
+
+      field :invoice_end_date, -> { String }, optional: false, nullable: true, api_name: "invoiceEndDate"
+
+      field :invoice_status, -> { Integer }, optional: false, nullable: true, api_name: "invoiceStatus"
+
+      field :invoice_type, -> { Integer }, optional: false, nullable: true, api_name: "invoiceType"
+
+      field :frequency, -> { Payabli::Types::Frequency }, optional: false, nullable: true
+
+      field :payment_terms, -> { String }, optional: false, nullable: true, api_name: "paymentTerms"
+
+      field :terms_conditions, -> { String }, optional: false, nullable: true, api_name: "termsConditions"
+
+      field :notes, -> { String }, optional: false, nullable: true
+
+      field :tax, -> { Integer }, optional: false, nullable: true
+
+      field :discount, -> { Integer }, optional: false, nullable: true
+
+      field :invoice_amount, -> { Integer }, optional: false, nullable: true, api_name: "invoiceAmount"
+
+      field :freight_amount, -> { Integer }, optional: false, nullable: true, api_name: "freightAmount"
+
+      field :duty_amount, -> { Integer }, optional: false, nullable: true, api_name: "dutyAmount"
+
+      field :purchase_order, -> { String }, optional: false, nullable: true, api_name: "purchaseOrder"
+
+      field :first_name, -> { String }, optional: false, nullable: true, api_name: "firstName"
+
+      field :last_name, -> { String }, optional: false, nullable: true, api_name: "lastName"
+
+      field :company, -> { String }, optional: false, nullable: true
+
+      field :shipping_address_1, -> { String }, optional: false, nullable: true, api_name: "shippingAddress1"
+
+      field :shipping_address_2, -> { String }, optional: false, nullable: true, api_name: "shippingAddress2"
+
+      field :shipping_city, -> { String }, optional: false, nullable: true, api_name: "shippingCity"
+
+      field :shipping_state, -> { String }, optional: false, nullable: true, api_name: "shippingState"
+
+      field :shipping_zip, -> { String }, optional: false, nullable: true, api_name: "shippingZip"
+
+      field :shipping_country, -> { String }, optional: false, nullable: true, api_name: "shippingCountry"
+
+      field :shipping_email, -> { String }, optional: false, nullable: true, api_name: "shippingEmail"
+
+      field :shipping_phone, -> { String }, optional: false, nullable: true, api_name: "shippingPhone"
+
+      field :shipping_from_zip, -> { String }, optional: false, nullable: true, api_name: "shippingFromZip"
+
+      field :summary_commodity_code, -> { String }, optional: false, nullable: true, api_name: "summaryCommodityCode"
+
+      field :items, -> { Internal::Types::Array[Payabli::Types::BillItem] }, optional: false, nullable: true
+
+      field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: false, nullable: true
+
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: true, api_name: "additionalData"
+    end
+  end
+end

data/lib/payabli/types/transaction_detail_payment_data.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Payment method and transaction details
+    class TransactionDetailPaymentData < Internal::Types::Model
+      field :masked_account, -> { String }, optional: false, nullable: false, api_name: "maskedAccount"
+
+      field :account_type, -> { String }, optional: false, nullable: false, api_name: "accountType"
+
+      field :account_exp, -> { String }, optional: false, nullable: true, api_name: "accountExp"
+
+      field :holder_name, -> { String }, optional: false, nullable: false, api_name: "holderName"
+
+      field :stored_id, -> { String }, optional: false, nullable: true, api_name: "storedId"
+
+      field :initiator, -> { String }, optional: false, nullable: true
+
+      field :stored_method_usage_type, -> { String }, optional: false, nullable: true, api_name: "storedMethodUsageType"
+
+      field :sequence, -> { String }, optional: false, nullable: true
+
+      field :order_description, -> { String }, optional: false, nullable: true, api_name: "orderDescription"
+
+      field :account_id, -> { String }, optional: false, nullable: true, api_name: "accountId"
+
+      field :signature_data, -> { String }, optional: false, nullable: true, api_name: "signatureData"
+
+      field :bin_data, -> { Payabli::Types::BinData }, optional: false, nullable: true, api_name: "binData"
+
+      field :payment_details, -> { Payabli::Types::TransactionDetailPaymentDetails }, optional: false, nullable: false, api_name: "paymentDetails"
+    end
+  end
+end

data/lib/payabli/types/transaction_detail_payment_details.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Detailed breakdown of payment amounts and identifiers
+    class TransactionDetailPaymentDetails < Internal::Types::Model
+      field :total_amount, -> { Integer }, optional: false, nullable: false, api_name: "totalAmount"
+
+      field :service_fee, -> { Integer }, optional: false, nullable: false, api_name: "serviceFee"
+
+      field :check_number, -> { String }, optional: false, nullable: true, api_name: "checkNumber"
+
+      field :check_image, -> { Object }, optional: false, nullable: true, api_name: "checkImage"
+
+      field :check_unique_id, -> { String }, optional: false, nullable: false, api_name: "checkUniqueId"
+
+      field :currency, -> { String }, optional: false, nullable: false
+
+      field :order_description, -> { String }, optional: false, nullable: true, api_name: "orderDescription"
+
+      field :order_id, -> { String }, optional: false, nullable: true, api_name: "orderId"
+
+      field :order_id_alternative, -> { String }, optional: false, nullable: true, api_name: "orderIdAlternative"
+
+      field :payment_description, -> { String }, optional: false, nullable: true, api_name: "paymentDescription"
+
+      field :group_number, -> { String }, optional: false, nullable: true, api_name: "groupNumber"
+
+      field :source, -> { String }, optional: false, nullable: true
+
+      field :payabli_trans_id, -> { String }, optional: false, nullable: true, api_name: "payabliTransId"
+
+      field :unbundled, -> { Object }, optional: false, nullable: true
+
+      field :categories, -> { Internal::Types::Array[Object] }, optional: false, nullable: false
+
+      field :split_funding, -> { Internal::Types::Array[Object] }, optional: false, nullable: false, api_name: "splitFunding"
+    end
+  end
+end