bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/business_details.rb

@@ -0,0 +1,209 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Container element for business details
+  class BusinessDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address of this business. Please provide full address details
+    # @return [String]
+    attr_accessor :business_address
+
+    # Contact phone number of this business
+    # @return [String]
+    attr_accessor :business_contact_number
+
+    # Full name of point of contact for this business
+    # @return [String]
+    attr_accessor :business_contact_person
+
+    # Legal name of business
+    # @return [String]
+    attr_accessor :business_legal_name
+
+    # A unique identifier and may be either a state tax ID number or a
+    # registered identification number
+    # @return [String]
+    attr_accessor :business_registration_number
+
+    # The name under which the business operates
+    # @return [String]
+    attr_accessor :doing_business_as
+
+    # 4 digit number used by to classify business by market segment
+    # @return [String]
+    attr_accessor :merchant_category_code
+
+    # Category of business
+    # @return [String]
+    attr_accessor :business_category
+
+    # Business website url
+    # @return [String]
+    attr_accessor :business_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['business_address'] = 'business-address'
+      @_hash['business_contact_number'] = 'business-contact-number'
+      @_hash['business_contact_person'] = 'business-contact-person'
+      @_hash['business_legal_name'] = 'business-legal-name'
+      @_hash['business_registration_number'] = 'business-registration-number'
+      @_hash['doing_business_as'] = 'doing-business-as'
+      @_hash['merchant_category_code'] = 'merchant-category-code'
+      @_hash['business_category'] = 'business-category'
+      @_hash['business_url'] = 'business-url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        business_category
+        business_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(business_address = nil, business_contact_number = nil,
+                   business_contact_person = nil, business_legal_name = nil,
+                   business_registration_number = nil, doing_business_as = nil,
+                   merchant_category_code = nil, business_category = SKIP,
+                   business_url = SKIP)
+      @business_address = business_address
+      @business_contact_number = business_contact_number
+      @business_contact_person = business_contact_person
+      @business_legal_name = business_legal_name
+      @business_registration_number = business_registration_number
+      @doing_business_as = doing_business_as
+      @merchant_category_code = merchant_category_code
+      @business_category = business_category unless business_category == SKIP
+      @business_url = business_url unless business_url == 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.
+      business_address =
+        hash.key?('business-address') ? hash['business-address'] : nil
+      business_contact_number =
+        hash.key?('business-contact-number') ? hash['business-contact-number'] : nil
+      business_contact_person =
+        hash.key?('business-contact-person') ? hash['business-contact-person'] : nil
+      business_legal_name =
+        hash.key?('business-legal-name') ? hash['business-legal-name'] : nil
+      business_registration_number =
+        hash.key?('business-registration-number') ? hash['business-registration-number'] : nil
+      doing_business_as =
+        hash.key?('doing-business-as') ? hash['doing-business-as'] : nil
+      merchant_category_code =
+        hash.key?('merchant-category-code') ? hash['merchant-category-code'] : nil
+      business_category =
+        hash.key?('business-category') ? hash['business-category'] : SKIP
+      business_url = hash.key?('business-url') ? hash['business-url'] : SKIP
+
+      # Create object from extracted values.
+      BusinessDetails.new(business_address,
+                          business_contact_number,
+                          business_contact_person,
+                          business_legal_name,
+                          business_registration_number,
+                          doing_business_as,
+                          merchant_category_code,
+                          business_category,
+                          business_url)
+    end
+
+    def self.from_element(root)
+      business_address = XmlUtilities.from_element(root, 'business-address',
+                                                   String)
+      business_contact_number = XmlUtilities.from_element(
+        root, 'business-contact-number', String
+      )
+      business_contact_person = XmlUtilities.from_element(
+        root, 'business-contact-person', String
+      )
+      business_legal_name = XmlUtilities.from_element(root,
+                                                      'business-legal-name',
+                                                      String)
+      business_registration_number = XmlUtilities.from_element(
+        root, 'business-registration-number', String
+      )
+      doing_business_as = XmlUtilities.from_element(root, 'doing-business-as',
+                                                    String)
+      merchant_category_code = XmlUtilities.from_element(
+        root, 'merchant-category-code', String
+      )
+      business_category = XmlUtilities.from_element(root, 'business-category',
+                                                    String)
+      business_url = XmlUtilities.from_element(root, 'business-url', String)
+
+      new(business_address,
+          business_contact_number,
+          business_contact_person,
+          business_legal_name,
+          business_registration_number,
+          doing_business_as,
+          merchant_category_code,
+          business_category,
+          business_url)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'business-address',
+                                     business_address)
+      XmlUtilities.add_as_subelement(doc, root, 'business-contact-number',
+                                     business_contact_number)
+      XmlUtilities.add_as_subelement(doc, root, 'business-contact-person',
+                                     business_contact_person)
+      XmlUtilities.add_as_subelement(doc, root, 'business-legal-name',
+                                     business_legal_name)
+      XmlUtilities.add_as_subelement(doc, root, 'business-registration-number',
+                                     business_registration_number)
+      XmlUtilities.add_as_subelement(doc, root, 'doing-business-as',
+                                     doing_business_as)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-category-code',
+                                     merchant_category_code)
+      XmlUtilities.add_as_subelement(doc, root, 'business-category',
+                                     business_category)
+      XmlUtilities.add_as_subelement(doc, root, 'business-url', business_url)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} business_address: #{@business_address}, business_contact_number:"\
+      " #{@business_contact_number}, business_contact_person: #{@business_contact_person},"\
+      " business_legal_name: #{@business_legal_name}, business_registration_number:"\
+      " #{@business_registration_number}, doing_business_as: #{@doing_business_as},"\
+      " merchant_category_code: #{@merchant_category_code}, business_category:"\
+      " #{@business_category}, business_url: #{@business_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} business_address: #{@business_address.inspect}, business_contact_number:"\
+      " #{@business_contact_number.inspect}, business_contact_person:"\
+      " #{@business_contact_person.inspect}, business_legal_name: #{@business_legal_name.inspect},"\
+      " business_registration_number: #{@business_registration_number.inspect}, doing_business_as:"\
+      " #{@doing_business_as.inspect}, merchant_category_code: #{@merchant_category_code.inspect},"\
+      " business_category: #{@business_category.inspect}, business_url: #{@business_url.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/cancel_optin_request.rb

