fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/expand60_enum.rb

@@ -0,0 +1,200 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # expand60.
+  class Expand60Enum
+    EXPAND60_ENUM = [
+      # TODO: Write general description for LOG_EMAILS
+      LOG_EMAILS = 'log_emails'.freeze,
+
+      # TODO: Write general description for IS_VOIDABLE
+      IS_VOIDABLE = 'is_voidable'.freeze,
+
+      # TODO: Write general description for IS_REVERSIBLE
+      IS_REVERSIBLE = 'is_reversible'.freeze,
+
+      # TODO: Write general description for IS_REFUNDABLE
+      IS_REFUNDABLE = 'is_refundable'.freeze,
+
+      # TODO: Write general description for IS_COMPLETABLE
+      IS_COMPLETABLE = 'is_completable'.freeze,
+
+      # TODO: Write general description for IS_SETTLED
+      IS_SETTLED = 'is_settled'.freeze,
+
+      # TODO: Write general description for CREATED_USER
+      CREATED_USER = 'created_user'.freeze,
+
+      # TODO: Write general description for LOCATION
+      LOCATION = 'location'.freeze,
+
+      # TODO: Write general description for CONTACT
+      CONTACT = 'contact'.freeze,
+
+      # TODO: Write general description for CHANGELOGS
+      CHANGELOGS = 'changelogs'.freeze,
+
+      # TODO: Write general description for PRODUCT_TRANSACTION
+      PRODUCT_TRANSACTION = 'product_transaction'.freeze,
+
+      # TODO: Write general description for TAGS
+      TAGS = 'tags'.freeze,
+
+      # TODO: Write general description for ALL_TAGS
+      ALL_TAGS = 'all_tags'.freeze,
+
+      # TODO: Write general description for RECURRING
+      RECURRING = 'recurring'.freeze,
+
+      # TODO: Write general description for TAGTRANSACTIONS
+      TAGTRANSACTIONS = 'tagTransactions'.freeze,
+
+      # TODO: Write general description for DECLINED_RECURRING_NOTIFICATION
+      DECLINED_RECURRING_NOTIFICATION = 'declined_recurring_notification'.freeze,
+
+      # TODO: Write general description for PAYMENT_RECURRING_NOTIFICATION
+      PAYMENT_RECURRING_NOTIFICATION = 'payment_recurring_notification'.freeze,
+
+      # TODO: Write general description for ACCOUNT_VAULT
+      ACCOUNT_VAULT = 'account_vault'.freeze,
+
+      # TODO: Write general description for QUICK_INVOICE
+      QUICK_INVOICE = 'quick_invoice'.freeze,
+
+      # TODO: Write general description for DEVELOPER_COMPANY
+      DEVELOPER_COMPANY = 'developer_company'.freeze,
+
+      # TODO: Write general description for TERMINAL
+      TERMINAL = 'terminal'.freeze,
+
+      # TODO: Write general description for HOSTED_PAYMENT_PAGE
+      HOSTED_PAYMENT_PAGE = 'hosted_payment_page'.freeze,
+
+      # TODO: Write general description for TRANSACTION_LEVEL3
+      TRANSACTION_LEVEL3 = 'transaction_level3'.freeze,
+
+      # TODO: Write general description for DEVELOPER_COMPANY_ID
+      DEVELOPER_COMPANY_ID = 'developer_company_id'.freeze,
+
+      # TODO: Write general description for TRANSACTION_HISTORIES
+      TRANSACTION_HISTORIES = 'transaction_histories'.freeze,
+
+      # TODO: Write general description for SURCHARGE_TRANSACTION
+      SURCHARGE_TRANSACTION = 'surcharge_transaction'.freeze,
+
+      # TODO: Write general description for SURCHARGE
+      SURCHARGE = 'surcharge'.freeze,
+
+      # TODO: Write general description for SIGNATURE
+      SIGNATURE = 'signature'.freeze,
+
+      # TODO: Write general description for REASON_CODE
+      REASON_CODE = 'reason_code'.freeze,
+
+      # TODO: Write general description for TYPE
+      TYPE = 'type'.freeze,
+
+      # TODO: Write general description for STATUS
+      STATUS = 'status'.freeze,
+
+      # TODO: Write general description for TRANSACTION_BATCH
+      TRANSACTION_BATCH = 'transaction_batch'.freeze,
+
+      # TODO: Write general description for TRANSACTION_SPLITS
+      TRANSACTION_SPLITS = 'transaction_splits'.freeze,
+
+      # TODO: Write general description for POSTBACK_LOGS
+      POSTBACK_LOGS = 'postback_logs'.freeze,
+
+      # TODO: Write general description for CURRENCY_TYPE
+      CURRENCY_TYPE = 'currency_type'.freeze,
+
+      # TODO: Write general description for TRANSACTION_REFERENCES
+      TRANSACTION_REFERENCES = 'transaction_references'.freeze,
+
+      # TODO: Write general description for SAVED_ACCOUNT
+      SAVED_ACCOUNT = 'saved_account'.freeze,
+
+      # TODO: Write general description for REJECTED_TRANSACTION_ACH_RETRIES
+      REJECTED_TRANSACTION_ACH_RETRIES = 'rejected_transaction_ach_retries'.freeze,
+
+      # TODO: Write general description for RETURN_FEE_TRANSACTION_ACH_RETRY
+      RETURN_FEE_TRANSACTION_ACH_RETRY = 'return_fee_transaction_ach_retry'.freeze,
+
+      # TODO: Write general description for RETRY_TRANSACTION_ACH_RETRY
+      RETRY_TRANSACTION_ACH_RETRY = 'retry_transaction_ach_retry'.freeze,
+
+      # TODO: Write general description for IS_RETRIABLE
+      IS_RETRIABLE = 'is_retriable'.freeze,
+
+      # TODO: Write general description for TRANSACTION_THREE_DS
+      TRANSACTION_THREE_DS = 'transaction_three_ds'.freeze,
+
+      # TODO: Write general description for BALANCES
+      BALANCES = 'balances'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXPAND60_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOG_EMAILS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'log_emails' then LOG_EMAILS
+      when 'is_voidable' then IS_VOIDABLE
+      when 'is_reversible' then IS_REVERSIBLE
+      when 'is_refundable' then IS_REFUNDABLE
+      when 'is_completable' then IS_COMPLETABLE
+      when 'is_settled' then IS_SETTLED
+      when 'created_user' then CREATED_USER
+      when 'location' then LOCATION
+      when 'contact' then CONTACT
+      when 'changelogs' then CHANGELOGS
+      when 'product_transaction' then PRODUCT_TRANSACTION
+      when 'tags' then TAGS
+      when 'all_tags' then ALL_TAGS
+      when 'recurring' then RECURRING
+      when 'tagtransactions' then TAGTRANSACTIONS
+      when 'declined_recurring_notification' then DECLINED_RECURRING_NOTIFICATION
+      when 'payment_recurring_notification' then PAYMENT_RECURRING_NOTIFICATION
+      when 'account_vault' then ACCOUNT_VAULT
+      when 'quick_invoice' then QUICK_INVOICE
+      when 'developer_company' then DEVELOPER_COMPANY
+      when 'terminal' then TERMINAL
+      when 'hosted_payment_page' then HOSTED_PAYMENT_PAGE
+      when 'transaction_level3' then TRANSACTION_LEVEL3
+      when 'developer_company_id' then DEVELOPER_COMPANY_ID
+      when 'transaction_histories' then TRANSACTION_HISTORIES
+      when 'surcharge_transaction' then SURCHARGE_TRANSACTION
+      when 'surcharge' then SURCHARGE
+      when 'signature' then SIGNATURE
+      when 'reason_code' then REASON_CODE
+      when 'type' then TYPE
+      when 'status' then STATUS
+      when 'transaction_batch' then TRANSACTION_BATCH
+      when 'transaction_splits' then TRANSACTION_SPLITS
+      when 'postback_logs' then POSTBACK_LOGS
+      when 'currency_type' then CURRENCY_TYPE
+      when 'transaction_references' then TRANSACTION_REFERENCES
+      when 'saved_account' then SAVED_ACCOUNT
+      when 'rejected_transaction_ach_retries' then REJECTED_TRANSACTION_ACH_RETRIES
+      when 'return_fee_transaction_ach_retry' then RETURN_FEE_TRANSACTION_ACH_RETRY
+      when 'retry_transaction_ach_retry' then RETRY_TRANSACTION_ACH_RETRY
+      when 'is_retriable' then IS_RETRIABLE
+      when 'transaction_three_ds' then TRANSACTION_THREE_DS
+      when 'balances' then BALANCES
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/expand8_enum.rb

@@ -0,0 +1,52 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # expand8.
+  class Expand8Enum
+    EXPAND8_ENUM = [
+      # TODO: Write general description for CREATED_USER
+      CREATED_USER = 'created_user'.freeze,
+
+      # TODO: Write general description for LOCATION
+      LOCATION = 'location'.freeze,
+
+      # TODO: Write general description for TERMINAL
+      TERMINAL = 'terminal'.freeze,
+
+      # TODO: Write general description for CHANGELOGS
+      CHANGELOGS = 'changelogs'.freeze,
+
+      # TODO: Write general description for SIGNATURE
+      SIGNATURE = 'signature'.freeze,
+
+      # TODO: Write general description for REASON_CODE
+      REASON_CODE = 'reason_code'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXPAND8_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREATED_USER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created_user' then CREATED_USER
+      when 'location' then LOCATION
+      when 'terminal' then TERMINAL
+      when 'changelogs' then CHANGELOGS
+      when 'signature' then SIGNATURE
+      when 'reason_code' then REASON_CODE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/expand_enum.rb

@@ -0,0 +1,40 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # expand.
+  class ExpandEnum
+    EXPAND_ENUM = [
+      # TODO: Write general description for CHANGELOGS
+      CHANGELOGS = 'changelogs'.freeze,
+
+      # TODO: Write general description for POSTBACK_LOGS
+      POSTBACK_LOGS = 'postback_logs'.freeze,
+
+      # TODO: Write general description for PRODUCT_TRANSACTION
+      PRODUCT_TRANSACTION = 'product_transaction'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXPAND_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CHANGELOGS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'changelogs' then CHANGELOGS
+      when 'postback_logs' then POSTBACK_LOGS
+      when 'product_transaction' then PRODUCT_TRANSACTION
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/field.rb

@@ -0,0 +1,82 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Field Model.
+  class Field < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Field name used on the sort
+    # @return [String]
+    attr_accessor :field
+
+    # Sort direction ASC/DESC
+    # @return [OrderEnum]
+    attr_accessor :order
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field'] = 'field'
+      @_hash['order'] = 'order'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field
+        order
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(field = SKIP, order = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @field = field unless field == SKIP
+      @order = order unless order == 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.
+      field = hash.key?('field') ? hash['field'] : SKIP
+      order = hash.key?('order') ? hash['order'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Field.new(field,
+                order,
+                additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field}, order: #{@order}, 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} field: #{@field.inspect}, order: #{@order.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/field18.rb

@@ -0,0 +1,143 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Field18 Model.
+  class Field18 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # id
+    # @return [String]
+    attr_accessor :id
+
+    # Label
+    # @return [String]
+    attr_accessor :label
+
+    # Field Type
+    # @return [String]
+    attr_accessor :field_type
+
+    # Position
+    # @return [Array[String]]
+    attr_accessor :position
+
+    # Required
+    # @return [TrueClass | FalseClass]
+    attr_accessor :required
+
+    # Read Only
+    # @return [TrueClass | FalseClass]
+    attr_accessor :readonly
+
+    # Visible
+    # @return [TrueClass | FalseClass]
+    attr_accessor :visible
+
+    # Value
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['label'] = 'label'
+      @_hash['field_type'] = 'field_type'
+      @_hash['position'] = 'position'
+      @_hash['required'] = 'required'
+      @_hash['readonly'] = 'readonly'
+      @_hash['visible'] = 'visible'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        label
+        field_type
+        position
+        required
+        readonly
+        visible
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        value
+      ]
+    end
+
+    def initialize(id = SKIP, label = SKIP, field_type = SKIP, position = SKIP,
+                   required = SKIP, readonly = SKIP, visible = SKIP,
+                   value = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @id = id unless id == SKIP
+      @label = label unless label == SKIP
+      @field_type = field_type unless field_type == SKIP
+      @position = position unless position == SKIP
+      @required = required unless required == SKIP
+      @readonly = readonly unless readonly == SKIP
+      @visible = visible unless visible == SKIP
+      @value = value unless value == 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
+      label = hash.key?('label') ? hash['label'] : SKIP
+      field_type = hash.key?('field_type') ? hash['field_type'] : SKIP
+      position = hash.key?('position') ? hash['position'] : SKIP
+      required = hash.key?('required') ? hash['required'] : SKIP
+      readonly = hash.key?('readonly') ? hash['readonly'] : SKIP
+      visible = hash.key?('visible') ? hash['visible'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Field18.new(id,
+                  label,
+                  field_type,
+                  position,
+                  required,
+                  readonly,
+                  visible,
+                  value,
+                  additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, label: #{@label}, field_type: #{@field_type}, position:"\
+      " #{@position}, required: #{@required}, readonly: #{@readonly}, visible: #{@visible}, value:"\
+      " #{@value}, 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} id: #{@id.inspect}, label: #{@label.inspect}, field_type:"\
+      " #{@field_type.inspect}, position: #{@position.inspect}, required: #{@required.inspect},"\
+      " readonly: #{@readonly.inspect}, visible: #{@visible.inspect}, value: #{@value.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/field27_enum.rb

@@ -0,0 +1,108 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # field27.
+  class Field27Enum
+    FIELD27_ENUM = [
+      # TODO: Write general description for ID
+      ID = 'id'.freeze,
+
+      # TODO: Write general description for CREATED_TS
+      CREATED_TS = 'created_ts'.freeze,
+
+      # TODO: Write general description for PRODUCT_TRANSACTION_ID
+      PRODUCT_TRANSACTION_ID = 'product_transaction_id'.freeze,
+
+      # TODO: Write general description for PROCESSING_STATUS_ID
+      PROCESSING_STATUS_ID = 'processing_status_id'.freeze,
+
+      # TODO: Write general description for BATCH_NUM
+      BATCH_NUM = 'batch_num'.freeze,
+
+      # TODO: Write general description for IS_OPEN
+      IS_OPEN = 'is_open'.freeze,
+
+      # TODO: Write general description for SETTLEMENT_FILE_NAME
+      SETTLEMENT_FILE_NAME = 'settlement_file_name'.freeze,
+
+      # TODO: Write general description for BATCH_CLOSE_TS
+      BATCH_CLOSE_TS = 'batch_close_ts'.freeze,
+
+      # TODO: Write general description for BATCH_CLOSE_DETAIL
+      BATCH_CLOSE_DETAIL = 'batch_close_detail'.freeze,
+
+      # TODO: Write general description for TOTAL_SALE_AMOUNT
+      TOTAL_SALE_AMOUNT = 'total_sale_amount'.freeze,
+
+      # TODO: Write general description for TOTAL_SALE_COUNT
+      TOTAL_SALE_COUNT = 'total_sale_count'.freeze,
+
+      # TODO: Write general description for TOTAL_REFUND_AMOUNT
+      TOTAL_REFUND_AMOUNT = 'total_refund_amount'.freeze,
+
+      # TODO: Write general description for TOTAL_REFUND_COUNT
+      TOTAL_REFUND_COUNT = 'total_refund_count'.freeze,
+
+      # TODO: Write general description for TOTAL_VOID_AMOUNT
+      TOTAL_VOID_AMOUNT = 'total_void_amount'.freeze,
+
+      # TODO: Write general description for TOTAL_VOID_COUNT
+      TOTAL_VOID_COUNT = 'total_void_count'.freeze,
+
+      # TODO: Write general description for TOTAL_BLIND_REFUND_AMOUNT
+      TOTAL_BLIND_REFUND_AMOUNT = 'total_blind_refund_amount'.freeze,
+
+      # TODO: Write general description for TOTAL_BLIND_REFUND_COUNT
+      TOTAL_BLIND_REFUND_COUNT = 'total_blind_refund_count'.freeze,
+
+      # TODO: Write general description for CHANGELOGS
+      CHANGELOGS = 'changelogs'.freeze,
+
+      # TODO: Write general description for POSTBACK_LOGS
+      POSTBACK_LOGS = 'postback_logs'.freeze,
+
+      # TODO: Write general description for PRODUCT_TRANSACTION
+      PRODUCT_TRANSACTION = 'product_transaction'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FIELD27_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'id' then ID
+      when 'created_ts' then CREATED_TS
+      when 'product_transaction_id' then PRODUCT_TRANSACTION_ID
+      when 'processing_status_id' then PROCESSING_STATUS_ID
+      when 'batch_num' then BATCH_NUM
+      when 'is_open' then IS_OPEN
+      when 'settlement_file_name' then SETTLEMENT_FILE_NAME
+      when 'batch_close_ts' then BATCH_CLOSE_TS
+      when 'batch_close_detail' then BATCH_CLOSE_DETAIL
+      when 'total_sale_amount' then TOTAL_SALE_AMOUNT
+      when 'total_sale_count' then TOTAL_SALE_COUNT
+      when 'total_refund_amount' then TOTAL_REFUND_AMOUNT
+      when 'total_refund_count' then TOTAL_REFUND_COUNT
+      when 'total_void_amount' then TOTAL_VOID_AMOUNT
+      when 'total_void_count' then TOTAL_VOID_COUNT
+      when 'total_blind_refund_amount' then TOTAL_BLIND_REFUND_AMOUNT
+      when 'total_blind_refund_count' then TOTAL_BLIND_REFUND_COUNT
+      when 'changelogs' then CHANGELOGS
+      when 'postback_logs' then POSTBACK_LOGS
+      when 'product_transaction' then PRODUCT_TRANSACTION
+      else
+        default_value
+      end
+    end
+  end
+end