bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/optin_request.rb

@@ -0,0 +1,338 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'optin' Request - General Parameters
+  class OptinRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Two-letter country code in ISO 3166-1 alpha-2 format (e.g., `US`, `GB`,
+    # `DE`).
+    # @return [String]
+    attr_accessor :country
+
+    # Unique identifier for the consumer, assigned by the merchant.
+    # @return [String]
+    attr_accessor :merchant_consumer_id
+
+    # Boku assigned Merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant assigned unique request ID. Multiple requests received with the
+    # same `requestId` will be handled idempotently within the configured
+    # idempotency window.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # Specifies which method to use to perform the opt-in.
+    # @return [OptinTypeEnum]
+    attr_accessor :optin_type
+
+    # A container element that allows the merchant to restrict which networks
+    # are permitted for this request.
+    # - If omitted, all networks enabled on the merchant account will be
+    # allowed.
+    # - If specified, only the networks listed and enabled for the merchant will
+    # be permitted.
+    # @return [OptinAcceptNetworks]
+    attr_accessor :accept_networks
+
+    # IP address of the end user at the time of opt-in. Used to support fraud
+    # detection through internal risk assessments and partner-specific
+    # decisioning. Supports both IPv4 and IPv6 formats.
+    # @return [String]
+    attr_accessor :consumer_ip_address
+
+    # Container for parameters required _**only**_ when `optin-type` is
+    # `hosted`.
+    # @return [OptinRequestHosted]
+    attr_accessor :hosted
+
+    # Merchant assigned unique optin ID (only supported for hosted and otp optin
+    # types). _Optional. However, if provided, it must remain the same for
+    # idempotent requests._
+    # @return [String]
+    attr_accessor :merchant_optin_id
+
+    # Consumer’s mobile phone number.
+    # @return [String]
+    attr_accessor :msisdn
+
+    # URL to which Boku will send a notification once the opt-in is ready for
+    # the `validate-optin` call.
+    # @return [String]
+    attr_accessor :notification_url
+
+    # Describes the optin or product type associated with the request—for
+    # example, a free trial, subscription, or other merchant-defined context.
+    # @return [String]
+    attr_accessor :optin_description
+
+    # The payment method selected by the consumer. Each wallet provider is
+    # represented as a distinct payment method. A full list of supported values
+    # is available upon request from your Boku integration team.
+    # @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
+
+    # Merchant assigned service name to display in the optin and verify device
+    # SMS messages. This field is only applicable when `optin-type` is `otp`.
+    # @return [String]
+    attr_accessor :service_name
+
+    # Country where the operation is initiated (e.g., the storefront location),
+    # specified using the ISO 3166-1 alpha-2 country code format.
+    # @return [String]
+    attr_accessor :source_country
+
+    # Content defining the specific terms and conditions associated with this
+    # opt-in. This may include pricing details or user consent requirements
+    # presented to the end user during the opt-in flow.
+    # @return [OptinTerms]
+    attr_accessor :terms
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['merchant_consumer_id'] = 'merchant-consumer-id'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['optin_type'] = 'optin-type'
+      @_hash['accept_networks'] = 'accept-networks'
+      @_hash['consumer_ip_address'] = 'consumer-ip-address'
+      @_hash['hosted'] = 'hosted'
+      @_hash['merchant_optin_id'] = 'merchant-optin-id'
+      @_hash['msisdn'] = 'msisdn'
+      @_hash['notification_url'] = 'notification-url'
+      @_hash['optin_description'] = 'optin-description'
+      @_hash['payment_method'] = 'payment-method'
+      @_hash['seller_of_record'] = 'seller-of-record'
+      @_hash['service_name'] = 'service-name'
+      @_hash['source_country'] = 'source-country'
+      @_hash['terms'] = 'terms'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accept_networks
+        consumer_ip_address
+        hosted
+        merchant_optin_id
+        msisdn
+        notification_url
+        optin_description
+        payment_method
+        seller_of_record
+        service_name
+        source_country
+        terms
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, merchant_consumer_id = nil, merchant_id = nil,
+                   merchant_request_id = nil, optin_type = nil,
+                   accept_networks = SKIP, consumer_ip_address = SKIP,
+                   hosted = SKIP, merchant_optin_id = SKIP, msisdn = SKIP,
+                   notification_url = SKIP, optin_description = SKIP,
+                   payment_method = SKIP, seller_of_record = SKIP,
+                   service_name = SKIP, source_country = SKIP, terms = SKIP)
+      @country = country
+      @merchant_consumer_id = merchant_consumer_id
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+      @optin_type = optin_type
+      @accept_networks = accept_networks unless accept_networks == SKIP
+      @consumer_ip_address = consumer_ip_address unless consumer_ip_address == SKIP
+      @hosted = hosted unless hosted == SKIP
+      @merchant_optin_id = merchant_optin_id unless merchant_optin_id == SKIP
+      @msisdn = msisdn unless msisdn == SKIP
+      @notification_url = notification_url unless notification_url == SKIP
+      @optin_description = optin_description unless optin_description == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @seller_of_record = seller_of_record unless seller_of_record == SKIP
+      @service_name = service_name unless service_name == SKIP
+      @source_country = source_country unless source_country == SKIP
+      @terms = terms unless terms == 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
+      merchant_consumer_id =
+        hash.key?('merchant-consumer-id') ? hash['merchant-consumer-id'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : nil
+      optin_type = hash.key?('optin-type') ? hash['optin-type'] : nil
+      accept_networks = OptinAcceptNetworks.from_hash(hash['accept-networks']) if
+        hash['accept-networks']
+      consumer_ip_address =
+        hash.key?('consumer-ip-address') ? hash['consumer-ip-address'] : SKIP
+      hosted = OptinRequestHosted.from_hash(hash['hosted']) if hash['hosted']
+      merchant_optin_id =
+        hash.key?('merchant-optin-id') ? hash['merchant-optin-id'] : SKIP
+      msisdn = hash.key?('msisdn') ? hash['msisdn'] : SKIP
+      notification_url =
+        hash.key?('notification-url') ? hash['notification-url'] : SKIP
+      optin_description =
+        hash.key?('optin-description') ? hash['optin-description'] : 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']
+      service_name = hash.key?('service-name') ? hash['service-name'] : SKIP
+      source_country =
+        hash.key?('source-country') ? hash['source-country'] : SKIP
+      terms = OptinTerms.from_hash(hash['terms']) if hash['terms']
+
+      # Create object from extracted values.
+      OptinRequest.new(country,
+                       merchant_consumer_id,
+                       merchant_id,
+                       merchant_request_id,
+                       optin_type,
+                       accept_networks,
+                       consumer_ip_address,
+                       hosted,
+                       merchant_optin_id,
+                       msisdn,
+                       notification_url,
+                       optin_description,
+                       payment_method,
+                       seller_of_record,
+                       service_name,
+                       source_country,
+                       terms)
+    end
+
+    def self.from_element(root)
+      country = XmlUtilities.from_element(root, 'country', String)
+      merchant_consumer_id = XmlUtilities.from_element(root,
+                                                       'merchant-consumer-id',
+                                                       String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      optin_type = XmlUtilities.from_element(root, 'optin-type', String)
+      accept_networks = XmlUtilities.from_element(root, 'accept-networks',
+                                                  OptinAcceptNetworks)
+      consumer_ip_address = XmlUtilities.from_element(root,
+                                                      'consumer-ip-address',
+                                                      String)
+      hosted = XmlUtilities.from_element(root, 'hosted', OptinRequestHosted)
+      merchant_optin_id = XmlUtilities.from_element(root, 'merchant-optin-id',
+                                                    String)
+      msisdn = XmlUtilities.from_element(root, 'msisdn', String)
+      notification_url = XmlUtilities.from_element(root, 'notification-url',
+                                                   String)
+      optin_description = XmlUtilities.from_element(root, 'optin-description',
+                                                    String)
+      payment_method = XmlUtilities.from_element(root, 'payment-method', String)
+      seller_of_record = XmlUtilities.from_element(root, 'seller-of-record',
+                                                   SellerOfRecord)
+      service_name = XmlUtilities.from_element(root, 'service-name', String)
+      source_country = XmlUtilities.from_element(root, 'source-country', String)
+      terms = XmlUtilities.from_element(root, 'terms', OptinTerms)
+
+      new(country,
+          merchant_consumer_id,
+          merchant_id,
+          merchant_request_id,
+          optin_type,
+          accept_networks,
+          consumer_ip_address,
+          hosted,
+          merchant_optin_id,
+          msisdn,
+          notification_url,
+          optin_description,
+          payment_method,
+          seller_of_record,
+          service_name,
+          source_country,
+          terms)
+    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, 'merchant-consumer-id',
+                                     merchant_consumer_id)
+      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-type', optin_type)
+      XmlUtilities.add_as_subelement(doc, root, 'accept-networks',
+                                     accept_networks)
+      XmlUtilities.add_as_subelement(doc, root, 'consumer-ip-address',
+                                     consumer_ip_address)
+      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, 'msisdn', msisdn)
+      XmlUtilities.add_as_subelement(doc, root, 'notification-url',
+                                     notification_url)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-description',
+                                     optin_description)
+      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, 'service-name', service_name)
+      XmlUtilities.add_as_subelement(doc, root, 'source-country',
+                                     source_country)
+      XmlUtilities.add_as_subelement(doc, root, 'terms', terms)
+
+      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}, merchant_consumer_id: #{@merchant_consumer_id},"\
+      " merchant_id: #{@merchant_id}, merchant_request_id: #{@merchant_request_id}, optin_type:"\
+      " #{@optin_type}, accept_networks: #{@accept_networks}, consumer_ip_address:"\
+      " #{@consumer_ip_address}, hosted: #{@hosted}, merchant_optin_id: #{@merchant_optin_id},"\
+      " msisdn: #{@msisdn}, notification_url: #{@notification_url}, optin_description:"\
+      " #{@optin_description}, payment_method: #{@payment_method}, seller_of_record:"\
+      " #{@seller_of_record}, service_name: #{@service_name}, source_country: #{@source_country},"\
+      " terms: #{@terms}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country.inspect}, merchant_consumer_id:"\
+      " #{@merchant_consumer_id.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " merchant_request_id: #{@merchant_request_id.inspect}, optin_type: #{@optin_type.inspect},"\
+      " accept_networks: #{@accept_networks.inspect}, consumer_ip_address:"\
+      " #{@consumer_ip_address.inspect}, hosted: #{@hosted.inspect}, merchant_optin_id:"\
+      " #{@merchant_optin_id.inspect}, msisdn: #{@msisdn.inspect}, notification_url:"\
+      " #{@notification_url.inspect}, optin_description: #{@optin_description.inspect},"\
+      " payment_method: #{@payment_method.inspect}, seller_of_record:"\
+      " #{@seller_of_record.inspect}, service_name: #{@service_name.inspect}, source_country:"\
+      " #{@source_country.inspect}, terms: #{@terms.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_request_hosted.rb

