apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/transaction_create_request.rb

@@ -0,0 +1,192 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # TransactionCreateRequest Model.
+  class TransactionCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount of the `transaction`.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The date of the `transaction`.
+    # @return [String]
+    attr_accessor :date
+
+    # A human-readable version of the `original_description` field. Provided by
+    # MX.
+    # @return [String]
+    attr_accessor :description
+
+    # The type of transaction. Can be either `CREDIT` or `DEBIT`.
+    # @return [Type]
+    attr_accessor :type
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # The three-character ISO 4217 currency code, for example, `USD`.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Indicates whether the transaction has been viewed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_been_viewed
+
+    # Indicates whether the account is hidden. Hidden accounts can still have an
+    # active balance and receive transactions. Defaults to `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_hidden
+
+    # Indicates whether the transaction is international. If the data provider
+    # determines it isn't international then it will be `false`. It will be
+    # `null` if the data provider does not have this information.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_international
+
+    # A note about the transaction.
+    # @return [String]
+    attr_accessor :memo
+
+    # Additional information you can store about the `transaction`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # When set to `true`, this parameter will prevent a webhook from being
+    # triggered by the request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_webhook
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['date'] = 'date'
+      @_hash['description'] = 'description'
+      @_hash['type'] = 'type'
+      @_hash['category_guid'] = 'category_guid'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['has_been_viewed'] = 'has_been_viewed'
+      @_hash['is_hidden'] = 'is_hidden'
+      @_hash['is_international'] = 'is_international'
+      @_hash['memo'] = 'memo'
+      @_hash['metadata'] = 'metadata'
+      @_hash['skip_webhook'] = 'skip_webhook'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category_guid
+        currency_code
+        has_been_viewed
+        is_hidden
+        is_international
+        memo
+        metadata
+        skip_webhook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        amount
+        category_guid
+        currency_code
+      ]
+    end
+
+    def initialize(amount:, date:, description:, type:, category_guid: SKIP,
+                   currency_code: SKIP, has_been_viewed: SKIP, is_hidden: SKIP,
+                   is_international: SKIP, memo: SKIP, metadata: SKIP,
+                   skip_webhook: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @date = date
+      @description = description
+      @type = type
+      @category_guid = category_guid unless category_guid == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @has_been_viewed = has_been_viewed unless has_been_viewed == SKIP
+      @is_hidden = is_hidden unless is_hidden == SKIP
+      @is_international = is_international unless is_international == SKIP
+      @memo = memo unless memo == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @skip_webhook = skip_webhook unless skip_webhook == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      date = hash.key?('date') ? hash['date'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : SKIP
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : SKIP
+      has_been_viewed =
+        hash.key?('has_been_viewed') ? hash['has_been_viewed'] : SKIP
+      is_hidden = hash.key?('is_hidden') ? hash['is_hidden'] : SKIP
+      is_international =
+        hash.key?('is_international') ? hash['is_international'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      skip_webhook = hash.key?('skip_webhook') ? hash['skip_webhook'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TransactionCreateRequest.new(amount: amount,
+                                   date: date,
+                                   description: description,
+                                   type: type,
+                                   category_guid: category_guid,
+                                   currency_code: currency_code,
+                                   has_been_viewed: has_been_viewed,
+                                   is_hidden: is_hidden,
+                                   is_international: is_international,
+                                   memo: memo,
+                                   metadata: metadata,
+                                   skip_webhook: skip_webhook,
+                                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, date: #{@date}, description: #{@description}, type:"\
+      " #{@type}, category_guid: #{@category_guid}, currency_code: #{@currency_code},"\
+      " has_been_viewed: #{@has_been_viewed}, is_hidden: #{@is_hidden}, is_international:"\
+      " #{@is_international}, memo: #{@memo}, metadata: #{@metadata}, skip_webhook:"\
+      " #{@skip_webhook}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, date: #{@date.inspect}, description:"\
+      " #{@description.inspect}, type: #{@type.inspect}, category_guid: #{@category_guid.inspect},"\
+      " currency_code: #{@currency_code.inspect}, has_been_viewed: #{@has_been_viewed.inspect},"\
+      " is_hidden: #{@is_hidden.inspect}, is_international: #{@is_international.inspect}, memo:"\
+      " #{@memo.inspect}, metadata: #{@metadata.inspect}, skip_webhook: #{@skip_webhook.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/transaction_create_request_body.rb

@@ -0,0 +1,76 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # TransactionCreateRequestBody Model.
+  class TransactionCreateRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TransactionCreateRequest]
+    attr_accessor :transaction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction'] = 'transaction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction = transaction unless transaction == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      transaction = TransactionCreateRequest.from_hash(hash['transaction']) if hash['transaction']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TransactionCreateRequestBody.new(transaction: transaction,
+                                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction: #{@transaction}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction: #{@transaction.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end