bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/optin_terms.rb

@@ -0,0 +1,214 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module BokuDirectPaymentsApi
+  # 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.
+  class OptinTerms < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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.
+    # @return [OptinPurposeEnum]
+    attr_accessor :optin_purpose
+
+    # Total charge amount, inclusive of tax.
+    # - If provided and `optin-purpose` is set to `single-transaction`, the
+    # subsequent charge must match this exact amount.
+    #     
+    # - If omitted or if `optin-purpose` is not `single-transaction`, any valid
+    # amount may be used in the subsequent charge.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Three-letter currency code as defined by ISO 4217.
+    # @return [String]
+    attr_accessor :currency
+
+    # Defines transaction behavior constraints associated with a mandate. This
+    # field is used to specify conditions under which transactions may be
+    # processed.
+    # Applicable only when `optin-purpose` is set to `standing-approval-mandate`
+    # or `subscription-mandate`and `optin-type` is set to `hosted`.
+    # @return [Array[MandateConstraint]]
+    attr_accessor :mandate_constraints
+
+    # A merchant-defined identifier for the subscription product. Required only
+    # when the optin purpose is 'subscription-mandate'. The SKU used in the
+    # charge request must match the one provided during optin.
+    # @return [String]
+    attr_accessor :product_sku
+
+    # Time this opt-in will be valid until in UTC time zone (`"YYYY-MM-DD
+    # hh:mm:ss"`) for `"single-transaction"`, `"subscription"`, and
+    # `"subscription-mandate"` opt-in purposes.
+    # **Single Transaction**
+    # - If present, opt-in will be valid between time of request and specified
+    # time.
+    # - If absent, opt-in will be valid between time of request and time of
+    # request + 24 hours.
+    # **Subscription**
+    # - If present, opt-in will be valid until specified time. _While optional,
+    # this field is required for some payment methods_.
+    # **Subscription-Mandate**
+    # - If present, opt-in will be valid until specified time.
+    # - NOTE:  Enforcement of mandate expiry is the responsibility of the
+    # issuer. Boku does not proactively cancel the opt-in or block charges after
+    # this date, but any charge attempted post-expiry will typically be declined
+    # by the issuer and surfaced as a failed transaction.
+    # This element is not applicable to `"standing-approval"` opt-in purpose.
+    # @return [DateTime]
+    attr_accessor :valid_through
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['optin_purpose'] = 'optin-purpose'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['mandate_constraints'] = 'mandate-constraints'
+      @_hash['product_sku'] = 'product-sku'
+      @_hash['valid_through'] = 'valid-through'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        currency
+        mandate_constraints
+        product_sku
+        valid_through
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(optin_purpose = nil, amount = SKIP, currency = SKIP,
+                   mandate_constraints = SKIP, product_sku = SKIP,
+                   valid_through = SKIP)
+      @optin_purpose = optin_purpose
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @mandate_constraints = mandate_constraints unless mandate_constraints == SKIP
+      @product_sku = product_sku unless product_sku == SKIP
+      @valid_through = valid_through unless valid_through == 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_purpose = hash.key?('optin-purpose') ? hash['optin-purpose'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      mandate_constraints = nil
+      unless hash['mandate-constraints'].nil?
+        mandate_constraints = []
+        hash['mandate-constraints'].each do |structure|
+          mandate_constraints << (MandateConstraint.from_hash(structure) if structure)
+        end
+      end
+
+      mandate_constraints = SKIP unless hash.key?('mandate-constraints')
+      product_sku = hash.key?('product-sku') ? hash['product-sku'] : SKIP
+      valid_through = if hash.key?('valid-through')
+                        (DateTimeHelper.from_rfc3339(hash['valid-through']) if hash['valid-through'])
+                      else
+                        SKIP
+                      end
+
+      # Create object from extracted values.
+      OptinTerms.new(optin_purpose,
+                     amount,
+                     currency,
+                     mandate_constraints,
+                     product_sku,
+                     valid_through)
+    end
+
+    def to_custom_valid_through
+      DateTimeHelper.to_rfc3339(valid_through)
+    end
+
+    def self.from_element(root)
+      optin_purpose = XmlUtilities.from_element(root, 'optin-purpose', String)
+      amount = XmlUtilities.from_element(root, 'amount', Float)
+      currency = XmlUtilities.from_element(root, 'currency', String)
+      mandate_constraints = XmlUtilities.from_element_to_array(
+        root, 'mandate-constraint', MandateConstraint,
+        wrapping_element_name: 'mandate-constraints'
+      )
+      product_sku = XmlUtilities.from_element(root, 'product-sku', String)
+      valid_through = XmlUtilities.from_element(root, 'valid-through', String,
+                                                datetime_format: 'rfc3339')
+
+      new(optin_purpose,
+          amount,
+          currency,
+          mandate_constraints,
+          product_sku,
+          valid_through)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'optin-purpose', optin_purpose)
+      XmlUtilities.add_as_subelement(doc, root, 'amount', amount)
+      XmlUtilities.add_as_subelement(doc, root, 'currency', currency)
+      XmlUtilities.add_array_as_subelement(
+        doc, root, 'mandate-constraint', mandate_constraints,
+        wrapping_element_name: 'mandate-constraints'
+      )
+      XmlUtilities.add_as_subelement(doc, root, 'product-sku', product_sku)
+      XmlUtilities.add_as_subelement(doc, root, 'valid-through', valid_through,
+                                     datetime_format: 'rfc3339')
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} optin_purpose: #{@optin_purpose}, amount: #{@amount}, currency:"\
+      " #{@currency}, mandate_constraints: #{@mandate_constraints}, product_sku: #{@product_sku},"\
+      " valid_through: #{@valid_through}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} optin_purpose: #{@optin_purpose.inspect}, amount: #{@amount.inspect},"\
+      " currency: #{@currency.inspect}, mandate_constraints: #{@mandate_constraints.inspect},"\
+      " product_sku: #{@product_sku.inspect}, valid_through: #{@valid_through.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/optin_type_enum.rb

