connect-sdk-ruby 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e02115e2dab9440881845b678788d86eb87344087d3bbecaabdfdb2e8ce059c3
-  data.tar.gz: bb84228975409f7335817a16fdbf22d7223b676e3c619b116ed33a964057fe6a
+  metadata.gz: 9d6fcdc2f027cdeefbca0ccd452ba53cd5ea8ec9a369b6d8fd5828a68bb616c5
+  data.tar.gz: 9817e5abd2a1b0b213dd584ce742039e5724e2f90442fd110566232f9d3fffcf
 SHA512:
-  metadata.gz: 4a827e2f0cfbd3fc791fbc7b08c72a3ad7df12b674f34c829a01c4d3e0d5f3c3bee5ed62e9a227331b834a14d7501405663dbfdffc0b554b6f15e80e82b3b3c6
-  data.tar.gz: 77cb4eea44d9566ce4f2de96e705e6aae5f960c027e541b927ec5f7a464e0d6524156ce726432e5dedcba6a784044ae60109779538d59e458db2b0687a096cc4
+  metadata.gz: edc66e5f8fe391f1d7904fbe39ec5f88565d5d889415f3207128bee2ad9e22b0fe5e57c18d5a0f335e95c013b419fd7765a61815586adfe8c748f7f4bb2b5106
+  data.tar.gz: 6b09bc826e60c42e56940f48ab8e5b53b571342f18393cd878cb65119ae7de5c92d20829faa1cd9a82fa3f942221404d2c9453fabe098107cac2660d7251b0cf

data/connect-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '1.30.0'
+  spec.version        = '1.31.0'
   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}

data/examples/merchant/disputes/get_dispute_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.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 = 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/disputes/submit_dispute_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.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 = 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/create_payment_dispute_example.rb

