connect-sdk-ruby 1.0.0

data/examples/merchant/payments/get_payment_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.merchant('merchantId').payments().get('paymentId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payments/process_challenged_payment_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.merchant('merchantId').payments().processchallenged('paymentId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payments/refund_payment_example.rb

@@ -0,0 +1,85 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_exception'
+require 'ingenico/connect/sdk/declined_refund_exception'
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+require 'ingenico/connect/sdk/domain/definitions/bank_account_iban'
+require 'ingenico/connect/sdk/domain/definitions/contact_details_base'
+require 'ingenico/connect/sdk/domain/payment/address_personal'
+require 'ingenico/connect/sdk/domain/payment/personal_name'
+require 'ingenico/connect/sdk/domain/refund/refund_request'
+require 'ingenico/connect/sdk/domain/refund/bank_refund_method_specific_input'
+require 'ingenico/connect/sdk/domain/refund/refund_customer'
+require 'ingenico/connect/sdk/domain/refund/refund_references'
+
+Definitions = Ingenico::Connect::SDK::Domain::Definitions
+Refund = Ingenico::Connect::SDK::Domain::Refund
+Payment = Ingenico::Connect::SDK::Domain::Payment
+
+def example
+  get_client do |client|
+    amount_of_money = Definitions::AmountOfMoney.new
+    amount_of_money.amount = 1
+    amount_of_money.currency_code = 'EUR'
+
+    bank_account_iban = Definitions::BankAccountIban.new
+    bank_account_iban.iban = 'NL53INGB0000000036'
+
+    bank_refund_method_specific_input = Refund::BankRefundMethodSpecificInput.new
+    bank_refund_method_specific_input.bank_account_iban = bank_account_iban
+
+    name = Payment::PersonalName.new
+    name.surname = 'Coyote'
+
+    address = Payment::AddressPersonal.new
+    address.country_code = 'US'
+    address.name = name
+
+    contact_details = Definitions::ContactDetailsBase.new
+    contact_details.email_address = 'wile.e.coyote@acmelabs.com'
+    contact_details.email_message_type = 'html'
+
+    customer = Refund::RefundCustomer.new
+    customer.address = address
+    customer.contact_details = contact_details
+
+    refund_references = Refund::RefundReferences.new
+    refund_references.merchant_reference = 'AcmeOrder0001'
+
+    body = Refund::RefundRequest.new
+    body.amount_of_money = amount_of_money
+    body.bank_refund_method_specific_input = bank_refund_method_specific_input
+    body.customer = customer
+    body.refund_date = '20140306'
+    body.refund_references = refund_references
+
+    begin
+      response = client.merchant('merchantId').payments().refund('paymentId', body)
+    rescue Ingenico::Connect::SDK::DeclinedRefundException => e
+      handle_declined_refund(e.refund_result)
+    rescue Ingenico::Connect::SDK::ApiException => e
+      handle_api_errors(e.errors)
+    end
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end
+
+def handle_declined_refund(refund_result)
+  # handle the result here
+end
+
+def  handle_api_errors(errors)
+  # handle the errors here
+end

data/examples/merchant/payments/tokenize_payment_example.rb

@@ -0,0 +1,27 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/payment/tokenize_payment_request'
+
+Payment = Ingenico::Connect::SDK::Domain::Payment
+
+def example
+  get_client do |client|
+    body = Payment::TokenizePaymentRequest.new
+    body.alias = 'Some alias'
+
+    response = client.merchant('merchantId').payments().tokenize('paymentId', body)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payouts/approve_payout_example.rb

@@ -0,0 +1,27 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/payout/approve_payout_request'
+
+Payout = Ingenico::Connect::SDK::Domain::Payout
+
+def example
+  get_client do |client|
+    body = Payout::ApprovePayoutRequest.new
+    body.date_payout = '20150102'
+
+    response = client.merchant('merchantId').payouts().approve('payoutId', body)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payouts/cancel_approval_payout_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    client.merchant('merchantId').payouts().cancelapproval('payoutId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payouts/cancel_payout_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    client.merchant('merchantId').payouts().cancel('payoutId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payouts/create_payout_example.rb

@@ -0,0 +1,96 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_exception'
+require 'ingenico/connect/sdk/declined_payout_exception'
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/definitions/address'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+require 'ingenico/connect/sdk/domain/definitions/bank_account_iban'
+require 'ingenico/connect/sdk/domain/definitions/company_information'
+require 'ingenico/connect/sdk/domain/definitions/contact_details_base'
+require 'ingenico/connect/sdk/domain/payment/personal_name'
+require 'ingenico/connect/sdk/domain/payout/create_payout_request'
+require 'ingenico/connect/sdk/domain/payout/payout_customer'
+require 'ingenico/connect/sdk/domain/payout/payout_references'
+
+Definitions = Ingenico::Connect::SDK::Domain::Definitions
+Payout = Ingenico::Connect::SDK::Domain::Payout
+Payment = Ingenico::Connect::SDK::Domain::Payment
+
+def example
+  get_client do |client|
+    amount_of_money = Definitions::AmountOfMoney.new
+    amount_of_money.amount = 2345
+    amount_of_money.currency_code = 'EUR'
+
+    bank_account_iban = Definitions::BankAccountIban.new
+    bank_account_iban.account_holder_name = 'Wile E. Coyote'
+    bank_account_iban.iban = 'IT60X0542811101000000123456'
+
+    address = Definitions::Address.new
+    address.city = 'Burbank'
+    address.country_code = 'US'
+    address.house_number = '411'
+    address.state = 'California'
+    address.street = 'N Hollywood Way'
+    address.zip = '91505'
+
+    company_information = Definitions::CompanyInformation.new
+    company_information.name = 'Acme Labs'
+
+    contact_details = Definitions::ContactDetailsBase.new
+    contact_details.email_address = 'wile.e.coyote@acmelabs.com'
+
+    name = Payment::PersonalName.new
+    name.first_name = 'Wile'
+    name.surname = 'Coyote'
+    name.surname_prefix = 'E.'
+    name.title = 'Mr.'
+
+    customer = Payout::PayoutCustomer.new
+    customer.address = address
+    customer.company_information = company_information
+    customer.contact_details = contact_details
+    customer.name = name
+
+    references = Payout::PayoutReferences.new
+    references.merchant_reference = 'AcmeOrder001'
+
+    body = Payout::CreatePayoutRequest.new
+    body.amount_of_money = amount_of_money
+    body.bank_account_iban = bank_account_iban
+    body.customer = customer
+    body.payout_date = '20150102'
+    body.payout_text = 'Payout Acme'
+    body.references = references
+    body.swift_code = 'swift'
+
+    begin
+      response = client.merchant('merchantId').payouts().create(body)
+    rescue Ingenico::Connect::SDK::DeclinedPayoutException => e
+      handle_declined_payout(e.payout_result)
+    rescue Ingenico::Connect::SDK::ApiException => e
+      handle_api_errors(e.errors)
+    end
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end
+
+def handle_declined_payout(payout_result)
+  # handle the result here
+end
+
+def  handle_api_errors(errors)
+  # handle the errors here
+end

data/examples/merchant/payouts/get_payout_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.merchant('merchantId').payouts().get('payoutId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/productgroups/get_payment_product_group_example.rb

@@ -0,0 +1,32 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/merchant/productgroups/get_productgroup_params'
+
+Productgroups = Ingenico::Connect::SDK::Merchant::Productgroups
+
+def example
+  get_client do |client|
+    query = Productgroups::GetProductgroupParams.new
+    query.amount = 1000
+    query.is_recurring = true
+    query.country_code = 'NL'
+    query.locale = 'en_US'
+    query.currency_code = 'EUR'
+    query.add_hide('fields')
+
+    response = client.merchant('merchantId').productgroups().get('cards', query)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/productgroups/get_payment_product_groups_example.rb

@@ -0,0 +1,32 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/merchant/productgroups/find_productgroups_params'
+
+Productgroups = Ingenico::Connect::SDK::Merchant::Productgroups
+
+def example
+  get_client do |client|
+    query = Productgroups::FindProductgroupsParams.new
+    query.amount = 1000
+    query.is_recurring = true
+    query.country_code = 'NL'
+    query.locale = 'en_US'
+    query.currency_code = 'EUR'
+    query.add_hide('fields')
+
+    response = client.merchant('merchantId').productgroups().find(query)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/products/get_directory_example.rb

@@ -0,0 +1,28 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/merchant/products/directory_params'
+
+Products = Ingenico::Connect::SDK::Merchant::Products
+
+def example
+  get_client do |client|
+    query = Products::DirectoryParams.new
+    query.currency_code = 'EUR'
+    query.country_code = 'NL'
+
+    response = client.merchant('merchantId').products().directory(809, query)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end