class Tradenity::Transaction

Attributes

__meta[RW]
created_at[RW]
status[RW]
type[RW]
updated_at[RW]

Public Class Methods

api_client() click to toggle source
# File lib/tradenity/resources/transaction.rb, line 304
def self.api_client
  ApiClient.default
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/tradenity/resources/transaction.rb, line 65
def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'status' => :'status',
    :'type' => :'type'
  }
end
delete_by_id(id) click to toggle source

Delete Transaction Delete an instance of Transaction by its ID. @param id ID of Transaction to delete. @return [nil]

# File lib/tradenity/resources/transaction.rb, line 353
def delete_by_id(id)
  delete_transaction_by_id(id)
end
delete_transaction_by_id(transaction_id, opts = {}) click to toggle source

Delete Transaction Delete an instance of Transaction by its ID. @param transaction_id ID of transaction to delete. @param [Hash] opts the optional parameters @return [nil]

# File lib/tradenity/resources/transaction.rb, line 362
def delete_transaction_by_id(transaction_id, opts = {})
  delete_transaction_by_id_with_http_info(transaction_id, opts)
  nil
end
delete_transaction_by_id_with_http_info(transaction_id, opts = {}) click to toggle source

Delete Transaction Delete an instance of Transaction by its ID. @param transaction_id ID of transaction to delete. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/tradenity/resources/transaction.rb, line 372
def delete_transaction_by_id_with_http_info(transaction_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Transaction.delete_transaction_by_id ...'
  end
  # verify the required parameter 'transaction_id' is set
  if api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling Transaction.delete_transaction_by_id"
  end
  # resource path
  local_var_path = '/transactions/{transactionId}'.sub('{' + 'transactionId' + '}', transaction_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Transaction#delete_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
find_all() click to toggle source

List Transactions Return a list of Transactions @param [Hash] opts the optional parameters @return [Page<Transaction>]

# File lib/tradenity/resources/transaction.rb, line 321
def find_all
  list_all_transactions
end
find_all_by(opts = {}) click to toggle source

Find List of Transaction Return multiple instances of Transaction by its attributes. @param [Hash] opts the search parameters @return [Page<Collection>]

# File lib/tradenity/resources/transaction.rb, line 329
def find_all_by(opts = {})
  list_all_transactions(opts)
end
find_by_id(id) click to toggle source

Find Transaction Return single instance of Transaction by its ID. @param id ID of Transaction to return @return [Transaction]

# File lib/tradenity/resources/transaction.rb, line 345
def find_by_id(id)
  get_transaction_by_id(id)
end
find_one_by(opts = {}) click to toggle source

Find Transaction by its parameters Return single instance of Collection by its attributes. @param [Hash] opts search parameters @return [Transaction]

# File lib/tradenity/resources/transaction.rb, line 337
def find_one_by(opts = {})
  list_all_transactions(opts)[0]
end
get_transaction_by_id(transaction_id, opts = {}) click to toggle source

Find Transaction Return single instance of Transaction by its ID. @param transaction_id ID of transaction to return @param [Hash] opts the optional parameters @return [Transaction]

# File lib/tradenity/resources/transaction.rb, line 415
def get_transaction_by_id(transaction_id, opts = {})
  data, _status_code, _headers = get_transaction_by_id_with_http_info(transaction_id, opts)
  data
end
get_transaction_by_id_with_http_info(transaction_id, opts = {}) click to toggle source

Find Transaction Return single instance of Transaction by its ID. @param transaction_id ID of transaction to return @param [Hash] opts the optional parameters @return [Array<(Transaction, Fixnum, Hash)>] Transaction data, response status code and response headers

# File lib/tradenity/resources/transaction.rb, line 425
def get_transaction_by_id_with_http_info(transaction_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Transaction.get_transaction_by_id ...'
  end
  # verify the required parameter 'transaction_id' is set
  if api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling Transaction.get_transaction_by_id"
  end
  # resource path
  local_var_path = '/transactions/{transactionId}'.sub('{' + 'transactionId' + '}', transaction_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Transaction')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Transaction#get_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_all_transactions(opts = {}) click to toggle source

List Transactions Return a list of Transactions @param [Hash] opts the optional parameters @option opts [Integer] :page page number @option opts [Integer] :size page size @option opts [String] :sort page order @return [Page<Transaction>]

# File lib/tradenity/resources/transaction.rb, line 471
def list_all_transactions(opts = {})
  data, _status_code, _headers = list_all_transactions_with_http_info(opts)
  data
end
list_all_transactions_with_http_info(opts = {}) click to toggle source

List Transactions Return a list of Transactions @param [Hash] opts the optional parameters @option opts [Integer] :page page number @option opts [Integer] :size page size @option opts [String] :sort page order @return [Array<(Page<Transaction>, Fixnum, Hash)>] Page<Transaction> data, response status code and response headers

# File lib/tradenity/resources/transaction.rb, line 483
def list_all_transactions_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Transaction.list_all_transactions ...'
  end
  # resource path
  local_var_path = '/transactions'

  # query parameters
  query_params = opts
  # query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  # query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  # query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Page<Transaction>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Transaction#list_all_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/tradenity/resources/transaction.rb, line 90
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'__meta')
    self.__meta = attributes[:'__meta']
  end

  if attributes.has_key?(:'createdAt')
    self.created_at = attributes[:'createdAt']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'updatedAt')
    self.updated_at = attributes[:'updatedAt']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/tradenity/resources/transaction.rb, line 77
def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'status' => :'String',
    :'type' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/tradenity/resources/transaction.rb, line 177
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      status == o.status &&
      type == o.type
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/tradenity/resources/transaction.rb, line 223
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Tradenity.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/tradenity/resources/transaction.rb, line 289
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/tradenity/resources/transaction.rb, line 202
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
delete() click to toggle source

Delete Transaction Delete this instance of Transaction. @return [nil]

# File lib/tradenity/resources/transaction.rb, line 311
def delete
  self.class.delete_transaction_by_id(self.id)
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/tradenity/resources/transaction.rb, line 189
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/tradenity/resources/transaction.rb, line 195
def hash
  [__meta, created_at, updated_at, status, type].hash
end
id() click to toggle source
# File lib/tradenity/resources/transaction.rb, line 21
def id
  if instance_variable_defined?('@id') && @id != nil
    @id
  elsif __meta && __meta.href != nil
    @id = __meta.href.split('/')[-1]
    @id
  else
    nil
  end
end
id=(id) click to toggle source
# File lib/tradenity/resources/transaction.rb, line 17
def id=(id)
  @id = id
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/tradenity/resources/transaction.rb, line 130
def list_invalid_properties
  invalid_properties = Array.new
  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/tradenity/resources/transaction.rb, line 157
def status=(status)
  validator = EnumAttributeValidator.new('String', ['completed', 'pending', 'failed'])
  unless validator.valid?(status)
    fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/tradenity/resources/transaction.rb, line 269
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/tradenity/resources/transaction.rb, line 275
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/tradenity/resources/transaction.rb, line 263
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/tradenity/resources/transaction.rb, line 167
def type=(type)
  validator = EnumAttributeValidator.new('String', ['payment', 'refund'])
  unless validator.valid?(type)
    fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/tradenity/resources/transaction.rb, line 145
def valid?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['completed', 'pending', 'failed'])
  return false unless status_validator.valid?(@status)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['payment', 'refund'])
  return false unless type_validator.valid?(@type)
  true
end