@@ -0,0 +1,37 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+require 'ingenico/connect/sdk/domain/dispute/create_dispute_request'
+
+Definitions = Ingenico::Connect::SDK::Domain::Definitions
+Dispute = Ingenico::Connect::SDK::Domain::Dispute
+
+def example
+  get_client do |client|
+    amount_of_money = Definitions::AmountOfMoney.new
+    amount_of_money.amount = 1234
+    amount_of_money.currency_code = 'USD'
+
+    body = Dispute::CreateDisputeRequest.new
+    body.amount_of_money = amount_of_money
+    body.contact_person = 'Wile Coyote'
+    body.email_address = 'wile.e.coyote@acmelabs.com'
+    body.reply_to = 'r.runner@acmelabs.com'
+    body.request_message = 'This is the message from the merchant to GlobalCollect. It is a a freeform text field.'
+
+    response = client.merchant('merchantId').payments().dispute('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/payments/get_payment_disputes_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.merchant('merchantId').payments().disputes('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/lib/ingenico/connect/sdk/domain/dispute/create_dispute_request.rb

@@ -0,0 +1,63 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/data_object'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+
+module Ingenico::Connect::SDK
+  module Domain
+    module Dispute
+
+      class CreateDisputeRequest < Ingenico::Connect::SDK::DataObject
+
+        # {Ingenico::Connect::SDK::Domain::Definitions::AmountOfMoney}
+        attr_accessor :amount_of_money
+
+        # String
+        attr_accessor :contact_person
+
+        # String
+        attr_accessor :email_address
+
+        # String
+        attr_accessor :reply_to
+
+        # String
+        attr_accessor :request_message
+
+        def to_h
+          hash = super
+          add_to_hash(hash, 'amountOfMoney', @amount_of_money)
+          add_to_hash(hash, 'contactPerson', @contact_person)
+          add_to_hash(hash, 'emailAddress', @email_address)
+          add_to_hash(hash, 'replyTo', @reply_to)
+          add_to_hash(hash, 'requestMessage', @request_message)
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key?('amountOfMoney')
+            if !(hash['amountOfMoney'].is_a? Hash)
+              raise TypeError, "value '%s' is not a Hash" % [hash['amountOfMoney']]
+            end
+            @amount_of_money = Ingenico::Connect::SDK::Domain::Definitions::AmountOfMoney.new_from_hash(hash['amountOfMoney'])
+          end
+          if hash.has_key?('contactPerson')
+            @contact_person = hash['contactPerson']
+          end
+          if hash.has_key?('emailAddress')
+            @email_address = hash['emailAddress']
+          end
+          if hash.has_key?('replyTo')
+            @reply_to = hash['replyTo']
+          end
+          if hash.has_key?('requestMessage')
+            @request_message = hash['requestMessage']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/domain/dispute/dispute.rb

@@ -0,0 +1,67 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/data_object'
+require 'ingenico/connect/sdk/domain/dispute/dispute_output'
+require 'ingenico/connect/sdk/domain/dispute/dispute_status_output'
+
+module Ingenico::Connect::SDK
+  module Domain
+    module Dispute
+
+      class Dispute < Ingenico::Connect::SDK::DataObject
+
+        # {Ingenico::Connect::SDK::Domain::Dispute::DisputeOutput}
+        attr_accessor :dispute_output
+
+        # String
+        attr_accessor :id
+
+        # String
+        attr_accessor :payment_id
+
+        # String
+        attr_accessor :status
+
+        # {Ingenico::Connect::SDK::Domain::Dispute::DisputeStatusOutput}
+        attr_accessor :status_output
+
+        def to_h
+          hash = super
+          add_to_hash(hash, 'disputeOutput', @dispute_output)
+          add_to_hash(hash, 'id', @id)
+          add_to_hash(hash, 'paymentId', @payment_id)
+          add_to_hash(hash, 'status', @status)
+          add_to_hash(hash, 'statusOutput', @status_output)
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key?('disputeOutput')
+            if !(hash['disputeOutput'].is_a? Hash)
+              raise TypeError, "value '%s' is not a Hash" % [hash['disputeOutput']]
+            end
+            @dispute_output = Ingenico::Connect::SDK::Domain::Dispute::DisputeOutput.new_from_hash(hash['disputeOutput'])
+          end
+          if hash.has_key?('id')
+            @id = hash['id']
+          end
+          if hash.has_key?('paymentId')
+            @payment_id = hash['paymentId']
+          end
+          if hash.has_key?('status')
+            @status = hash['status']
+          end
+          if hash.has_key?('statusOutput')
+            if !(hash['statusOutput'].is_a? Hash)
+              raise TypeError, "value '%s' is not a Hash" % [hash['statusOutput']]
+            end
+            @status_output = Ingenico::Connect::SDK::Domain::Dispute::DisputeStatusOutput.new_from_hash(hash['statusOutput'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/domain/dispute/dispute_creation_detail.rb

@@ -0,0 +1,45 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/data_object'
+
+module Ingenico::Connect::SDK
+  module Domain
+    module Dispute
+
+      class DisputeCreationDetail < Ingenico::Connect::SDK::DataObject
+
+        # String
+        attr_accessor :dispute_creation_date
+
+        # String
+        attr_accessor :dispute_originator
+
+        # String
+        attr_accessor :user_name
+
+        def to_h
+          hash = super
+          add_to_hash(hash, 'disputeCreationDate', @dispute_creation_date)
+          add_to_hash(hash, 'disputeOriginator', @dispute_originator)
+          add_to_hash(hash, 'userName', @user_name)
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key?('disputeCreationDate')
+            @dispute_creation_date = hash['disputeCreationDate']
+          end
+          if hash.has_key?('disputeOriginator')
+            @dispute_originator = hash['disputeOriginator']
+          end
+          if hash.has_key?('userName')
+            @user_name = hash['userName']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/domain/dispute/dispute_output.rb

@@ -0,0 +1,106 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/data_object'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+require 'ingenico/connect/sdk/domain/dispute/dispute_creation_detail'
+require 'ingenico/connect/sdk/domain/dispute/dispute_reference'
+require 'ingenico/connect/sdk/domain/file/hosted_file'
+
+module Ingenico::Connect::SDK
+  module Domain
+    module Dispute
+
+      class DisputeOutput < Ingenico::Connect::SDK::DataObject
+
+        # {Ingenico::Connect::SDK::Domain::Definitions::AmountOfMoney}
+        attr_accessor :amount_of_money
+
+        # String
+        attr_accessor :contact_person
+
+        # {Ingenico::Connect::SDK::Domain::Dispute::DisputeCreationDetail}
+        attr_accessor :creation_details
+
+        # String
+        attr_accessor :email_address
+
+        # Array of {Ingenico::Connect::SDK::Domain::File::HostedFile}
+        attr_accessor :files
+
+        # {Ingenico::Connect::SDK::Domain::Dispute::DisputeReference}
+        attr_accessor :reference
+
+        # String
+        attr_accessor :reply_to
+
+        # String
+        attr_accessor :request_message
+
+        # String
+        attr_accessor :response_message
+
+        def to_h
+          hash = super
+          add_to_hash(hash, 'amountOfMoney', @amount_of_money)
+          add_to_hash(hash, 'contactPerson', @contact_person)
+          add_to_hash(hash, 'creationDetails', @creation_details)
+          add_to_hash(hash, 'emailAddress', @email_address)
+          add_to_hash(hash, 'files', @files)
+          add_to_hash(hash, 'reference', @reference)
+          add_to_hash(hash, 'replyTo', @reply_to)
+          add_to_hash(hash, 'requestMessage', @request_message)
+          add_to_hash(hash, 'responseMessage', @response_message)
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key?('amountOfMoney')
+            if !(hash['amountOfMoney'].is_a? Hash)
+              raise TypeError, "value '%s' is not a Hash" % [hash['amountOfMoney']]
+            end
+            @amount_of_money = Ingenico::Connect::SDK::Domain::Definitions::AmountOfMoney.new_from_hash(hash['amountOfMoney'])
+          end
+          if hash.has_key?('contactPerson')
+            @contact_person = hash['contactPerson']
+          end
+          if hash.has_key?('creationDetails')
+            if !(hash['creationDetails'].is_a? Hash)
+              raise TypeError, "value '%s' is not a Hash" % [hash['creationDetails']]
+            end
+            @creation_details = Ingenico::Connect::SDK::Domain::Dispute::DisputeCreationDetail.new_from_hash(hash['creationDetails'])
+          end
+          if hash.has_key?('emailAddress')
+            @email_address = hash['emailAddress']
+          end
+          if hash.has_key?('files')
+            if !(hash['files'].is_a? Array)
+              raise TypeError, "value '%s' is not an Array" % [hash['files']]
+            end
+            @files = []
+            hash['files'].each do |e|
+              @files << Ingenico::Connect::SDK::Domain::File::HostedFile.new_from_hash(e)
+            end
+          end
+          if hash.has_key?('reference')
+            if !(hash['reference'].is_a? Hash)
+              raise TypeError, "value '%s' is not a Hash" % [hash['reference']]
+            end
+            @reference = Ingenico::Connect::SDK::Domain::Dispute::DisputeReference.new_from_hash(hash['reference'])
+          end
+          if hash.has_key?('replyTo')
+            @reply_to = hash['replyTo']
+          end
+          if hash.has_key?('requestMessage')
+            @request_message = hash['requestMessage']
+          end
+          if hash.has_key?('responseMessage')
+            @response_message = hash['responseMessage']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/domain/dispute/dispute_reference.rb

@@ -0,0 +1,59 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/data_object'
+
+module Ingenico::Connect::SDK
+  module Domain
+    module Dispute
+
+      class DisputeReference < Ingenico::Connect::SDK::DataObject
+
+        # String
+        attr_accessor :merchant_order_id
+
+        # String
+        attr_accessor :merchant_reference
+
+        # String
+        attr_accessor :payment_reference
+
+        # String
+        attr_accessor :provider_id
+
+        # String
+        attr_accessor :provider_reference
+
+        def to_h
+          hash = super
+          add_to_hash(hash, 'merchantOrderId', @merchant_order_id)
+          add_to_hash(hash, 'merchantReference', @merchant_reference)
+          add_to_hash(hash, 'paymentReference', @payment_reference)
+          add_to_hash(hash, 'providerId', @provider_id)
+          add_to_hash(hash, 'providerReference', @provider_reference)
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key?('merchantOrderId')
+            @merchant_order_id = hash['merchantOrderId']
+          end
+          if hash.has_key?('merchantReference')
+            @merchant_reference = hash['merchantReference']
+          end
+          if hash.has_key?('paymentReference')
+            @payment_reference = hash['paymentReference']
+          end
+          if hash.has_key?('providerId')
+            @provider_id = hash['providerId']
+          end
+          if hash.has_key?('providerReference')
+            @provider_reference = hash['providerReference']
+          end
+        end
+      end
+    end
+  end
+end