bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/optin_info.rb

@@ -0,0 +1,99 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'optin-info' Response
+  class OptinInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # A list of all supported opt-in methods on a per-network basis.
+    # @return [Array[OptinInfoOptinNetwork]]
+    attr_accessor :optin_networks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['result'] = 'result'
+      @_hash['optin_networks'] = 'optin-networks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        optin_networks
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result = nil, optin_networks = SKIP)
+      @result = result
+      @optin_networks = optin_networks unless optin_networks == 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.
+      result = Result.from_hash(hash['result']) if hash['result']
+      # Parameter is an array, so we need to iterate through it
+      optin_networks = nil
+      unless hash['optin-networks'].nil?
+        optin_networks = []
+        hash['optin-networks'].each do |structure|
+          optin_networks << (OptinInfoOptinNetwork.from_hash(structure) if structure)
+        end
+      end
+
+      optin_networks = SKIP unless hash.key?('optin-networks')
+
+      # Create object from extracted values.
+      OptinInfo.new(result,
+                    optin_networks)
+    end
+
+    def self.from_element(root)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      optin_networks = XmlUtilities.from_element_to_array(root, 'optin-network',
+                                                          OptinInfoOptinNetwork)
+
+      new(result,
+          optin_networks)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_array_as_subelement(doc, root, 'optin-network',
+                                           optin_networks)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result}, optin_networks: #{@optin_networks}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result.inspect}, optin_networks: #{@optin_networks.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_info_optin_network.rb

@@ -0,0 +1,104 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # An opt-in method
+  class OptinInfoOptinNetwork < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Container element for each of the individual optin-type specific elements
+    # @return [OptinInfoOptinTypes]
+    attr_accessor :optin_types
+
+    # Container element for each of the individual optin-type specific elements
+    # @return [String]
+    attr_accessor :id
+
+    # Container element for each of the individual optin-type specific elements
+    # @return [String]
+    attr_accessor :payment_method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['optin_types'] = 'optin-types'
+      @_hash['id'] = 'id'
+      @_hash['payment_method'] = 'payment-method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        payment_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(optin_types = nil, id = SKIP, payment_method = SKIP)
+      @optin_types = optin_types
+      @id = id unless id == SKIP
+      @payment_method = payment_method unless payment_method == 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_types = OptinInfoOptinTypes.from_hash(hash['optin-types']) if hash['optin-types']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      payment_method =
+        hash.key?('payment-method') ? hash['payment-method'] : SKIP
+
+      # Create object from extracted values.
+      OptinInfoOptinNetwork.new(optin_types,
+                                id,
+                                payment_method)
+    end
+
+    def self.from_element(root)
+      optin_types = XmlUtilities.from_element(root, 'optin-types',
+                                              OptinInfoOptinTypes)
+      id = XmlUtilities.from_attribute(root, 'id', String)
+      payment_method = XmlUtilities.from_attribute(root, 'payment-method',
+                                                   String)
+
+      new(optin_types,
+          id,
+          payment_method)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'optin-types', optin_types)
+      XmlUtilities.add_as_attribute(root, 'id', id)
+      XmlUtilities.add_as_attribute(root, 'payment-method', payment_method)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} optin_types: #{@optin_types}, id: #{@id}, payment_method:"\
+      " #{@payment_method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} optin_types: #{@optin_types.inspect}, id: #{@id.inspect}, payment_method:"\
+      " #{@payment_method.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_info_optin_types.rb

@@ -0,0 +1,128 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Container element for each of the individual optin-type specific elements
+  class OptinInfoOptinTypes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # **DISCLAIMER: This API or element is use-case specific and not needed for
+    # generic usage of our payment product. Please disregard unless otherwise
+    # directed to include in your integration.**
+    # Indicates that this network supports some kind of "carrier gateway" based
+    # opt-in verification, and gives instructions on how to do so.
+    # @return [CarrierGw]
+    attr_accessor :carrier_gw
+
+    # Indicates that this network supports hosted opt-in verification.
+    # @return [Object]
+    attr_accessor :hosted
+
+    # Indicates that this network supports OTP based opt-in verification.
+    # Element contents reserved for future metadata relating to this opt-in
+    # method.
+    # @return [Object]
+    attr_accessor :otp
+
+    # **DISCLAIMER: This API or element is use-case specific and not needed for
+    # generic usage of our payment product. Please disregard unless otherwise
+    # directed to include in your integration.**
+    # Indicates that this network supports "silent MO" based opt-in
+    # verification, and gives instructions on the MO to send.
+    # @return [SilentMo]
+    attr_accessor :silent_mo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_gw'] = 'carrier-gw'
+      @_hash['hosted'] = 'hosted'
+      @_hash['otp'] = 'otp'
+      @_hash['silent_mo'] = 'silent-mo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_gw
+        hosted
+        otp
+        silent_mo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        hosted
+        otp
+      ]
+    end
+
+    def initialize(carrier_gw = SKIP, hosted = SKIP, otp = SKIP,
+                   silent_mo = SKIP)
+      @carrier_gw = carrier_gw unless carrier_gw == SKIP
+      @hosted = hosted unless hosted == SKIP
+      @otp = otp unless otp == SKIP
+      @silent_mo = silent_mo unless silent_mo == 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.
+      carrier_gw = CarrierGw.from_hash(hash['carrier-gw']) if hash['carrier-gw']
+      hosted = hash.key?('hosted') ? hash['hosted'] : SKIP
+      otp = hash.key?('otp') ? hash['otp'] : SKIP
+      silent_mo = SilentMo.from_hash(hash['silent-mo']) if hash['silent-mo']
+
+      # Create object from extracted values.
+      OptinInfoOptinTypes.new(carrier_gw,
+                              hosted,
+                              otp,
+                              silent_mo)
+    end
+
+    def self.from_element(root)
+      carrier_gw = XmlUtilities.from_element(root, 'CarrierGw', CarrierGw)
+      hosted = XmlUtilities.from_element(root, 'hosted', String)
+      otp = XmlUtilities.from_element(root, 'otp', String)
+      silent_mo = XmlUtilities.from_element(root, 'SilentMo', SilentMo)
+
+      new(carrier_gw,
+          hosted,
+          otp,
+          silent_mo)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'CarrierGw', carrier_gw)
+      XmlUtilities.add_as_subelement(doc, root, 'hosted', hosted)
+      XmlUtilities.add_as_subelement(doc, root, 'otp', otp)
+      XmlUtilities.add_as_subelement(doc, root, 'SilentMo', silent_mo)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_gw: #{@carrier_gw}, hosted: #{@hosted}, otp: #{@otp}, silent_mo:"\
+      " #{@silent_mo}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_gw: #{@carrier_gw.inspect}, hosted: #{@hosted.inspect}, otp:"\
+      " #{@otp.inspect}, silent_mo: #{@silent_mo.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_network.rb

