connect-sdk-ruby 2.47.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 639cb3137b932ff3696b1b6b58fb5c423847ca36887dd3edcbc5279ced07915e
-  data.tar.gz: 5caa9df5c6141e264f1ca2a2c964ffc8d222a8e135c9a13f86b715998f2d9758
+  metadata.gz: 791117f1bb35e32230acf8eb4814e94c2d966e5d0bb025da5edf3ca23c6846be
+  data.tar.gz: 1eefc8bd5d196e6e32f2833bf25c522c8758408723831b7126d52ba56a860b94
 SHA512:
-  metadata.gz: 315c751a67acc403114ee5c26d161d9449ab25c0a61bee4e82d672c83752af64f40750ac31f92291976fb87349bfcc60e47e461c65d94ca30e9aef0f4bdced46
-  data.tar.gz: aab83d74614443ae32129bbcf72f18b9c6b8303ea8c1f29a5502e78a7f85822a2fadd641b7a940d103ce0d542d6bb7aa49f33441b0dbf65c1689d37cb93815c0
+  metadata.gz: 41051f07e0b269e54623a8d07863bf1331a1d0b59469c58662940a4a15a1a39cfdf37bd9ead59a01e5d216c74cfe0e4ac7a5dab912251e7f60b565a8e5a82947
+  data.tar.gz: 7eda244b03340ab7a979b16d33139c91407478110cb6cc5b7ebeb3e97a09b2e02a5cdea8727b685913fb406348726715c8e03eca41738f9aa3d8aeccdcaa137f

data/README.md

@@ -1,24 +1,24 @@
-# Ingenico Connect Ruby SDK
+# Worldline Connect Ruby SDK
 
 ## Introduction
 