@@ -0,0 +1,123 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'cancel-optin' Request - General Parameters
+  class CancelOptinRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned unique request ID.
+    # Multiple requests received with the same merchant-request-id will be
+    # handled idempotently within the idempotency window.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # Merchant-assigned unique opt-in ID.
+    # @return [String]
+    attr_accessor :merchant_optin_id
+
+    # Boku-assigned unique opt-in ID for the consumer.
+    # @return [String]
+    attr_accessor :optin_id
+
+    # 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['merchant_optin_id'] = 'merchant-optin-id'
+      @_hash['optin_id'] = 'optin-id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_optin_id
+        optin_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id = nil, merchant_request_id = nil,
+                   merchant_optin_id = SKIP, optin_id = SKIP)
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+      @merchant_optin_id = merchant_optin_id unless merchant_optin_id == SKIP
+      @optin_id = optin_id unless optin_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.
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : nil
+      merchant_optin_id =
+        hash.key?('merchant-optin-id') ? hash['merchant-optin-id'] : SKIP
+      optin_id = hash.key?('optin-id') ? hash['optin-id'] : SKIP
+
+      # Create object from extracted values.
+      CancelOptinRequest.new(merchant_id,
+                             merchant_request_id,
+                             merchant_optin_id,
+                             optin_id)
+    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)
+      merchant_optin_id = XmlUtilities.from_element(root, 'merchant-optin-id',
+                                                    String)
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+
+      new(merchant_id,
+          merchant_request_id,
+          merchant_optin_id,
+          optin_id)
+    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, 'merchant-optin-id',
+                                     merchant_optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-id', optin_id)
+
+      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},"\
+      " merchant_optin_id: #{@merchant_optin_id}, optin_id: #{@optin_id}>"
+    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}, merchant_optin_id: #{@merchant_optin_id.inspect},"\
+      " optin_id: #{@optin_id.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/cancel_optin_response.rb

@@ -0,0 +1,143 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'cancel-optin' Response - General Elements
+  class CancelOptinResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned request ID.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # Boku-assigned unique opt-in ID for the consumer.
+    # @return [String]
+    attr_accessor :optin_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
+
+    # 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
+
+    # 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['optin_id'] = 'optin-id'
+      @_hash['result'] = 'result'
+      @_hash['optin_state'] = 'optin-state'
+      @_hash['optin_type'] = 'optin-type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        optin_state
+        optin_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id = nil, merchant_request_id = nil, optin_id = nil,
+                   result = nil, optin_state = SKIP, optin_type = SKIP)
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+      @optin_id = optin_id
+      @result = result
+      @optin_state = optin_state unless optin_state == SKIP
+      @optin_type = optin_type unless optin_type == 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
+      optin_id = hash.key?('optin-id') ? hash['optin-id'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+      optin_state = OptinState.from_hash(hash['optin-state']) if hash['optin-state']
+      optin_type = hash.key?('optin-type') ? hash['optin-type'] : SKIP
+
+      # Create object from extracted values.
+      CancelOptinResponse.new(merchant_id,
+                              merchant_request_id,
+                              optin_id,
+                              result,
+                              optin_state,
+                              optin_type)
+    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)
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      optin_state = XmlUtilities.from_element(root, 'optin-state', OptinState)
+      optin_type = XmlUtilities.from_element(root, 'optin-type', String)
+
+      new(merchant_id,
+          merchant_request_id,
+          optin_id,
+          result,
+          optin_state,
+          optin_type)
+    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, 'optin-id', optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-state', optin_state)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-type', optin_type)
+
+      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},"\
+      " optin_id: #{@optin_id}, result: #{@result}, optin_state: #{@optin_state}, optin_type:"\
+      " #{@optin_type}>"
+    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}, optin_id: #{@optin_id.inspect}, result:"\
+      " #{@result.inspect}, optin_state: #{@optin_state.inspect}, optin_type:"\
+      " #{@optin_type.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/carrier_gw.rb

@@ -0,0 +1,82 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # **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.
+  class CarrierGw < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Describes a HTTP call to be made from the client device via cellular data
+    # network as part of the opt-in.
+    # If absent from an optin-info carrier-gw element, indicates that though
+    # carrier-gw is supported, the URL must be generated on a per-request basis
+    # via a call to `optin`.
+    # @return [ClientCall]
+    attr_accessor :client_call
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_call'] = 'client-call'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_call = nil)
+      @client_call = client_call
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      client_call = ClientCall.from_hash(hash['client-call']) if hash['client-call']
+
+      # Create object from extracted values.
+      CarrierGw.new(client_call)
+    end
+
+    def self.from_element(root)
+      client_call = XmlUtilities.from_element(root, 'ClientCall', ClientCall)
+
+      new(client_call)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'ClientCall', client_call)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_call: #{@client_call}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_call: #{@client_call.inspect}>"
+    end
+  end
+end