@@ -0,0 +1,45 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Specifies which method to use to perform the opt-in.
+  class OptinTypeEnum
+    OPTIN_TYPE_ENUM = [
+      # Sends a one-time PIN to the consumer via SMS, confirmed via
+      # `confirm-optin`.
+      OTP = 'otp'.freeze,
+
+      # Verifies the consumer via a ping through the carrier gateway.
+      CARRIERGW = 'carrier-gw'.freeze,
+
+      # Redirects the consumer to an issuer-provided UI for verification.
+      HOSTED = 'hosted'.freeze,
+
+      # Verifies the consumer by sending a silent SMS from the device.
+      SILENTMO = 'silent-mo'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPTIN_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = OTP)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'otp' then OTP
+      when 'carriergw' then CARRIERGW
+      when 'hosted' then HOSTED
+      when 'silentmo' then SILENTMO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/payment_method_status_enum.rb

@@ -0,0 +1,44 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # The status of Payment Method
+  class PaymentMethodStatusEnum
+    PAYMENT_METHOD_STATUS_ENUM = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for APPROVED
+      APPROVED = 'approved'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze,
+
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'suspended'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_METHOD_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'approved' then APPROVED
+      when 'rejected' then REJECTED
+      when 'suspended' then SUSPENDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/period.rb

@@ -0,0 +1,89 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # The period of the subscription (at which interval the consumer is being
+  # charged)
+  class Period < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The count of units in the period
+    # @return [Integer]
+    attr_accessor :count
+
+    # A period is comprised of a unit of time (day, week, month, year) and a
+    # count (how many units per period).
+    # For example, to define a "3 month" period one would set the unit as
+    # "month" and the count as "3".
+    # @return [PeriodUnitEnum]
+    attr_accessor :unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['unit'] = 'unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(count = nil, unit = nil)
+      @count = count
+      @unit = unit
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      count = hash.key?('count') ? hash['count'] : nil
+      unit = hash.key?('unit') ? hash['unit'] : nil
+
+      # Create object from extracted values.
+      Period.new(count,
+                 unit)
+    end
+
+    def self.from_element(root)
+      count = XmlUtilities.from_attribute(root, 'count', Integer)
+      unit = XmlUtilities.from_attribute(root, 'unit', String)
+
+      new(count,
+          unit)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'count', count)
+      XmlUtilities.add_as_attribute(root, 'unit', unit)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count}, unit: #{@unit}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count.inspect}, unit: #{@unit.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/period_unit_enum.rb

