payabli 2.2.31 → 3.0.0

data/lib/payabli/types/transfer_out_record.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A record representing an outbound transfer.
+    class TransferOutRecord < Internal::Types::Model
+      field :transfer_id, -> { Integer }, optional: false, nullable: true, api_name: "transferId"
+
+      field :paypoint_id, -> { Integer }, optional: false, nullable: true, api_name: "paypointId"
+
+      field :batch_number, -> { String }, optional: false, nullable: true, api_name: "batchNumber"
+
+      field :batch_currency, -> { String }, optional: false, nullable: true, api_name: "batchCurrency"
+
+      field :batch_records, -> { Integer }, optional: false, nullable: true, api_name: "batchRecords"
+
+      field :transfer_identifier, -> { String }, optional: false, nullable: true, api_name: "transferIdentifier"
+
+      field :batch_id, -> { Integer }, optional: false, nullable: true, api_name: "batchId"
+
+      field :batch_net_amount, -> { Integer }, optional: false, nullable: true, api_name: "batchNetAmount"
+
+      field :batch_status, -> { Integer }, optional: false, nullable: true, api_name: "batchStatus"
+
+      field :paypoint_entry_name, -> { String }, optional: false, nullable: true, api_name: "paypointEntryName"
+
+      field :paypoint_legal_name, -> { String }, optional: false, nullable: true, api_name: "paypointLegalName"
+
+      field :paypoint_dba_name, -> { String }, optional: false, nullable: true, api_name: "paypointDbaName"
+
+      field :paypoint_logo, -> { String }, optional: false, nullable: true, api_name: "paypointLogo"
+
+      field :parent_org_name, -> { String }, optional: false, nullable: true, api_name: "parentOrgName"
+
+      field :parent_org_id, -> { Integer }, optional: false, nullable: true, api_name: "parentOrgId"
+
+      field :parent_org_logo, -> { String }, optional: false, nullable: true, api_name: "parentOrgLogo"
+
+      field :parent_org_entry_name, -> { String }, optional: false, nullable: true, api_name: "parentOrgEntryName"
+
+      field :external_paypoint_id, -> { String }, optional: false, nullable: true, api_name: "externalPaypointID"
+
+      field :bank_account, -> { Payabli::Types::TransferOutBankAccount }, optional: false, nullable: true, api_name: "bankAccount"
+
+      field :transfer_date, -> { String }, optional: false, nullable: true, api_name: "transferDate"
+
+      field :processor, -> { String }, optional: false, nullable: true
+
+      field :transfer_status, -> { Integer }, optional: false, nullable: true, api_name: "transferStatus"
+
+      field :gross_amount, -> { Integer }, optional: false, nullable: true, api_name: "grossAmount"
+
+      field :charge_back_amount, -> { Integer }, optional: false, nullable: true, api_name: "chargeBackAmount"
+
+      field :returned_amount, -> { Integer }, optional: false, nullable: true, api_name: "returnedAmount"
+
+      field :hold_amount, -> { Integer }, optional: false, nullable: true, api_name: "holdAmount"
+
+      field :released_amount, -> { Integer }, optional: false, nullable: true, api_name: "releasedAmount"
+
+      field :billing_fees_amount, -> { Integer }, optional: false, nullable: true, api_name: "billingFeesAmount"
+
+      field :third_party_paid_amount, -> { Integer }, optional: false, nullable: true, api_name: "thirdPartyPaidAmount"
+
+      field :adjustments_amount, -> { Integer }, optional: false, nullable: true, api_name: "adjustmentsAmount"
+
+      field :net_transfer_amount, -> { Integer }, optional: false, nullable: true, api_name: "netTransferAmount"
+
+      field :split_amount, -> { Integer }, optional: false, nullable: true, api_name: "splitAmount"
+
+      field :events_data, -> { Internal::Types::Array[Payabli::Types::TransferOutEventData] }, optional: false, nullable: true, api_name: "eventsData"
+
+      field :messages, -> { Internal::Types::Array[Payabli::Types::TransferOutMessage] }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/transfer_out_summary.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Summary information for outbound transfer queries.
+    class TransferOutSummary < Internal::Types::Model
+      field :total_pages, -> { Integer }, optional: false, nullable: true, api_name: "totalPages"
+
+      field :total_records, -> { Integer }, optional: false, nullable: true, api_name: "totalRecords"
+
+      field :page_size, -> { Integer }, optional: false, nullable: true, api_name: "pageSize"
+    end
+  end
+end

data/lib/payabli/types/type_result.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module TypeResult
+      # TypeResult is an alias for String
+
+      # @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/update_notification_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class UpdateNotificationRequest < Internal::Types::Model
+      extend Payabli::Internal::Types::Union
+
+      member -> { Payabli::Types::NotificationStandardRequest }
+
+      member -> { Payabli::Types::NotificationReportRequest }
+    end
+  end
+end

