bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/optin_response.rb

@@ -0,0 +1,220 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'optin' Response - General Parameters
+  class OptinResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned unique request ID.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # The 'result' element is defined in every response type. It is used to
+    # convey the outcome of an API request.
+    # @return [Result]
+    attr_accessor :result
+
+    # Provides information for proceeding with a hosted opt-in.
+    # @return [OptinResponseHosted]
+    attr_accessor :hosted
+
+    # Merchant-assigned unique opt-in ID.
+    # @return [String]
+    attr_accessor :merchant_optin_id
+
+    # Boku-assigned unique opt-in ID.
+    # @return [String]
+    attr_accessor :optin_id
+
+    # Gives the state of the opt-in at the time this response was returned
+    # @return [OptinState]
+    attr_accessor :optin_state
+
+    # Specifies which method to use to perform the opt-in.
+    # @return [OptinTypeEnum]
+    attr_accessor :optin_type
+
+    # The payment method selected.
+    # @return [String]
+    attr_accessor :payment_method
+
+    # Optin and Charge Request API can be made for specific Seller of Record
+    # previously registered with Boku.
+    # @return [SellerOfRecord]
+    attr_accessor :seller_of_record
+
+    # Time request was received ("YYYY-MM-DD hh:mm:ss").
+    # All timestamps are in UTC.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['result'] = 'result'
+      @_hash['hosted'] = 'hosted'
+      @_hash['merchant_optin_id'] = 'merchant-optin-id'
+      @_hash['optin_id'] = 'optin-id'
+      @_hash['optin_state'] = 'optin-state'
+      @_hash['optin_type'] = 'optin-type'
+      @_hash['payment_method'] = 'payment-method'
+      @_hash['seller_of_record'] = 'seller-of-record'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        hosted
+        merchant_optin_id
+        optin_id
+        optin_state
+        optin_type
+        payment_method
+        seller_of_record
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id = nil, merchant_request_id = nil, result = nil,
+                   hosted = SKIP, merchant_optin_id = SKIP, optin_id = SKIP,
+                   optin_state = SKIP, optin_type = SKIP, payment_method = SKIP,
+                   seller_of_record = SKIP, timestamp = SKIP)
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+      @result = result
+      @hosted = hosted unless hosted == SKIP
+      @merchant_optin_id = merchant_optin_id unless merchant_optin_id == SKIP
+      @optin_id = optin_id unless optin_id == SKIP
+      @optin_state = optin_state unless optin_state == SKIP
+      @optin_type = optin_type unless optin_type == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @seller_of_record = seller_of_record unless seller_of_record == SKIP
+      @timestamp = timestamp unless timestamp == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+      hosted = OptinResponseHosted.from_hash(hash['hosted']) if hash['hosted']
+      merchant_optin_id =
+        hash.key?('merchant-optin-id') ? hash['merchant-optin-id'] : SKIP
+      optin_id = hash.key?('optin-id') ? hash['optin-id'] : SKIP
+      optin_state = OptinState.from_hash(hash['optin-state']) if hash['optin-state']
+      optin_type = hash.key?('optin-type') ? hash['optin-type'] : SKIP
+      payment_method =
+        hash.key?('payment-method') ? hash['payment-method'] : SKIP
+      seller_of_record = SellerOfRecord.from_hash(hash['seller-of-record']) if
+        hash['seller-of-record']
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+
+      # Create object from extracted values.
+      OptinResponse.new(merchant_id,
+                        merchant_request_id,
+                        result,
+                        hosted,
+                        merchant_optin_id,
+                        optin_id,
+                        optin_state,
+                        optin_type,
+                        payment_method,
+                        seller_of_record,
+                        timestamp)
+    end
+
+    def self.from_element(root)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      hosted = XmlUtilities.from_element(root, 'hosted', OptinResponseHosted)
+      merchant_optin_id = XmlUtilities.from_element(root, 'merchant-optin-id',
+                                                    String)
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+      optin_state = XmlUtilities.from_element(root, 'optin-state', OptinState)
+      optin_type = XmlUtilities.from_element(root, 'optin-type', String)
+      payment_method = XmlUtilities.from_element(root, 'payment-method', String)
+      seller_of_record = XmlUtilities.from_element(root, 'seller-of-record',
+                                                   SellerOfRecord)
+      timestamp = XmlUtilities.from_element(root, 'timestamp', String)
+
+      new(merchant_id,
+          merchant_request_id,
+          result,
+          hosted,
+          merchant_optin_id,
+          optin_id,
+          optin_state,
+          optin_type,
+          payment_method,
+          seller_of_record,
+          timestamp)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'hosted', hosted)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-optin-id',
+                                     merchant_optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-id', optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-state', optin_state)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-type', optin_type)
+      XmlUtilities.add_as_subelement(doc, root, 'payment-method',
+                                     payment_method)
+      XmlUtilities.add_as_subelement(doc, root, 'seller-of-record',
+                                     seller_of_record)
+      XmlUtilities.add_as_subelement(doc, root, 'timestamp', timestamp)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_id: #{@merchant_id}, merchant_request_id: #{@merchant_request_id},"\
+      " result: #{@result}, hosted: #{@hosted}, merchant_optin_id: #{@merchant_optin_id},"\
+      " optin_id: #{@optin_id}, optin_state: #{@optin_state}, optin_type: #{@optin_type},"\
+      " payment_method: #{@payment_method}, seller_of_record: #{@seller_of_record}, timestamp:"\
+      " #{@timestamp}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_id: #{@merchant_id.inspect}, merchant_request_id:"\
+      " #{@merchant_request_id.inspect}, result: #{@result.inspect}, hosted: #{@hosted.inspect},"\
+      " merchant_optin_id: #{@merchant_optin_id.inspect}, optin_id: #{@optin_id.inspect},"\
+      " optin_state: #{@optin_state.inspect}, optin_type: #{@optin_type.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, seller_of_record: #{@seller_of_record.inspect}, timestamp:"\
+      " #{@timestamp.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_response_hosted.rb