@@ -0,0 +1,115 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Specifies the set of networks to which the opt-in request is restricted.
+  class OptinNetwork < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the network.
+    # @return [String]
+    attr_accessor :id
+
+    # Mobile country code (MCC) of the device, as defined by [ITU
+    # standards](http://en.wikipedia.org/wiki/Mobile_country_code).
+    # @return [String]
+    attr_accessor :mcc
+
+    # Mobile network code (MNC) of the device.
+    # @return [String]
+    attr_accessor :mnc
+
+    # Optional name for the network. Used only for debugging purposes; not
+    # stored or validated.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['mcc'] = 'mcc'
+      @_hash['mnc'] = 'mnc'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        mcc
+        mnc
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, mcc = SKIP, mnc = SKIP, name = SKIP)
+      @id = id unless id == SKIP
+      @mcc = mcc unless mcc == SKIP
+      @mnc = mnc unless mnc == SKIP
+      @name = name unless name == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      mcc = hash.key?('mcc') ? hash['mcc'] : SKIP
+      mnc = hash.key?('mnc') ? hash['mnc'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      OptinNetwork.new(id,
+                       mcc,
+                       mnc,
+                       name)
+    end
+
+    def self.from_element(root)
+      id = XmlUtilities.from_attribute(root, 'id', String)
+      mcc = XmlUtilities.from_attribute(root, 'mcc', String)
+      mnc = XmlUtilities.from_attribute(root, 'mnc', String)
+      name = XmlUtilities.from_attribute(root, 'name', String)
+
+      new(id,
+          mcc,
+          mnc,
+          name)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'id', id)
+      XmlUtilities.add_as_attribute(root, 'mcc', mcc)
+      XmlUtilities.add_as_attribute(root, 'mnc', mnc)
+      XmlUtilities.add_as_attribute(root, 'name', name)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, mcc: #{@mcc}, mnc: #{@mnc}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, mcc: #{@mcc.inspect}, mnc: #{@mnc.inspect}, name:"\
+      " #{@name.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_purpose_enum.rb

@@ -0,0 +1,62 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Purpose of the Opt-In Defines the behavioral scope and validity of an
+  # opt-in. The value determines how long the user’s authorization remains valid
+  # and under what conditions it may be reused. Supported Values: -
+  # standing-approval: Default opt-in behavior. Valid for subsequent charges
+  # until explicitly revoked by the user. - single-transaction: Valid for a
+  # single charge only. Any attempt to reuse this opt-in will result in an
+  # error. - subscription: Valid for recurring charges as part of a single
+  # subscription. Remains valid until revoked. - standing-approval-mandate:
+  # Valid for transaction behaviors defined by the user for a specific
+  # processing bank and merchant. Must be used in conjunction with
+  # mandate-constraints. - subscription-mandate: Valid for subsequent charges
+  # until revoked. It indicates that the mandate will be used for recurring
+  # charges as part of a single subscription. Must be used with Mandate
+  # Constraints and requires a Product SKU, which must match between opt-in and
+  # charge.
+  class OptinPurposeEnum
+    OPTIN_PURPOSE_ENUM = [
+      # TODO: Write general description for STANDINGAPPROVAL
+      STANDINGAPPROVAL = 'standing-approval'.freeze,
+
+      # TODO: Write general description for SINGLETRANSACTION
+      SINGLETRANSACTION = 'single-transaction'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'subscription'.freeze,
+
+      # TODO: Write general description for STANDINGAPPROVALMANDATE
+      STANDINGAPPROVALMANDATE = 'standing-approval-mandate'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTIONMANDATE
+      SUBSCRIPTIONMANDATE = 'subscription-mandate'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPTIN_PURPOSE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = STANDINGAPPROVAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'standingapproval' then STANDINGAPPROVAL
+      when 'singletransaction' then SINGLETRANSACTION
+      when 'subscription' then SUBSCRIPTION
+      when 'standingapprovalmandate' then STANDINGAPPROVALMANDATE
+      when 'subscriptionmandate' then SUBSCRIPTIONMANDATE
+      else
+        default_value
+      end
+    end
+  end
+end