data/lib/payabli/types/update_payment_method_domain_request_wallet.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class UpdatePaymentMethodDomainRequestWallet < Internal::Types::Model
+      field :is_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isEnabled"
+    end
+  end
+end

data/lib/payabli/types/update_payout_subscription_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Success response
+    class UpdatePayoutSubscriptionResponse < 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, -> { String }, optional: true, nullable: false, api_name: "responseData"
+
+      field :customer_id, -> { Integer }, optional: true, nullable: false, api_name: "customerId"
+    end
+  end
+end

data/lib/payabli/types/update_subscription_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Success response
+    class UpdateSubscriptionResponse < Internal::Types::Model
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_data, -> { String }, optional: true, nullable: false, api_name: "responseData"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :customer_id, -> { Integer }, optional: true, nullable: false, api_name: "customerId"
+    end
+  end
+end

data/lib/payabli/types/v_2_bad_request_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Bad request error response (HTTP 400) returned when request validation fails. Follows RFC 7807 Problem Details
+    # format with additional Payabli-specific fields.
+    class V2BadRequestError < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :title, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Integer }, optional: false, nullable: false
+
+      field :detail, -> { String }, optional: false, nullable: false
+
+      field :instance, -> { String }, optional: false, nullable: false
+
+      field :code, -> { String }, optional: false, nullable: false
+
+      field :errors, -> { Internal::Types::Hash[String, Internal::Types::Array[Payabli::Types::V2BadRequestErrorDetail]] }, optional: false, nullable: false
+
+      field :token, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/v_2_bad_request_error_detail.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Individual field error detail for bad request responses.
+    class V2BadRequestErrorDetail < Internal::Types::Model
+      field :message, -> { String }, optional: false, nullable: false
+
+      field :suggestion, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/v_2_declined_transaction_response_wrapper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response wrapper for declined v2 Money In transaction endpoints (HTTP 402). Returned when a transaction is
+    # declined by the card network or issuer. All decline responses use this format with unified response codes starting
+    # with 'D'. The `data` field contains transaction details.
+    class V2DeclinedTransactionResponseWrapper < Internal::Types::Model
+      field :code, -> { String }, optional: false, nullable: false
+
+      field :reason, -> { String }, optional: false, nullable: false
+
+      field :explanation, -> { String }, optional: false, nullable: false
+
+      field :action, -> { String }, optional: false, nullable: false
+
+      field :data, -> { Payabli::Types::V2TransactionDetails }, optional: false, nullable: false
+
+      field :token, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/v_2_internal_server_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Internal server error response (HTTP 500) returned when an unexpected error occurs. Follows RFC 7807 Problem
+    # Details format.
+    class V2InternalServerError < Internal::Types::Model
+      field :title, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Integer }, optional: false, nullable: false
+
+      field :detail, -> { String }, optional: false, nullable: false
+
+      field :instance, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/v_2_response_action.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module V2ResponseAction
+      # V2ResponseAction is an alias for String
+
+      # @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/v_2_response_code.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module V2ResponseCode
+      # V2ResponseCode is an alias for String
+
+      # @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/v_2_response_explanation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module V2ResponseExplanation
+      # V2ResponseExplanation is an alias for String
+
+      # @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/v_2_response_reason.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module V2ResponseReason
+      # V2ResponseReason is an alias for String
+
+      # @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/v_2_transaction_detail_response_data.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response data from payment processor
+    class V2TransactionDetailResponseData < Internal::Types::Model
+      field :result_code, -> { String }, optional: false, nullable: false, api_name: "resultCode"
+
+      field :result_code_text, -> { String }, optional: false, nullable: false, api_name: "resultCodeText"
+
+      field :response, -> { String }, optional: false, nullable: true
+
+      field :responsetext, -> { String }, optional: false, nullable: false
+
+      field :authcode, -> { String }, optional: false, nullable: true
+
+      field :transactionid, -> { String }, optional: false, nullable: false
+
+      field :avsresponse, -> { String }, optional: false, nullable: true
+
+      field :avsresponse_text, -> { String }, optional: false, nullable: true
+
+      field :cvvresponse, -> { String }, optional: false, nullable: true
+
+      field :cvvresponse_text, -> { String }, optional: false, nullable: true
+
+      field :orderid, -> { String }, optional: false, nullable: true
+
+      field :type, -> { String }, optional: false, nullable: true
+
+      field :response_code, -> { String }, optional: false, nullable: false
+
+      field :response_code_text, -> { String }, optional: false, nullable: false
+
+      field :customer_vault_id, -> { String }, optional: false, nullable: true
+
+      field :emv_auth_response_data, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/v_2_transaction_details.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Complete transaction details returned by v2 Money In endpoints. This matches the structure of the transaction
+    # details previously returned by the v1 details endpoint.
+    class V2TransactionDetails < Internal::Types::Model
+      field :parent_org_name, -> { String }, optional: false, nullable: false, api_name: "parentOrgName"
+
+      field :paypoint_dbaname, -> { String }, optional: false, nullable: false, api_name: "paypointDbaname"
+
+      field :paypoint_legalname, -> { String }, optional: false, nullable: false, api_name: "paypointLegalname"
+
+      field :paypoint_entryname, -> { String }, optional: false, nullable: false, api_name: "paypointEntryname"
+
+      field :payment_trans_id, -> { String }, optional: false, nullable: false, api_name: "paymentTransId"
+
+      field :connector_name, -> { String }, optional: false, nullable: false, api_name: "connectorName"
+
+      field :external_processor_information, -> { String }, optional: false, nullable: false, api_name: "externalProcessorInformation"
+
+      field :gateway_trans_id, -> { String }, optional: false, nullable: false, api_name: "gatewayTransId"
+
+      field :order_id, -> { String }, optional: false, nullable: true, api_name: "orderId"
+
+      field :method_, -> { String }, optional: false, nullable: false, api_name: "method"
+
+      field :batch_number, -> { String }, optional: false, nullable: false, api_name: "batchNumber"
+
+      field :batch_amount, -> { Integer }, optional: false, nullable: false, api_name: "batchAmount"
+
+      field :payor_id, -> { Integer }, optional: false, nullable: false, api_name: "payorId"
+
+      field :payment_data, -> { Payabli::Types::TransactionDetailPaymentData }, optional: false, nullable: false, api_name: "paymentData"
+
+      field :trans_status, -> { Integer }, optional: false, nullable: false, api_name: "transStatus"
+
+      field :paypoint_id, -> { Integer }, optional: false, nullable: false, api_name: "paypointId"
+
+      field :total_amount, -> { Integer }, optional: false, nullable: false, api_name: "totalAmount"
+
+      field :net_amount, -> { Integer }, optional: false, nullable: false, api_name: "netAmount"
+
+      field :fee_amount, -> { Integer }, optional: false, nullable: false, api_name: "feeAmount"
+
+      field :settlement_status, -> { Integer }, optional: false, nullable: false, api_name: "settlementStatus"
+
+      field :operation, -> { String }, optional: false, nullable: false
+
+      field :response_data, -> { Payabli::Types::V2TransactionDetailResponseData }, optional: false, nullable: false, api_name: "responseData"
+
+      field :source, -> { String }, optional: false, nullable: false
+
+      field :schedule_reference, -> { Integer }, optional: false, nullable: false, api_name: "scheduleReference"
+
+      field :org_id, -> { Integer }, optional: false, nullable: false, api_name: "orgId"
+
+      field :refund_id, -> { Integer }, optional: false, nullable: false, api_name: "refundId"
+
+      field :returned_id, -> { Integer }, optional: false, nullable: false, api_name: "returnedId"
+
+      field :chargeback_id, -> { Integer }, optional: false, nullable: false, api_name: "chargebackId"
+
+      field :retrieval_id, -> { Integer }, optional: false, nullable: false, api_name: "retrievalId"
+
+      field :trans_additional_data, -> { Object }, optional: false, nullable: true, api_name: "transAdditionalData"
+
+      field :invoice_data, -> { Payabli::Types::TransactionDetailInvoiceData }, optional: false, nullable: false, api_name: "invoiceData"
+
+      field :entrypage_id, -> { Integer }, optional: false, nullable: false, api_name: "entrypageId"
+
+      field :external_paypoint_id, -> { String }, optional: false, nullable: true, api_name: "externalPaypointID"
+
+      field :is_validated_ach, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isValidatedACH"
+
+      field :transaction_time, -> { String }, optional: false, nullable: false, api_name: "transactionTime"
+
+      field :customer, -> { Payabli::Types::TransactionDetailCustomer }, optional: false, nullable: false
+
+      field :split_funding_instructions, -> { Internal::Types::Array[Payabli::Types::SplitFundingContent] }, optional: false, nullable: true, api_name: "splitFundingInstructions"
+
+      field :cfee_transactions, -> { Internal::Types::Array[Payabli::Types::QueryCFeeTransaction] }, optional: false, nullable: false, api_name: "cfeeTransactions"
+
+      field :transaction_events, -> { Internal::Types::Array[Payabli::Types::TransactionDetailEvent] }, optional: false, nullable: false, api_name: "transactionEvents"
+
+      field :pending_fee_amount, -> { Integer }, optional: true, nullable: false, api_name: "pendingFeeAmount"
+
+      field :risk_flagged, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "riskFlagged"
+
+      field :risk_flagged_on, -> { String }, optional: true, nullable: false, api_name: "riskFlaggedOn"
+
+      field :risk_status, -> { String }, optional: false, nullable: false, api_name: "riskStatus"
+
+      field :risk_reason, -> { String }, optional: false, nullable: false, api_name: "riskReason"
+
+      field :risk_action, -> { String }, optional: false, nullable: false, api_name: "riskAction"
+
+      field :risk_action_code, -> { Integer }, optional: true, nullable: false, api_name: "riskActionCode"
+
+      field :device_id, -> { String }, optional: false, nullable: false, api_name: "deviceId"
+
+      field :ach_sec_code, -> { String }, optional: false, nullable: false, api_name: "achSecCode"
+
+      field :ach_holder_type, -> { Payabli::Types::AchHolderType }, optional: false, nullable: true, api_name: "achHolderType"
+
+      field :ip_address, -> { String }, optional: false, nullable: false, api_name: "ipAddress"
+
+      field :is_same_day_ach, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSameDayACH"
+
+      field :wallet_type, -> { String }, optional: false, nullable: true, api_name: "walletType"
+    end
+  end
+end