@@ -0,0 +1,87 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Provides information for proceeding with a hosted opt-in.
+  class OptinResponseHosted < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-provided URL for the opt-in UI presented to the consumer.
+    # @return [String]
+    attr_accessor :optin_url
+
+    # Boku-provided URL for the opt-in UI presented to the consumer.
+    # @return [OptinResponseQrInfo]
+    attr_accessor :qr_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['optin_url'] = 'optin-url'
+      @_hash['qr_info'] = 'qr-info'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        qr_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(optin_url = nil, qr_info = SKIP)
+      @optin_url = optin_url
+      @qr_info = qr_info unless qr_info == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      optin_url = hash.key?('optin-url') ? hash['optin-url'] : nil
+      qr_info = OptinResponseQrInfo.from_hash(hash['qr-info']) if hash['qr-info']
+
+      # Create object from extracted values.
+      OptinResponseHosted.new(optin_url,
+                              qr_info)
+    end
+
+    def self.from_element(root)
+      optin_url = XmlUtilities.from_element(root, 'optin-url', String)
+      qr_info = XmlUtilities.from_element(root, 'qr-info', OptinResponseQrInfo)
+
+      new(optin_url,
+          qr_info)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'optin-url', optin_url)
+      XmlUtilities.add_as_subelement(doc, root, 'qr-info', qr_info)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} optin_url: #{@optin_url}, qr_info: #{@qr_info}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} optin_url: #{@optin_url.inspect}, qr_info: #{@qr_info.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_response_qr_info.rb

@@ -0,0 +1,85 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # OptinResponseQrInfo Model.
+  class OptinResponseQrInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :source
+
+    # TODO: Write general description for this method
+    # @return [TypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source'] = 'source'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source = nil, type = nil)
+      @source = source
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      source = hash.key?('source') ? hash['source'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      OptinResponseQrInfo.new(source,
+                              type)
+    end
+
+    def self.from_element(root)
+      source = XmlUtilities.from_element(root, 'source', String)
+      type = XmlUtilities.from_element(root, 'type', String)
+
+      new(source,
+          type)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'source', source)
+      XmlUtilities.add_as_subelement(doc, root, 'type', type)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source: #{@source}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source: #{@source.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_state.rb

