fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/v1_device_terms_request.rb

@@ -0,0 +1,118 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1DeviceTermsRequest Model.
+  class V1DeviceTermsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location ID
+    # @return [String]
+    attr_accessor :location_id
+
+    # Terminal ID
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # Set to true or 1 to require a signature from the customer
+    # @return [TrueClass | FalseClass]
+    attr_accessor :require_signature
+
+    # Can be used for associating record to external systems. Must be unique per
+    # location.
+    # @return [String]
+    attr_accessor :device_term_api_id
+
+    # This is the message that is displayed on the screen when prompting for a
+    # signature.
+    # @return [String]
+    attr_accessor :terms_conditions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['location_id'] = 'location_id'
+      @_hash['terminal_id'] = 'terminal_id'
+      @_hash['require_signature'] = 'require_signature'
+      @_hash['device_term_api_id'] = 'device_term_api_id'
+      @_hash['terms_conditions'] = 'terms_conditions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_term_api_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        device_term_api_id
+      ]
+    end
+
+    def initialize(location_id = nil, terminal_id = nil,
+                   require_signature = nil, terms_conditions = nil,
+                   device_term_api_id = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @location_id = location_id
+      @terminal_id = terminal_id
+      @require_signature = require_signature
+      @device_term_api_id = device_term_api_id unless device_term_api_id == SKIP
+      @terms_conditions = terms_conditions
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      location_id = hash.key?('location_id') ? hash['location_id'] : nil
+      terminal_id = hash.key?('terminal_id') ? hash['terminal_id'] : nil
+      require_signature =
+        hash.key?('require_signature') ? hash['require_signature'] : nil
+      terms_conditions =
+        hash.key?('terms_conditions') ? hash['terms_conditions'] : nil
+      device_term_api_id =
+        hash.key?('device_term_api_id') ? hash['device_term_api_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1DeviceTermsRequest.new(location_id,
+                               terminal_id,
+                               require_signature,
+                               terms_conditions,
+                               device_term_api_id,
+                               additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} location_id: #{@location_id}, terminal_id: #{@terminal_id},"\
+      " require_signature: #{@require_signature}, device_term_api_id: #{@device_term_api_id},"\
+      " terms_conditions: #{@terms_conditions}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} location_id: #{@location_id.inspect}, terminal_id: #{@terminal_id.inspect},"\
+      " require_signature: #{@require_signature.inspect}, device_term_api_id:"\
+      " #{@device_term_api_id.inspect}, terms_conditions: #{@terms_conditions.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/v1_elements_ticket_intention_request.rb

@@ -0,0 +1,122 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1ElementsTicketIntentionRequest Model.
+  class V1ElementsTicketIntentionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Used to associate the Ticket with a Contact.
+    # @return [String]
+    attr_accessor :contact_id
+
+    # Used to associate the Ticket with a Contact.
+    # @return [String]
+    attr_accessor :contact_api_id
+
+    # A valid Location Id associated with the Contact for this Ticket
+    # @return [String]
+    attr_accessor :location_id
+
+    # Include a product_transaction_id to respect it's cvv and address field
+    # settings when creating a ticket.  These settings are enforced at the
+    # ticket creation level only.
+    # @return [String]
+    attr_accessor :product_transaction_id
+
+    # A custom text message that displays after the ticket is created.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['contact_api_id'] = 'contact_api_id'
+      @_hash['location_id'] = 'location_id'
+      @_hash['product_transaction_id'] = 'product_transaction_id'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_id
+        contact_api_id
+        product_transaction_id
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        contact_id
+        contact_api_id
+        product_transaction_id
+        message
+      ]
+    end
+
+    def initialize(location_id = nil, contact_id = SKIP, contact_api_id = SKIP,
+                   product_transaction_id = SKIP, message = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @contact_id = contact_id unless contact_id == SKIP
+      @contact_api_id = contact_api_id unless contact_api_id == SKIP
+      @location_id = location_id
+      @product_transaction_id = product_transaction_id unless product_transaction_id == SKIP
+      @message = message unless message == 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.
+      location_id = hash.key?('location_id') ? hash['location_id'] : nil
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      contact_api_id =
+        hash.key?('contact_api_id') ? hash['contact_api_id'] : SKIP
+      product_transaction_id =
+        hash.key?('product_transaction_id') ? hash['product_transaction_id'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1ElementsTicketIntentionRequest.new(location_id,
+                                           contact_id,
+                                           contact_api_id,
+                                           product_transaction_id,
+                                           message,
+                                           additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contact_id: #{@contact_id}, contact_api_id: #{@contact_api_id},"\
+      " location_id: #{@location_id}, product_transaction_id: #{@product_transaction_id}, message:"\
+      " #{@message}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contact_id: #{@contact_id.inspect}, contact_api_id:"\
+      " #{@contact_api_id.inspect}, location_id: #{@location_id.inspect}, product_transaction_id:"\
+      " #{@product_transaction_id.inspect}, message: #{@message.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/v1_elements_transaction_intention_request.rb

@@ -0,0 +1,334 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # V1ElementsTransactionIntentionRequest Model.
+  class V1ElementsTransactionIntentionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transaction action to be performed with the transaction intention.
+    # `sale`, `auth-only`, `avs-only`, `tokenization`.
+    # @return [ActionEnum]
+    attr_accessor :action
+
+    # The transaction action to be performed with the transaction intention.
+    # `sale`, `auth-only`, `avs-only`, `tokenization`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :digital_wallets_only
+
+    # By default the system will try to offer all the availables payment methods
+    # from your account. However, if you need to display only cc or ach only use
+    # the corresponding product transaction id.
+    # @return [Array[Method50]]
+    attr_accessor :methods
+
+    # The total transaction amount to be charged with the transaction intention.
+    # Allowed on the actions: `sale`, `auth-only`, `refund`
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Amount of Sales Tax. If supplied, this amount should be already included
+    # in the transaction amount. Allowed on the actions: `sale`, `auth-only`,
+    # `refund`
+    # @return [Integer]
+    attr_accessor :tax_amount
+
+    # secondary_amount is used as a mechanism for partners to collect platform
+    # or SaAs fees at a transaction level. This field is intended for use with
+    # ISV integrations not standalone merchant integrations. Allowed on the
+    # actions: `sale`, `auth-only`.
+    # @return [Integer]
+    attr_accessor :secondary_amount
+
+    # Location ID
+    # @return [String]
+    attr_accessor :location_id
+
+    # Contact ID
+    # @return [String]
+    attr_accessor :contact_id
+
+    # Specifies to tokenize card/bank information within the transaction.
+    # Allowed on the actions: `sale`, `auth-only`, `avs-only`, `refund`. Do not
+    # include with `tokeniation` action.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :save_account
+
+    # Specifies to tokenize card/bank information within the transaction.
+    # Allowed on the actions: `sale`, `auth-only`, `avs-only`, `refund`. Do not
+    # include with `tokeniation` action.
+    # @return [String]
+    attr_accessor :save_account_title
+
+    # A title for the token.
+    # @return [String]
+    attr_accessor :title
+
+    # SEC code for the transaction if it's an ACH transaction.
+    # @return [AchSecCodeEnum]
+    attr_accessor :ach_sec_code
+
+    # Bank Funded Only Override. Force the use of a bank funded debit card on
+    # debit repayment type transactions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :bank_funded_only_override
+
+    # Allow partial Authorization Override. Must have Fortis approval for
+    # production access.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_partial_authorization_override
+
+    # Auto Decline Cvv Override
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_decline_cvv_override
+
+    # Auto Decline Street Override
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_decline_street_override
+
+    # Auto Decline Zip Override
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_decline_zip_override
+
+    # A custom text message that displays after the payment is processed.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action'] = 'action'
+      @_hash['digital_wallets_only'] = 'digitalWalletsOnly'
+      @_hash['methods'] = 'methods'
+      @_hash['amount'] = 'amount'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['secondary_amount'] = 'secondary_amount'
+      @_hash['location_id'] = 'location_id'
+      @_hash['contact_id'] = 'contact_id'
+      @_hash['save_account'] = 'save_account'
+      @_hash['save_account_title'] = 'save_account_title'
+      @_hash['title'] = 'title'
+      @_hash['ach_sec_code'] = 'ach_sec_code'
+      @_hash['bank_funded_only_override'] = 'bank_funded_only_override'
+      @_hash['allow_partial_authorization_override'] =
+        'allow_partial_authorization_override'
+      @_hash['auto_decline_cvv_override'] = 'auto_decline_cvv_override'
+      @_hash['auto_decline_street_override'] = 'auto_decline_street_override'
+      @_hash['auto_decline_zip_override'] = 'auto_decline_zip_override'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        digital_wallets_only
+        methods
+        amount
+        tax_amount
+        secondary_amount
+        location_id
+        contact_id
+        save_account
+        save_account_title
+        title
+        ach_sec_code
+        bank_funded_only_override
+        allow_partial_authorization_override
+        auto_decline_cvv_override
+        auto_decline_street_override
+        auto_decline_zip_override
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        action
+        location_id
+        contact_id
+        ach_sec_code
+        message
+      ]
+    end
+
+    def initialize(action = ActionEnum::SALE, digital_wallets_only = false,
+                   methods = SKIP, amount = SKIP, tax_amount = SKIP,
+                   secondary_amount = SKIP, location_id = SKIP,
+                   contact_id = SKIP, save_account = SKIP,
+                   save_account_title = SKIP, title = SKIP,
+                   ach_sec_code = AchSecCodeEnum::WEB,
+                   bank_funded_only_override = SKIP,
+                   allow_partial_authorization_override = SKIP,
+                   auto_decline_cvv_override = SKIP,
+                   auto_decline_street_override = SKIP,
+                   auto_decline_zip_override = SKIP, message = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @action = action unless action == SKIP
+      @digital_wallets_only = digital_wallets_only unless digital_wallets_only == SKIP
+      @methods = methods unless methods == SKIP
+      @amount = amount unless amount == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @secondary_amount = secondary_amount unless secondary_amount == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @contact_id = contact_id unless contact_id == SKIP
+      @save_account = save_account unless save_account == SKIP
+      @save_account_title = save_account_title unless save_account_title == SKIP
+      @title = title unless title == SKIP
+      @ach_sec_code = ach_sec_code unless ach_sec_code == SKIP
+      unless bank_funded_only_override == SKIP
+        @bank_funded_only_override =
+          bank_funded_only_override
+      end
+      unless allow_partial_authorization_override == SKIP
+        @allow_partial_authorization_override =
+          allow_partial_authorization_override
+      end
+      unless auto_decline_cvv_override == SKIP
+        @auto_decline_cvv_override =
+          auto_decline_cvv_override
+      end
+      unless auto_decline_street_override == SKIP
+        @auto_decline_street_override =
+          auto_decline_street_override
+      end
+      unless auto_decline_zip_override == SKIP
+        @auto_decline_zip_override =
+          auto_decline_zip_override
+      end
+      @message = message unless message == 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.
+      action = hash['action'] ||= ActionEnum::SALE
+      digital_wallets_only = hash['digitalWalletsOnly'] ||= false
+      # Parameter is an array, so we need to iterate through it
+      methods = nil
+      unless hash['methods'].nil?
+        methods = []
+        hash['methods'].each do |structure|
+          methods << (Method50.from_hash(structure) if structure)
+        end
+      end
+
+      methods = SKIP unless hash.key?('methods')
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      tax_amount = hash.key?('tax_amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestTaxAmount), hash['tax_amount']
+      ) : SKIP
+      secondary_amount = hash.key?('secondary_amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestSecondaryAmount), hash['secondary_amount']
+      ) : SKIP
+      location_id = hash.key?('location_id') ? hash['location_id'] : SKIP
+      contact_id = hash.key?('contact_id') ? hash['contact_id'] : SKIP
+      save_account = hash.key?('save_account') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestSaveAccount), hash['save_account']
+      ) : SKIP
+      save_account_title = hash.key?('save_account_title') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestSaveAccountTitle), hash['save_account_title']
+      ) : SKIP
+      title = hash.key?('title') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestTitle), hash['title']
+      ) : SKIP
+      ach_sec_code = hash['ach_sec_code'] ||= AchSecCodeEnum::WEB
+      bank_funded_only_override = hash.key?('bank_funded_only_override') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestBankFundedOnlyOverride), hash['bank_funded_only_override']
+      ) : SKIP
+      allow_partial_authorization_override = hash.key?('allow_partial_authorization_override') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestAllowPartialAuthorizationOverride), hash['allow_partial_authorization_override']
+      ) : SKIP
+      auto_decline_cvv_override = hash.key?('auto_decline_cvv_override') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestAutoDeclineCvvOverride), hash['auto_decline_cvv_override']
+      ) : SKIP
+      auto_decline_street_override = hash.key?('auto_decline_street_override') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestAutoDeclineStreetOverride), hash['auto_decline_street_override']
+      ) : SKIP
+      auto_decline_zip_override = hash.key?('auto_decline_zip_override') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:V1ElementsTransactionIntentionRequestAutoDeclineZipOverride), hash['auto_decline_zip_override']
+      ) : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      V1ElementsTransactionIntentionRequest.new(action,
+                                                digital_wallets_only,
+                                                methods,
+                                                amount,
+                                                tax_amount,
+                                                secondary_amount,
+                                                location_id,
+                                                contact_id,
+                                                save_account,
+                                                save_account_title,
+                                                title,
+                                                ach_sec_code,
+                                                bank_funded_only_override,
+                                                allow_partial_authorization_override,
+                                                auto_decline_cvv_override,
+                                                auto_decline_street_override,
+                                                auto_decline_zip_override,
+                                                message,
+                                                additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [V1ElementsTransactionIntentionRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action: #{@action}, digital_wallets_only: #{@digital_wallets_only},"\
+      " methods: #{@methods}, amount: #{@amount}, tax_amount: #{@tax_amount}, secondary_amount:"\
+      " #{@secondary_amount}, location_id: #{@location_id}, contact_id: #{@contact_id},"\
+      " save_account: #{@save_account}, save_account_title: #{@save_account_title}, title:"\
+      " #{@title}, ach_sec_code: #{@ach_sec_code}, bank_funded_only_override:"\
+      " #{@bank_funded_only_override}, allow_partial_authorization_override:"\
+      " #{@allow_partial_authorization_override}, auto_decline_cvv_override:"\
+      " #{@auto_decline_cvv_override}, auto_decline_street_override:"\
+      " #{@auto_decline_street_override}, auto_decline_zip_override:"\
+      " #{@auto_decline_zip_override}, message: #{@message}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action: #{@action.inspect}, digital_wallets_only:"\
+      " #{@digital_wallets_only.inspect}, methods: #{@methods.inspect}, amount:"\
+      " #{@amount.inspect}, tax_amount: #{@tax_amount.inspect}, secondary_amount:"\
+      " #{@secondary_amount.inspect}, location_id: #{@location_id.inspect}, contact_id:"\
+      " #{@contact_id.inspect}, save_account: #{@save_account.inspect}, save_account_title:"\
+      " #{@save_account_title.inspect}, title: #{@title.inspect}, ach_sec_code:"\
+      " #{@ach_sec_code.inspect}, bank_funded_only_override:"\
+      " #{@bank_funded_only_override.inspect}, allow_partial_authorization_override:"\
+      " #{@allow_partial_authorization_override.inspect}, auto_decline_cvv_override:"\
+      " #{@auto_decline_cvv_override.inspect}, auto_decline_street_override:"\
+      " #{@auto_decline_street_override.inspect}, auto_decline_zip_override:"\
+      " #{@auto_decline_zip_override.inspect}, message: #{@message.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end