@@ -0,0 +1,110 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Container for parameters required _**only**_ when `optin-type` is `hosted`.
+  class OptinRequestHosted < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Supplies the URL for Boku to redirect the consumer back to the merchant UI
+    # to complete authentication.
+    # @return [String]
+    attr_accessor :forward_url
+
+    # Specifies the format and content of the QR code information returned for
+    # issuers that support QR-based processing.
+    # @return [OptinRequestQrInfo]
+    attr_accessor :qr_info
+
+    # True if a mobile-optimized opt-in flow should be used for this request,
+    # false otherwise.
+    # Example: A non-mobile-optimized flow could display a QR code on the user's
+    # mobile. The user would be unable to scan the QR code because they are
+    # already on their mobile.
+    # A mobile-optimized flow could display a mobile login page to the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_mobile_flow
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['forward_url'] = 'forward-url'
+      @_hash['qr_info'] = 'qr-info'
+      @_hash['use_mobile_flow'] = 'use-mobile-flow'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        qr_info
+        use_mobile_flow
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(forward_url = nil, qr_info = SKIP, use_mobile_flow = false)
+      @forward_url = forward_url
+      @qr_info = qr_info unless qr_info == SKIP
+      @use_mobile_flow = use_mobile_flow unless use_mobile_flow == 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.
+      forward_url = hash.key?('forward-url') ? hash['forward-url'] : nil
+      qr_info = OptinRequestQrInfo.from_hash(hash['qr-info']) if hash['qr-info']
+      use_mobile_flow = hash['use-mobile-flow'] ||= false
+
+      # Create object from extracted values.
+      OptinRequestHosted.new(forward_url,
+                             qr_info,
+                             use_mobile_flow)
+    end
+
+    def self.from_element(root)
+      forward_url = XmlUtilities.from_element(root, 'forward-url', String)
+      qr_info = XmlUtilities.from_element(root, 'qr-info', OptinRequestQrInfo)
+      use_mobile_flow = XmlUtilities.from_element(root, 'use-mobile-flow',
+                                                  TrueClass)
+
+      new(forward_url,
+          qr_info,
+          use_mobile_flow)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'forward-url', forward_url)
+      XmlUtilities.add_as_subelement(doc, root, 'qr-info', qr_info)
+      XmlUtilities.add_as_subelement(doc, root, 'use-mobile-flow',
+                                     use_mobile_flow)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} forward_url: #{@forward_url}, qr_info: #{@qr_info}, use_mobile_flow:"\
+      " #{@use_mobile_flow}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} forward_url: #{@forward_url.inspect}, qr_info: #{@qr_info.inspect},"\
+      " use_mobile_flow: #{@use_mobile_flow.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_request_qr_info.rb

@@ -0,0 +1,75 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Specifies the format and content of the QR code information returned for
+  # issuers that support QR-based processing.
+  class OptinRequestQrInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = nil)
+      @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.
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      OptinRequestQrInfo.new(type)
+    end
+
+    def self.from_element(root)
+      type = XmlUtilities.from_element(root, 'type', String)
+
+      new(type)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      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} type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}>"
+    end
+  end
+end