@@ -0,0 +1,164 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Gives the state of the opt-in at the time this response was returned
+  class OptinState < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # Gives the status of the opt-in at the time this response was returned
+    # @return [OptinStatusEnum]
+    attr_accessor :optin_status
+
+    # Free-text consumer account identifier provided by the payment provider.
+    # This value will be recognizable to the user and might not be unique.
+    # @return [String]
+    attr_accessor :account_identifier
+
+    # Unique user ID provided by the payment provider. This value could be an ID
+    # that is not recognizable to the user.
+    # @return [String]
+    attr_accessor :issuer_unique_user_id
+
+    # Consumer's mobile phone number.
+    # @return [String]
+    attr_accessor :msisdn
+
+    # Trailing digits of the consumer's mobile phone number. Useful if carrier
+    # does not allow storage of full MSISDN
+    # @return [String]
+    attr_accessor :msisdn_tail
+
+    # The internal network ID of the user, as declared in `network-info` ->
+    # `network[id]`
+    # @return [String]
+    attr_accessor :network_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['optin_status'] = 'optin-status'
+      @_hash['account_identifier'] = 'account-identifier'
+      @_hash['issuer_unique_user_id'] = 'issuer-unique-user-id'
+      @_hash['msisdn'] = 'msisdn'
+      @_hash['msisdn_tail'] = 'msisdn-tail'
+      @_hash['network_id'] = 'network-id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_identifier
+        issuer_unique_user_id
+        msisdn
+        msisdn_tail
+        network_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, optin_status = nil, account_identifier = SKIP,
+                   issuer_unique_user_id = SKIP, msisdn = SKIP,
+                   msisdn_tail = SKIP, network_id = SKIP)
+      @country = country
+      @optin_status = optin_status
+      @account_identifier = account_identifier unless account_identifier == SKIP
+      @issuer_unique_user_id = issuer_unique_user_id unless issuer_unique_user_id == SKIP
+      @msisdn = msisdn unless msisdn == SKIP
+      @msisdn_tail = msisdn_tail unless msisdn_tail == SKIP
+      @network_id = network_id unless network_id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country = hash.key?('country') ? hash['country'] : nil
+      optin_status = hash.key?('optin-status') ? hash['optin-status'] : nil
+      account_identifier =
+        hash.key?('account-identifier') ? hash['account-identifier'] : SKIP
+      issuer_unique_user_id =
+        hash.key?('issuer-unique-user-id') ? hash['issuer-unique-user-id'] : SKIP
+      msisdn = hash.key?('msisdn') ? hash['msisdn'] : SKIP
+      msisdn_tail = hash.key?('msisdn-tail') ? hash['msisdn-tail'] : SKIP
+      network_id = hash.key?('network-id') ? hash['network-id'] : SKIP
+
+      # Create object from extracted values.
+      OptinState.new(country,
+                     optin_status,
+                     account_identifier,
+                     issuer_unique_user_id,
+                     msisdn,
+                     msisdn_tail,
+                     network_id)
+    end
+
+    def self.from_element(root)
+      country = XmlUtilities.from_element(root, 'country', String)
+      optin_status = XmlUtilities.from_element(root, 'optin-status', String)
+      account_identifier = XmlUtilities.from_element(root, 'account-identifier',
+                                                     String)
+      issuer_unique_user_id = XmlUtilities.from_element(root,
+                                                        'issuer-unique-user-id',
+                                                        String)
+      msisdn = XmlUtilities.from_element(root, 'msisdn', String)
+      msisdn_tail = XmlUtilities.from_element(root, 'msisdn-tail', String)
+      network_id = XmlUtilities.from_element(root, 'network-id', String)
+
+      new(country,
+          optin_status,
+          account_identifier,
+          issuer_unique_user_id,
+          msisdn,
+          msisdn_tail,
+          network_id)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-status', optin_status)
+      XmlUtilities.add_as_subelement(doc, root, 'account-identifier',
+                                     account_identifier)
+      XmlUtilities.add_as_subelement(doc, root, 'issuer-unique-user-id',
+                                     issuer_unique_user_id)
+      XmlUtilities.add_as_subelement(doc, root, 'msisdn', msisdn)
+      XmlUtilities.add_as_subelement(doc, root, 'msisdn-tail', msisdn_tail)
+      XmlUtilities.add_as_subelement(doc, root, 'network-id', network_id)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country}, optin_status: #{@optin_status}, account_identifier:"\
+      " #{@account_identifier}, issuer_unique_user_id: #{@issuer_unique_user_id}, msisdn:"\
+      " #{@msisdn}, msisdn_tail: #{@msisdn_tail}, network_id: #{@network_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country.inspect}, optin_status: #{@optin_status.inspect},"\
+      " account_identifier: #{@account_identifier.inspect}, issuer_unique_user_id:"\
+      " #{@issuer_unique_user_id.inspect}, msisdn: #{@msisdn.inspect}, msisdn_tail:"\
+      " #{@msisdn_tail.inspect}, network_id: #{@network_id.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_status_enum.rb

@@ -0,0 +1,51 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Gives the status of the opt-in at the time this response was returned
+  class OptinStatusEnum
+    OPTIN_STATUS_ENUM = [
+      # the consumer's opt-in details/authenticity is not yet been validated as
+      # being correct. For eg we have not yet verified if the user is
+      # authenticated to perform operations with the issuer by redirecting to
+      # the issuer provided UI
+      PENDINGVALIDATE = 'pending-validate'.freeze,
+
+      # all consumer and other opt-in details are validated at this point, we
+      # are simply awaiting confirmation from the caller that they wish this
+      # opt-in to be active for billing.
+      PENDINGCONFIRM = 'pending-confirm'.freeze,
+
+      # the opt-in completed as valid and available for billing.
+      ACTIVE = 'active'.freeze,
+
+      # the opt-in was closed (e.g. because of a cancel-optin call) and can no
+      # longer be used for charges, but may be used for refunds if it had
+      # previously been active.
+      CLOSED = 'closed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPTIN_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDINGVALIDATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pendingvalidate' then PENDINGVALIDATE
+      when 'pendingconfirm' then PENDINGCONFIRM
+      when 'active' then ACTIVE
+      when 'closed' then CLOSED
+      else
+        default_value
+      end
+    end
+  end
+end