data/lib/payabli/types/v_2_transaction_response_wrapper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard response wrapper for v2 Money In transaction endpoints. All v2 transaction endpoints return responses in
+    # this format with consistent `code`, `reason`, `explanation`, and `action` fields. The `data` field contains
+    # transaction details.
+    class V2TransactionResponseWrapper < Internal::Types::Model
+      field :code, -> { String }, optional: false, nullable: false
+
+      field :reason, -> { String }, optional: false, nullable: false
+
+      field :explanation, -> { String }, optional: false, nullable: false
+
+      field :action, -> { String }, optional: false, nullable: false
+
+      field :data, -> { Payabli::Types::V2TransactionDetails }, optional: false, nullable: false
+
+      field :token, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/v_card_get_response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class VCardGetResponse < Internal::Types::Model
+      field :vcard_sent, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "vcardSent"
+
+      field :card_token, -> { String }, optional: true, nullable: false, api_name: "cardToken"
+
+      field :card_number, -> { String }, optional: true, nullable: false, api_name: "cardNumber"
+
+      field :cvc, -> { String }, optional: true, nullable: false
+
+      field :expiration_date, -> { String }, optional: true, nullable: false, api_name: "expirationDate"
+
+      field :status, -> { String }, optional: true, nullable: false
+
+      field :amount, -> { Integer }, optional: true, nullable: false
+
+      field :current_balance, -> { Integer }, optional: true, nullable: false, api_name: "currentBalance"
+
+      field :expense_limit, -> { Integer }, optional: true, nullable: false, api_name: "expenseLimit"
+
+      field :expense_limit_period, -> { String }, optional: true, nullable: false, api_name: "expenseLimitPeriod"
+
+      field :max_number_of_uses, -> { Integer }, optional: true, nullable: false, api_name: "maxNumberOfUses"
+
+      field :current_number_of_uses, -> { Integer }, optional: true, nullable: false, api_name: "currentNumberOfUses"
+
+      field :exact_amount, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "exactAmount"
+
+      field :mcc, -> { String }, optional: true, nullable: false
+
+      field :tcc, -> { String }, optional: true, nullable: false
+
+      field :misc_1, -> { String }, optional: true, nullable: false, api_name: "misc1"
+
+      field :misc_2, -> { String }, optional: true, nullable: false, api_name: "misc2"
+
+      field :date_created, -> { String }, optional: true, nullable: false, api_name: "dateCreated"
+
+      field :date_modified, -> { String }, optional: true, nullable: false, api_name: "dateModified"
+
+      field :associated_vendor, -> { Payabli::Types::VCardGetResponseAssociatedVendor }, optional: true, nullable: false, api_name: "associatedVendor"
+
+      field :associated_customer, -> { String }, optional: true, nullable: false, api_name: "associatedCustomer"
+
+      field :parent_org_name, -> { String }, optional: true, nullable: false, api_name: "ParentOrgName"
+
+      field :paypoint_dbaname, -> { String }, optional: true, nullable: false, api_name: "PaypointDbaname"
+
+      field :paypoint_legalname, -> { String }, optional: true, nullable: false, api_name: "PaypointLegalname"
+
+      field :paypoint_entryname, -> { String }, optional: true, nullable: false, api_name: "PaypointEntryname"
+
+      field :external_paypoint_id, -> { String }, optional: true, nullable: false, api_name: "externalPaypointID"
+
+      field :paypoint_id, -> { Integer }, optional: true, nullable: false, api_name: "paypointId"
+    end
+  end
+end