-The Ruby SDK helps you to communicate with the [Ingenico Connect](https://epayments.developer-ingenico.com/) Server API. Its primary features are:
+The Ruby SDK helps you to communicate with the [Worldline Connect](https://docs.connect.worldline-solutions.com/) Server API. Its primary features are:
 
 * convenient Ruby library for the API calls and responses
     * marshalls Ruby request objects to HTTP requests
     * unmarshalls HTTP responses to Ruby response objects or Ruby exceptions
 * handling of all the details concerning authentication
-* handling of required meta data
+* handling of required metadata
 
 Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys. 
 
-See the [Ingenico Connect Developer Hub](https://epayments.developer-ingenico.com/documentation/sdk/server/ruby/) for more information on how to use the SDK.
+See the [Worldline Connect Developer Hub](https://docs.connect.worldline-solutions.com/documentation/sdk/server/ruby/) for more information on how to use the SDK.
 
 ## Structure of this repository
 
 This repository consists out of four main components:
 
-1. The source code of the SDK itself: `/lib/ingenico/connect/sdk/`
+1. The source code of the SDK itself: `/lib/worldline/connect/sdk/`
 2. The source code of the SDK unit tests: `/spec/lib/`
 3. The source code of the SDK integration tests: `/spec/integration/`
 4. Usage examples: `/examples/`
@@ -44,7 +44,7 @@ To install the SDK using `gem`, execute the following command:
 
 ### Using a pre-built gem
 
-1. Download the latest version of the Ruby SDK from GitHub. Choose the `connect-sdk-ruby-x.y.z.gem` file from the [releases](https://github.com/Ingenico-ePayments/connect-sdk-ruby/releases) page, where `x.y.z` is the version number.
+1. Download the latest version of the Ruby SDK from GitHub. Choose the `connect-sdk-ruby-x.y.z.gem` file from the [releases](https://github.com/Worldline-Global-Collect/connect-sdk-ruby/releases) page, where `x.y.z` is the version number.
 2. Navigate into the folder where the gem file is downloaded to, and execute the following command:
 
     ```
@@ -54,7 +54,7 @@ To install the SDK using `gem`, execute the following command:
 
 ### From source
 
-1. Download the latest version of the Ruby SDK from GitHub. Choose the `connect-sdk-ruby-x.y.z.zip` file from the [releases](https://github.com/Ingenico-ePayments/connect-sdk-ruby/releases) page, where `x.y.z` is the version number.
+1. Download the latest version of the Ruby SDK from GitHub. Choose the `connect-sdk-ruby-x.y.z.zip` file from the [releases](https://github.com/Worldline-Global-Collect/connect-sdk-ruby/releases) page, where `x.y.z` is the version number.
 2. Unzip the file, navigate into the folder where the file is unzipped to, and execute the following commands:
 
     ```
@@ -76,7 +76,7 @@ The required packages can be uninstalled in the same way.
 
 After the Ruby SDK has been installed, it can be required in Ruby program as follows:
 
-    require 'ingenico/connect/sdk'
+    require 'worldline/connect/sdk'
 
 ## Running tests
 

data/connect-sdk-ruby.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '2.47.1'
-  spec.authors        = ['Ingenico ePayments']
-  spec.email          = ['github@epay.ingenico.com']
-  spec.summary        = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}
-  spec.description    = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}
-  spec.homepage       = %q{https://github.com/Ingenico-ePayments/connect-sdk-ruby}
+  spec.version        = '3.1.0'
+  spec.authors        = ['Worldline Global Collect']
+  spec.email          = ['github.connect@worldline.com']
+  spec.summary        = %q{SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API}
+  spec.description    = %q{SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API}
+  spec.homepage       = %q{https://github.com/Worldline-Global-Collect/connect-sdk-ruby}
   spec.license        = 'MIT'
 
   # exclude hidden files like .gitignore

data/examples/example_configuration.yml

@@ -0,0 +1,7 @@
+--- # YAML settings used in testing the SDK
+  connect.api.endpoint.host: api.preprod.connect.worldline-solutions.com
+  connect.api.authorizationType: v1HMAC
+  connect.api.connectTimeout: -1
+  connect.api.socketTimeout: -1
+  connect.api.maxConnections: 100
+  connect.api.integrator: Worldline

data/examples/v1/merchant/captures/create_refund_capture_example.rb

@@ -0,0 +1,53 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+require 'worldline/connect/sdk/v1/api_exception'
+require 'worldline/connect/sdk/v1/declined_refund_exception'
+require 'worldline/connect/sdk/v1/domain/amount_of_money'
+require 'worldline/connect/sdk/v1/domain/refund_references'
+require 'worldline/connect/sdk/v1/domain/refund_request'
+
+Domain = Worldline::Connect::SDK::V1::Domain
+
+def example
+  get_client do |client|
+    amount_of_money = Domain::AmountOfMoney.new
+    amount_of_money.amount = 500
+    amount_of_money.currency_code = 'EUR'
+
+    refund_references = Domain::RefundReferences.new
+    refund_references.merchant_reference = 'AcmeOrder0001'
+
+    body = Domain::RefundRequest.new
+    body.amount_of_money = amount_of_money
+    body.refund_references = refund_references
+
+    begin
+      response = client.v1.merchant('merchantId').captures.refund('captureId', body)
+    rescue Worldline::Connect::SDK::V1::DeclinedRefundException => e
+      handle_declined_refund(e.refund_result)
+    rescue Worldline::Connect::SDK::V1::ApiException => e
+      handle_error_response(e.error_id, 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 = Worldline::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_error_response(error_id, errors)
+  # handle the error response here
+end

data/examples/v1/merchant/captures/get_capture_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.v1.merchant('merchantId').captures.get('captureId')
+  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 = Worldline::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/v1/merchant/disputes/cancel_dispute_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.v1.merchant('merchantId').disputes.cancel('disputeId')
+  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 = Worldline::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/v1/merchant/disputes/get_dispute_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.v1.merchant('merchantId').disputes.get('disputeId')
+  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 = Worldline::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/v1/merchant/disputes/submit_dispute_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.v1.merchant('merchantId').disputes.submit('disputeId')
+  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 = Worldline::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/v1/merchant/disputes/upload_dispute_file_example.rb

@@ -0,0 +1,31 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+require 'worldline/connect/sdk/domain/uploadable_file'
+require 'worldline/connect/sdk/v1/merchant/disputes/upload_file_request'
+
+Disputes = Worldline::Connect::SDK::V1::Merchant::Disputes
+UploadableFile = Worldline::Connect::SDK::Domain::UploadableFile
+
+def example
+  get_client do |client|
+    body = Disputes::UploadFileRequest.new
+    File.open("file.pdf", mode="rb") do |file_content|
+      body.file = UploadableFile.new("file.pdf", file_content, "application/pdf")
+
+      response = client.v1.merchant('merchantId').disputes.upload_file('disputeId', body)
+    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 = Worldline::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/v1/merchant/files/get_file_example.rb

@@ -0,0 +1,28 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    client.v1.merchant('merchantId').files.get_file('fileId') do |headers, response_body|
+        # Use the headers and response body
+        # For instance:
+        while chunk = response_body.read(8192)
+          # do something with the chunk
+        end
+    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 = Worldline::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/v1/merchant/hostedcheckouts/create_hosted_checkout_example.rb

@@ -0,0 +1,52 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+require 'worldline/connect/sdk/v1/domain/address'
+require 'worldline/connect/sdk/v1/domain/amount_of_money'
+require 'worldline/connect/sdk/v1/domain/create_hosted_checkout_request'
+require 'worldline/connect/sdk/v1/domain/customer'
+require 'worldline/connect/sdk/v1/domain/hosted_checkout_specific_input'
+require 'worldline/connect/sdk/v1/domain/order'
+
+Domain = Worldline::Connect::SDK::V1::Domain
+
+def example
+  get_client do |client|
+    hosted_checkout_specific_input = Domain::HostedCheckoutSpecificInput.new
+    hosted_checkout_specific_input.locale = 'en_GB'
+    hosted_checkout_specific_input.variant = 'testVariant'
+
+    amount_of_money = Domain::AmountOfMoney.new
+    amount_of_money.amount = 2345
+    amount_of_money.currency_code = 'USD'
+
+    billing_address = Domain::Address.new
+    billing_address.country_code = 'US'
+
+    customer = Domain::Customer.new
+    customer.billing_address = billing_address
+    customer.merchant_customer_id = '1234'
+
+    order = Domain::Order.new
+    order.amount_of_money = amount_of_money
+    order.customer = customer
+
+    body = Domain::CreateHostedCheckoutRequest.new
+    body.hosted_checkout_specific_input = hosted_checkout_specific_input
+    body.order = order
+
+    response = client.v1.merchant('merchantId').hostedcheckouts.create(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 = Worldline::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/v1/merchant/hostedcheckouts/delete_hosted_checkout_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    client.v1.merchant('merchantId').hostedcheckouts.delete('hostedCheckoutId')
+  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 = Worldline::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/v1/merchant/hostedcheckouts/get_hosted_checkout_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.v1.merchant('merchantId').hostedcheckouts.get('hostedCheckoutId')
+  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 = Worldline::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/v1/merchant/hostedmandatemanagements/create_hosted_mandate_management_example.rb

@@ -0,0 +1,40 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+require 'worldline/connect/sdk/v1/domain/create_hosted_mandate_management_request'
+require 'worldline/connect/sdk/v1/domain/hosted_mandate_info'
+require 'worldline/connect/sdk/v1/domain/hosted_mandate_management_specific_input'
+
+Domain = Worldline::Connect::SDK::V1::Domain
+
+def example
+  get_client do |client|
+    create_mandate_info = Domain::HostedMandateInfo.new
+    create_mandate_info.customer_reference = 'idonthaveareference'
+    create_mandate_info.recurrence_type = 'RECURRING'
+    create_mandate_info.signature_type = 'UNSIGNED'
+
+    hosted_mandate_management_specific_input = Domain::HostedMandateManagementSpecificInput.new
+    hosted_mandate_management_specific_input.locale = 'fr_FR'
+    hosted_mandate_management_specific_input.return_url = 'http://www.example.com'
+    hosted_mandate_management_specific_input.variant = '101'
+
+    body = Domain::CreateHostedMandateManagementRequest.new
+    body.create_mandate_info = create_mandate_info
+    body.hosted_mandate_management_specific_input = hosted_mandate_management_specific_input
+
+    response = client.v1.merchant('merchantId').hostedmandatemanagements.create(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 = Worldline::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/v1/merchant/hostedmandatemanagements/get_hosted_mandate_management_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.v1.merchant('merchantId').hostedmandatemanagements.get('hostedMandateManagementId')
+  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 = Worldline::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/v1/merchant/installments/get_installments_info_example.rb

@@ -0,0 +1,35 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+require 'worldline/connect/sdk/v1/domain/amount_of_money'
+require 'worldline/connect/sdk/v1/domain/get_installment_request'
+
+Domain = Worldline::Connect::SDK::V1::Domain
+
+def example
+  get_client do |client|
+    amount_of_money = Domain::AmountOfMoney.new
+    amount_of_money.amount = 123
+    amount_of_money.currency_code = 'EUR'
+
+    body = Domain::GetInstallmentRequest.new
+    body.amount_of_money = amount_of_money
+    body.bin = '123455'
+    body.country_code = 'NL'
+    body.payment_product_id = 123
+
+    response = client.v1.merchant('merchantId').installments.get_installments_info(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 = Worldline::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/v1/merchant/mandates/block_mandate_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.v1.merchant('merchantId').mandates.block('42268d8067df43e18a50a2ebf4bdb729')
+  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 = Worldline::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/v1/merchant/mandates/create_mandate_example.rb

@@ -0,0 +1,64 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+require 'worldline/connect/sdk/v1/domain/bank_account_iban'
+require 'worldline/connect/sdk/v1/domain/create_mandate_request'
+require 'worldline/connect/sdk/v1/domain/mandate_address'
+require 'worldline/connect/sdk/v1/domain/mandate_contact_details'
+require 'worldline/connect/sdk/v1/domain/mandate_customer'
+require 'worldline/connect/sdk/v1/domain/mandate_personal_information'
+require 'worldline/connect/sdk/v1/domain/mandate_personal_name'
+
+Domain = Worldline::Connect::SDK::V1::Domain
+
+def example
+  get_client do |client|
+    bank_account_iban = Domain::BankAccountIban.new
+    bank_account_iban.iban = 'DE46720200700359736690'
+
+    contact_details = Domain::MandateContactDetails.new
+    contact_details.email_address = 'wile.e.coyote@acmelabs.com'
+
+    mandate_address = Domain::MandateAddress.new
+    mandate_address.city = 'Monumentenvallei'
+    mandate_address.country_code = 'NL'
+    mandate_address.street = 'Woestijnweg'
+    mandate_address.zip = '1337XD'
+
+    name = Domain::MandatePersonalName.new
+    name.first_name = 'Wile'
+    name.surname = 'Coyote'
+
+    personal_information = Domain::MandatePersonalInformation.new
+    personal_information.name = name
+    personal_information.title = 'Miss'
+
+    customer = Domain::MandateCustomer.new
+    customer.bank_account_iban = bank_account_iban
+    customer.company_name = 'Acme labs'
+    customer.contact_details = contact_details
+    customer.mandate_address = mandate_address
+    customer.personal_information = personal_information
+
+    body = Domain::CreateMandateRequest.new
+    body.customer = customer
+    body.customer_reference = 'idonthaveareference'
+    body.language = 'nl'
+    body.recurrence_type = 'UNIQUE'
+    body.signature_type = 'UNSIGNED'
+
+    response = client.v1.merchant('merchantId').mandates.create(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 = Worldline::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/v1/merchant/mandates/create_mandate_with_reference_example.rb

@@ -0,0 +1,64 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+require 'worldline/connect/sdk/factory'
+require 'worldline/connect/sdk/v1/domain/bank_account_iban'
+require 'worldline/connect/sdk/v1/domain/create_mandate_request'
+require 'worldline/connect/sdk/v1/domain/mandate_address'
+require 'worldline/connect/sdk/v1/domain/mandate_contact_details'
+require 'worldline/connect/sdk/v1/domain/mandate_customer'
+require 'worldline/connect/sdk/v1/domain/mandate_personal_information'
+require 'worldline/connect/sdk/v1/domain/mandate_personal_name'
+
+Domain = Worldline::Connect::SDK::V1::Domain
+
+def example
+  get_client do |client|
+    bank_account_iban = Domain::BankAccountIban.new
+    bank_account_iban.iban = 'DE46720200700359736690'
+
+    contact_details = Domain::MandateContactDetails.new
+    contact_details.email_address = 'wile.e.coyote@acmelabs.com'
+
+    mandate_address = Domain::MandateAddress.new
+    mandate_address.city = 'Monumentenvallei'
+    mandate_address.country_code = 'NL'
+    mandate_address.street = 'Woestijnweg'
+    mandate_address.zip = '1337XD'
+
+    name = Domain::MandatePersonalName.new
+    name.first_name = 'Wile'
+    name.surname = 'Coyote'
+
+    personal_information = Domain::MandatePersonalInformation.new
+    personal_information.name = name
+    personal_information.title = 'Miss'
+
+    customer = Domain::MandateCustomer.new
+    customer.bank_account_iban = bank_account_iban
+    customer.company_name = 'Acme labs'
+    customer.contact_details = contact_details
+    customer.mandate_address = mandate_address
+    customer.personal_information = personal_information
+
+    body = Domain::CreateMandateRequest.new
+    body.customer = customer
+    body.customer_reference = 'idonthaveareference'
+    body.language = 'nl'
+    body.recurrence_type = 'UNIQUE'
+    body.signature_type = 'UNSIGNED'
+
+    response = client.v1.merchant('merchantId').mandates.create_with_mandate_reference('42268d8067df43e18a50a2ebf4bdb729', 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 = Worldline::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