# The content of this file was automatically generated require "cgi" require "json" require "processout/networking/request" require "processout/networking/response" module ProcessOut class Transaction attr_reader :id attr_reader :project attr_reader :project_id attr_reader :invoice attr_reader :invoice_id attr_reader :customer attr_reader :customer_id attr_reader :subscription attr_reader :subscription_id attr_reader :token attr_reader :token_id attr_reader :card attr_reader :card_id attr_reader :gateway_configuration attr_reader :external_three_d_s_gateway_configuration attr_reader :gateway_configuration_id attr_reader :operations attr_reader :refunds attr_reader :name attr_reader :amount attr_reader :amount_local attr_reader :authorized_amount attr_reader :authorized_amount_local attr_reader :captured_amount attr_reader :captured_amount_local attr_reader :refunded_amount attr_reader :refunded_amount_local attr_reader :available_amount attr_reader :available_amount_local attr_reader :voided_amount attr_reader :voided_amount_local attr_reader :currency attr_reader :error_code attr_reader :error_message attr_reader :acquirer_name attr_reader :gateway_name attr_reader :three_d_s_status attr_reader :status attr_reader :authorized attr_reader :captured attr_reader :voided attr_reader :refunded attr_reader :chargedback attr_reader :received_fraud_notification attr_reader :received_retrieval_request attr_reader :processout_fee attr_reader :estimated_fee attr_reader :gateway_fee attr_reader :gateway_fee_local attr_reader :currency_fee attr_reader :metadata attr_reader :sandbox attr_reader :created_at attr_reader :chargedback_at attr_reader :refunded_at attr_reader :three_d_s attr_reader :cvc_check attr_reader :avs_check attr_reader :initial_scheme_transaction_id attr_reader :scheme_id attr_reader :payment_type attr_reader :native_apm attr_reader :external_details def id=(val) @id = val end def project=(val) if val.nil? @project = val return end if val.instance_of? Project @project = val else obj = Project.new(@client) obj.fill_with_data(val) @project = obj end end def project_id=(val) @project_id = val end def invoice=(val) if val.nil? @invoice = val return end if val.instance_of? Invoice @invoice = val else obj = Invoice.new(@client) obj.fill_with_data(val) @invoice = obj end end def invoice_id=(val) @invoice_id = val end def customer=(val) if val.nil? @customer = val return end if val.instance_of? Customer @customer = val else obj = Customer.new(@client) obj.fill_with_data(val) @customer = obj end end def customer_id=(val) @customer_id = val end def subscription=(val) if val.nil? @subscription = val return end if val.instance_of? Subscription @subscription = val else obj = Subscription.new(@client) obj.fill_with_data(val) @subscription = obj end end def subscription_id=(val) @subscription_id = val end def token=(val) if val.nil? @token = val return end if val.instance_of? Token @token = val else obj = Token.new(@client) obj.fill_with_data(val) @token = obj end end def token_id=(val) @token_id = val end def card=(val) if val.nil? @card = val return end if val.instance_of? Card @card = val else obj = Card.new(@client) obj.fill_with_data(val) @card = obj end end def card_id=(val) @card_id = val end def gateway_configuration=(val) if val.nil? @gateway_configuration = val return end if val.instance_of? GatewayConfiguration @gateway_configuration = val else obj = GatewayConfiguration.new(@client) obj.fill_with_data(val) @gateway_configuration = obj end end def external_three_d_s_gateway_configuration=(val) if val.nil? @external_three_d_s_gateway_configuration = val return end if val.instance_of? GatewayConfiguration @external_three_d_s_gateway_configuration = val else obj = GatewayConfiguration.new(@client) obj.fill_with_data(val) @external_three_d_s_gateway_configuration = obj end end def gateway_configuration_id=(val) @gateway_configuration_id = val end def operations=(val) if val.nil? @operations = [] return end if val.length > 0 and val[0].instance_of? TransactionOperation @operations = val else l = Array.new for v in val obj = TransactionOperation.new(@client) obj.fill_with_data(v) l.push(obj) end @operations = l end end def refunds=(val) if val.nil? @refunds = [] return end if val.length > 0 and val[0].instance_of? Refund @refunds = val else l = Array.new for v in val obj = Refund.new(@client) obj.fill_with_data(v) l.push(obj) end @refunds = l end end def name=(val) @name = val end def amount=(val) @amount = val end def amount_local=(val) @amount_local = val end def authorized_amount=(val) @authorized_amount = val end def authorized_amount_local=(val) @authorized_amount_local = val end def captured_amount=(val) @captured_amount = val end def captured_amount_local=(val) @captured_amount_local = val end def refunded_amount=(val) @refunded_amount = val end def refunded_amount_local=(val) @refunded_amount_local = val end def available_amount=(val) @available_amount = val end def available_amount_local=(val) @available_amount_local = val end def voided_amount=(val) @voided_amount = val end def voided_amount_local=(val) @voided_amount_local = val end def currency=(val) @currency = val end def error_code=(val) @error_code = val end def error_message=(val) @error_message = val end def acquirer_name=(val) @acquirer_name = val end def gateway_name=(val) @gateway_name = val end def three_d_s_status=(val) @three_d_s_status = val end def status=(val) @status = val end def authorized=(val) @authorized = val end def captured=(val) @captured = val end def voided=(val) @voided = val end def refunded=(val) @refunded = val end def chargedback=(val) @chargedback = val end def received_fraud_notification=(val) @received_fraud_notification = val end def received_retrieval_request=(val) @received_retrieval_request = val end def processout_fee=(val) @processout_fee = val end def estimated_fee=(val) @estimated_fee = val end def gateway_fee=(val) @gateway_fee = val end def gateway_fee_local=(val) @gateway_fee_local = val end def currency_fee=(val) @currency_fee = val end def metadata=(val) @metadata = val end def sandbox=(val) @sandbox = val end def created_at=(val) @created_at = val end def chargedback_at=(val) @chargedback_at = val end def refunded_at=(val) @refunded_at = val end def three_d_s=(val) if val.nil? @three_d_s = val return end if val.instance_of? ThreeDS @three_d_s = val else obj = ThreeDS.new(@client) obj.fill_with_data(val) @three_d_s = obj end end def cvc_check=(val) @cvc_check = val end def avs_check=(val) @avs_check = val end def initial_scheme_transaction_id=(val) @initial_scheme_transaction_id = val end def scheme_id=(val) @scheme_id = val end def payment_type=(val) @payment_type = val end def native_apm=(val) if val.nil? @native_apm = val return end if val.instance_of? NativeAPMResponse @native_apm = val else obj = NativeAPMResponse.new(@client) obj.fill_with_data(val) @native_apm = obj end end def external_details=(val) @external_details = val end # Initializes the Transaction object # Params: # +client+:: +ProcessOut+ client instance # +data+:: data that can be used to fill the object def initialize(client, data = {}) @client = client self.id = data.fetch(:id, nil) self.project = data.fetch(:project, nil) self.project_id = data.fetch(:project_id, nil) self.invoice = data.fetch(:invoice, nil) self.invoice_id = data.fetch(:invoice_id, nil) self.customer = data.fetch(:customer, nil) self.customer_id = data.fetch(:customer_id, nil) self.subscription = data.fetch(:subscription, nil) self.subscription_id = data.fetch(:subscription_id, nil) self.token = data.fetch(:token, nil) self.token_id = data.fetch(:token_id, nil) self.card = data.fetch(:card, nil) self.card_id = data.fetch(:card_id, nil) self.gateway_configuration = data.fetch(:gateway_configuration, nil) self.external_three_d_s_gateway_configuration = data.fetch(:external_three_d_s_gateway_configuration, nil) self.gateway_configuration_id = data.fetch(:gateway_configuration_id, nil) self.operations = data.fetch(:operations, nil) self.refunds = data.fetch(:refunds, nil) self.name = data.fetch(:name, nil) self.amount = data.fetch(:amount, nil) self.amount_local = data.fetch(:amount_local, nil) self.authorized_amount = data.fetch(:authorized_amount, nil) self.authorized_amount_local = data.fetch(:authorized_amount_local, nil) self.captured_amount = data.fetch(:captured_amount, nil) self.captured_amount_local = data.fetch(:captured_amount_local, nil) self.refunded_amount = data.fetch(:refunded_amount, nil) self.refunded_amount_local = data.fetch(:refunded_amount_local, nil) self.available_amount = data.fetch(:available_amount, nil) self.available_amount_local = data.fetch(:available_amount_local, nil) self.voided_amount = data.fetch(:voided_amount, nil) self.voided_amount_local = data.fetch(:voided_amount_local, nil) self.currency = data.fetch(:currency, nil) self.error_code = data.fetch(:error_code, nil) self.error_message = data.fetch(:error_message, nil) self.acquirer_name = data.fetch(:acquirer_name, nil) self.gateway_name = data.fetch(:gateway_name, nil) self.three_d_s_status = data.fetch(:three_d_s_status, nil) self.status = data.fetch(:status, nil) self.authorized = data.fetch(:authorized, nil) self.captured = data.fetch(:captured, nil) self.voided = data.fetch(:voided, nil) self.refunded = data.fetch(:refunded, nil) self.chargedback = data.fetch(:chargedback, nil) self.received_fraud_notification = data.fetch(:received_fraud_notification, nil) self.received_retrieval_request = data.fetch(:received_retrieval_request, nil) self.processout_fee = data.fetch(:processout_fee, nil) self.estimated_fee = data.fetch(:estimated_fee, nil) self.gateway_fee = data.fetch(:gateway_fee, nil) self.gateway_fee_local = data.fetch(:gateway_fee_local, nil) self.currency_fee = data.fetch(:currency_fee, nil) self.metadata = data.fetch(:metadata, nil) self.sandbox = data.fetch(:sandbox, nil) self.created_at = data.fetch(:created_at, nil) self.chargedback_at = data.fetch(:chargedback_at, nil) self.refunded_at = data.fetch(:refunded_at, nil) self.three_d_s = data.fetch(:three_d_s, nil) self.cvc_check = data.fetch(:cvc_check, nil) self.avs_check = data.fetch(:avs_check, nil) self.initial_scheme_transaction_id = data.fetch(:initial_scheme_transaction_id, nil) self.scheme_id = data.fetch(:scheme_id, nil) self.payment_type = data.fetch(:payment_type, nil) self.native_apm = data.fetch(:native_apm, nil) self.external_details = data.fetch(:external_details, nil) end # Create a new Transaction using the current client def new(data = {}) Transaction.new(@client, data) end # Overrides the JSON marshaller to only send the fields we want def to_json(options) { "id": self.id, "project": self.project, "project_id": self.project_id, "invoice": self.invoice, "invoice_id": self.invoice_id, "customer": self.customer, "customer_id": self.customer_id, "subscription": self.subscription, "subscription_id": self.subscription_id, "token": self.token, "token_id": self.token_id, "card": self.card, "card_id": self.card_id, "gateway_configuration": self.gateway_configuration, "external_three_d_s_gateway_configuration": self.external_three_d_s_gateway_configuration, "gateway_configuration_id": self.gateway_configuration_id, "operations": self.operations, "refunds": self.refunds, "name": self.name, "amount": self.amount, "amount_local": self.amount_local, "authorized_amount": self.authorized_amount, "authorized_amount_local": self.authorized_amount_local, "captured_amount": self.captured_amount, "captured_amount_local": self.captured_amount_local, "refunded_amount": self.refunded_amount, "refunded_amount_local": self.refunded_amount_local, "available_amount": self.available_amount, "available_amount_local": self.available_amount_local, "voided_amount": self.voided_amount, "voided_amount_local": self.voided_amount_local, "currency": self.currency, "error_code": self.error_code, "error_message": self.error_message, "acquirer_name": self.acquirer_name, "gateway_name": self.gateway_name, "three_d_s_status": self.three_d_s_status, "status": self.status, "authorized": self.authorized, "captured": self.captured, "voided": self.voided, "refunded": self.refunded, "chargedback": self.chargedback, "received_fraud_notification": self.received_fraud_notification, "received_retrieval_request": self.received_retrieval_request, "processout_fee": self.processout_fee, "estimated_fee": self.estimated_fee, "gateway_fee": self.gateway_fee, "gateway_fee_local": self.gateway_fee_local, "currency_fee": self.currency_fee, "metadata": self.metadata, "sandbox": self.sandbox, "created_at": self.created_at, "chargedback_at": self.chargedback_at, "refunded_at": self.refunded_at, "three_d_s": self.three_d_s, "cvc_check": self.cvc_check, "avs_check": self.avs_check, "initial_scheme_transaction_id": self.initial_scheme_transaction_id, "scheme_id": self.scheme_id, "payment_type": self.payment_type, "native_apm": self.native_apm, "external_details": self.external_details, }.to_json end # Fills the object with data coming from the API # Params: # +data+:: +Hash+ of data coming from the API def fill_with_data(data) if data.nil? return self end if data.include? "id" self.id = data["id"] end if data.include? "project" self.project = data["project"] end if data.include? "project_id" self.project_id = data["project_id"] end if data.include? "invoice" self.invoice = data["invoice"] end if data.include? "invoice_id" self.invoice_id = data["invoice_id"] end if data.include? "customer" self.customer = data["customer"] end if data.include? "customer_id" self.customer_id = data["customer_id"] end if data.include? "subscription" self.subscription = data["subscription"] end if data.include? "subscription_id" self.subscription_id = data["subscription_id"] end if data.include? "token" self.token = data["token"] end if data.include? "token_id" self.token_id = data["token_id"] end if data.include? "card" self.card = data["card"] end if data.include? "card_id" self.card_id = data["card_id"] end if data.include? "gateway_configuration" self.gateway_configuration = data["gateway_configuration"] end if data.include? "external_three_d_s_gateway_configuration" self.external_three_d_s_gateway_configuration = data["external_three_d_s_gateway_configuration"] end if data.include? "gateway_configuration_id" self.gateway_configuration_id = data["gateway_configuration_id"] end if data.include? "operations" self.operations = data["operations"] end if data.include? "refunds" self.refunds = data["refunds"] end if data.include? "name" self.name = data["name"] end if data.include? "amount" self.amount = data["amount"] end if data.include? "amount_local" self.amount_local = data["amount_local"] end if data.include? "authorized_amount" self.authorized_amount = data["authorized_amount"] end if data.include? "authorized_amount_local" self.authorized_amount_local = data["authorized_amount_local"] end if data.include? "captured_amount" self.captured_amount = data["captured_amount"] end if data.include? "captured_amount_local" self.captured_amount_local = data["captured_amount_local"] end if data.include? "refunded_amount" self.refunded_amount = data["refunded_amount"] end if data.include? "refunded_amount_local" self.refunded_amount_local = data["refunded_amount_local"] end if data.include? "available_amount" self.available_amount = data["available_amount"] end if data.include? "available_amount_local" self.available_amount_local = data["available_amount_local"] end if data.include? "voided_amount" self.voided_amount = data["voided_amount"] end if data.include? "voided_amount_local" self.voided_amount_local = data["voided_amount_local"] end if data.include? "currency" self.currency = data["currency"] end if data.include? "error_code" self.error_code = data["error_code"] end if data.include? "error_message" self.error_message = data["error_message"] end if data.include? "acquirer_name" self.acquirer_name = data["acquirer_name"] end if data.include? "gateway_name" self.gateway_name = data["gateway_name"] end if data.include? "three_d_s_status" self.three_d_s_status = data["three_d_s_status"] end if data.include? "status" self.status = data["status"] end if data.include? "authorized" self.authorized = data["authorized"] end if data.include? "captured" self.captured = data["captured"] end if data.include? "voided" self.voided = data["voided"] end if data.include? "refunded" self.refunded = data["refunded"] end if data.include? "chargedback" self.chargedback = data["chargedback"] end if data.include? "received_fraud_notification" self.received_fraud_notification = data["received_fraud_notification"] end if data.include? "received_retrieval_request" self.received_retrieval_request = data["received_retrieval_request"] end if data.include? "processout_fee" self.processout_fee = data["processout_fee"] end if data.include? "estimated_fee" self.estimated_fee = data["estimated_fee"] end if data.include? "gateway_fee" self.gateway_fee = data["gateway_fee"] end if data.include? "gateway_fee_local" self.gateway_fee_local = data["gateway_fee_local"] end if data.include? "currency_fee" self.currency_fee = data["currency_fee"] end if data.include? "metadata" self.metadata = data["metadata"] end if data.include? "sandbox" self.sandbox = data["sandbox"] end if data.include? "created_at" self.created_at = data["created_at"] end if data.include? "chargedback_at" self.chargedback_at = data["chargedback_at"] end if data.include? "refunded_at" self.refunded_at = data["refunded_at"] end if data.include? "three_d_s" self.three_d_s = data["three_d_s"] end if data.include? "cvc_check" self.cvc_check = data["cvc_check"] end if data.include? "avs_check" self.avs_check = data["avs_check"] end if data.include? "initial_scheme_transaction_id" self.initial_scheme_transaction_id = data["initial_scheme_transaction_id"] end if data.include? "scheme_id" self.scheme_id = data["scheme_id"] end if data.include? "payment_type" self.payment_type = data["payment_type"] end if data.include? "native_apm" self.native_apm = data["native_apm"] end if data.include? "external_details" self.external_details = data["external_details"] end self end # Prefills the object with the data passed as parameters # Params: # +data+:: +Hash+ of data def prefill(data) if data.nil? return self end self.id = data.fetch(:id, self.id) self.project = data.fetch(:project, self.project) self.project_id = data.fetch(:project_id, self.project_id) self.invoice = data.fetch(:invoice, self.invoice) self.invoice_id = data.fetch(:invoice_id, self.invoice_id) self.customer = data.fetch(:customer, self.customer) self.customer_id = data.fetch(:customer_id, self.customer_id) self.subscription = data.fetch(:subscription, self.subscription) self.subscription_id = data.fetch(:subscription_id, self.subscription_id) self.token = data.fetch(:token, self.token) self.token_id = data.fetch(:token_id, self.token_id) self.card = data.fetch(:card, self.card) self.card_id = data.fetch(:card_id, self.card_id) self.gateway_configuration = data.fetch(:gateway_configuration, self.gateway_configuration) self.external_three_d_s_gateway_configuration = data.fetch(:external_three_d_s_gateway_configuration, self.external_three_d_s_gateway_configuration) self.gateway_configuration_id = data.fetch(:gateway_configuration_id, self.gateway_configuration_id) self.operations = data.fetch(:operations, self.operations) self.refunds = data.fetch(:refunds, self.refunds) self.name = data.fetch(:name, self.name) self.amount = data.fetch(:amount, self.amount) self.amount_local = data.fetch(:amount_local, self.amount_local) self.authorized_amount = data.fetch(:authorized_amount, self.authorized_amount) self.authorized_amount_local = data.fetch(:authorized_amount_local, self.authorized_amount_local) self.captured_amount = data.fetch(:captured_amount, self.captured_amount) self.captured_amount_local = data.fetch(:captured_amount_local, self.captured_amount_local) self.refunded_amount = data.fetch(:refunded_amount, self.refunded_amount) self.refunded_amount_local = data.fetch(:refunded_amount_local, self.refunded_amount_local) self.available_amount = data.fetch(:available_amount, self.available_amount) self.available_amount_local = data.fetch(:available_amount_local, self.available_amount_local) self.voided_amount = data.fetch(:voided_amount, self.voided_amount) self.voided_amount_local = data.fetch(:voided_amount_local, self.voided_amount_local) self.currency = data.fetch(:currency, self.currency) self.error_code = data.fetch(:error_code, self.error_code) self.error_message = data.fetch(:error_message, self.error_message) self.acquirer_name = data.fetch(:acquirer_name, self.acquirer_name) self.gateway_name = data.fetch(:gateway_name, self.gateway_name) self.three_d_s_status = data.fetch(:three_d_s_status, self.three_d_s_status) self.status = data.fetch(:status, self.status) self.authorized = data.fetch(:authorized, self.authorized) self.captured = data.fetch(:captured, self.captured) self.voided = data.fetch(:voided, self.voided) self.refunded = data.fetch(:refunded, self.refunded) self.chargedback = data.fetch(:chargedback, self.chargedback) self.received_fraud_notification = data.fetch(:received_fraud_notification, self.received_fraud_notification) self.received_retrieval_request = data.fetch(:received_retrieval_request, self.received_retrieval_request) self.processout_fee = data.fetch(:processout_fee, self.processout_fee) self.estimated_fee = data.fetch(:estimated_fee, self.estimated_fee) self.gateway_fee = data.fetch(:gateway_fee, self.gateway_fee) self.gateway_fee_local = data.fetch(:gateway_fee_local, self.gateway_fee_local) self.currency_fee = data.fetch(:currency_fee, self.currency_fee) self.metadata = data.fetch(:metadata, self.metadata) self.sandbox = data.fetch(:sandbox, self.sandbox) self.created_at = data.fetch(:created_at, self.created_at) self.chargedback_at = data.fetch(:chargedback_at, self.chargedback_at) self.refunded_at = data.fetch(:refunded_at, self.refunded_at) self.three_d_s = data.fetch(:three_d_s, self.three_d_s) self.cvc_check = data.fetch(:cvc_check, self.cvc_check) self.avs_check = data.fetch(:avs_check, self.avs_check) self.initial_scheme_transaction_id = data.fetch(:initial_scheme_transaction_id, self.initial_scheme_transaction_id) self.scheme_id = data.fetch(:scheme_id, self.scheme_id) self.payment_type = data.fetch(:payment_type, self.payment_type) self.native_apm = data.fetch(:native_apm, self.native_apm) self.external_details = data.fetch(:external_details, self.external_details) self end # Get the transaction's refunds. # Params: # +options+:: +Hash+ of options def fetch_refunds(options = {}) self.prefill(options) request = Request.new(@client) path = "/transactions/" + CGI.escape(@id) + "/refunds" data = { } response = Response.new(request.get(path, data, options)) return_values = Array.new a = Array.new body = response.body for v in body['refunds'] tmp = Refund.new(@client) tmp.fill_with_data(v) a.push(tmp) end return_values.push(a) return_values[0] end # Find a transaction's refund by its ID. # Params: # +refund_id+:: ID of the refund # +options+:: +Hash+ of options def find_refund(refund_id, options = {}) self.prefill(options) request = Request.new(@client) path = "/transactions/" + CGI.escape(@id) + "/refunds/" + CGI.escape(refund_id) + "" data = { } response = Response.new(request.get(path, data, options)) return_values = Array.new body = response.body body = body["refund"] refund = Refund.new(@client) return_values.push(refund.fill_with_data(body)) return_values[0] end # Get all the transactions. # Params: # +options+:: +Hash+ of options def all(options = {}) self.prefill(options) request = Request.new(@client) path = "/transactions" data = { } response = Response.new(request.get(path, data, options)) return_values = Array.new a = Array.new body = response.body for v in body['transactions'] tmp = Transaction.new(@client) tmp.fill_with_data(v) a.push(tmp) end return_values.push(a) return_values[0] end # Find a transaction by its ID. # Params: # +transaction_id+:: ID of the transaction # +options+:: +Hash+ of options def find(transaction_id, options = {}) self.prefill(options) request = Request.new(@client) path = "/transactions/" + CGI.escape(transaction_id) + "" data = { } response = Response.new(request.get(path, data, options)) return_values = Array.new body = response.body body = body["transaction"] obj = Transaction.new(@client) return_values.push(obj.fill_with_data(body)) return_values[0] end end end