@@ -0,0 +1,46 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # A period is comprised of a unit of time (day, week, month, year) and a count
+  # (how many units per period). For example, to define a "3 month" period one
+  # would set the unit as "month" and the count as "3".
+  class PeriodUnitEnum
+    PERIOD_UNIT_ENUM = [
+      # TODO: Write general description for DAY
+      DAY = 'day'.freeze,
+
+      # TODO: Write general description for WEEK
+      WEEK = 'week'.freeze,
+
+      # TODO: Write general description for MONTH
+      MONTH = 'month'.freeze,
+
+      # TODO: Write general description for YEAR
+      YEAR = 'year'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PERIOD_UNIT_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'week' then WEEK
+      when 'month' then MONTH
+      when 'year' then YEAR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/query_charge_request.rb

@@ -0,0 +1,149 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'query-charge' Request
+  class QueryChargeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Country code within which to search for charges
+    # @return [String]
+    attr_accessor :country
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # The charge-id returned from the original charge response.
+    # Will match only a single transaction.
+    # Required if merchant-request-id or merchant-transaction-id are not
+    # provided. Do not include if merchant-request-id or merchant-transaction-id
+    # are provided.
+    # @return [String]
+    attr_accessor :charge_id
+
+    # The merchant-request-id of the original charge request.
+    # Will match only a single transaction.
+    # **Note:** merchant-request-id is only valid within 24 hours of the
+    # original charge request. After this time, it will return no results.
+    # Required if charge-id or merchant-transaction-id are not provided. Do not
+    # include if charge-id or merchant-transaction-id are provided.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # Merchant-assigned transaction ID supplied in the original charge request.
+    # May match multiple transactions in the case where the merchant reuses
+    # merchant-transaction-ids across different request IDs, as Boku does not
+    # enforce uniqueness on this value.
+    # Required if charge-id or merchant-request-id are not provided.  Do not
+    # include if merchant-request-id or charge-id are provided.
+    # @return [String]
+    attr_accessor :merchant_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['charge_id'] = 'charge-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['merchant_transaction_id'] = 'merchant-transaction-id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        charge_id
+        merchant_request_id
+        merchant_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, merchant_id = nil, charge_id = SKIP,
+                   merchant_request_id = SKIP, merchant_transaction_id = SKIP)
+      @country = country
+      @merchant_id = merchant_id
+      @charge_id = charge_id unless charge_id == SKIP
+      @merchant_request_id = merchant_request_id unless merchant_request_id == SKIP
+      @merchant_transaction_id = merchant_transaction_id unless merchant_transaction_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
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      charge_id = hash.key?('charge-id') ? hash['charge-id'] : SKIP
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : SKIP
+      merchant_transaction_id =
+        hash.key?('merchant-transaction-id') ? hash['merchant-transaction-id'] : SKIP
+
+      # Create object from extracted values.
+      QueryChargeRequest.new(country,
+                             merchant_id,
+                             charge_id,
+                             merchant_request_id,
+                             merchant_transaction_id)
+    end
+
+    def self.from_element(root)
+      country = XmlUtilities.from_element(root, 'country', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      charge_id = XmlUtilities.from_element(root, 'charge-id', String)
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      merchant_transaction_id = XmlUtilities.from_element(
+        root, 'merchant-transaction-id', String
+      )
+
+      new(country,
+          merchant_id,
+          charge_id,
+          merchant_request_id,
+          merchant_transaction_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, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'charge-id', charge_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-transaction-id',
+                                     merchant_transaction_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}, merchant_id: #{@merchant_id}, charge_id:"\
+      " #{@charge_id}, merchant_request_id: #{@merchant_request_id}, merchant_transaction_id:"\
+      " #{@merchant_transaction_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}, merchant_id: #{@merchant_id.inspect},"\
+      " charge_id: #{@charge_id.inspect}, merchant_request_id: #{@merchant_request_id.inspect},"\
+      " merchant_transaction_id: #{@merchant_transaction_id.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/query_charge_response.rb

@@ -0,0 +1,101 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # QueryChargeResponse Model.
+  class QueryChargeResponse < 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
+
+    # The 'result' element is defined in every response type. It is used to
+    # convey the outcome of an API request.
+    # @return [Array[Charge]]
+    attr_accessor :charges
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['result'] = 'result'
+      @_hash['charges'] = 'charges'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        charges
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result = nil, charges = SKIP)
+      @result = result
+      @charges = charges unless charges == 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
+      charges = nil
+      unless hash['charges'].nil?
+        charges = []
+        hash['charges'].each do |structure|
+          charges << (Charge.from_hash(structure) if structure)
+        end
+      end
+
+      charges = SKIP unless hash.key?('charges')
+
+      # Create object from extracted values.
+      QueryChargeResponse.new(result,
+                              charges)
+    end
+
+    def self.from_element(root)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      charges = XmlUtilities.from_element_to_array(
+        root, 'charge', Charge, wrapping_element_name: 'charges'
+      )
+
+      new(result,
+          charges)
+    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, 'charge', charges,
+                                           wrapping_element_name: 'charges')
+
+      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}, charges: #{@charges}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result.inspect}, charges: #{@charges.inspect}>"
+    end
+  end
+end