class Tradenity::RefundTransaction
Attributes
Public Class Methods
# File lib/tradenity/resources/refund_transaction.rb, line 322 def self.api_client ApiClient.default end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/tradenity/resources/refund_transaction.rb, line 67 def self.attribute_map { :'id' => :'id', :'__meta' => :'__meta', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt', :'status' => :'status', :'type' => :'type', :'refund_operation' => :'refundOperation' } end
Create RefundTransaction
Create a new RefundTransaction
@param refund_transaction Attributes of refundTransaction to create @param [Hash] opts the optional parameters @return [RefundTransaction]
# File lib/tradenity/resources/refund_transaction.rb, line 395 def create_refund_transaction(refund_transaction, opts = {}) data, _status_code, _headers = create_refund_transaction_with_http_info(refund_transaction, opts) data end
Create RefundTransaction
Create a new RefundTransaction
@param refund_transaction Attributes of refundTransaction to create @param [Hash] opts the optional parameters @return [Array<(RefundTransaction
, Fixnum, Hash)>] RefundTransaction
data, response status code and response headers
# File lib/tradenity/resources/refund_transaction.rb, line 405 def create_refund_transaction_with_http_info(refund_transaction, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: RefundTransaction.create_refund_transaction ...' end # verify the required parameter 'refund_transaction' is set if api_client.config.client_side_validation && refund_transaction.nil? fail ArgumentError, "Missing the required parameter 'refund_transaction' when calling RefundTransaction.create_refund_transaction" end # resource path local_var_path = '/refundTransactions' # 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 = api_client.object_to_http_body(refund_transaction) auth_names = [] data, status_code, headers = api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RefundTransaction') if api_client.config.debugging api_client.config.logger.debug "API called: RefundTransaction#create_refund_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete RefundTransaction
Delete an instance of RefundTransaction
by its ID. @param id ID of RefundTransaction
to delete. @return [nil]
# File lib/tradenity/resources/refund_transaction.rb, line 386 def delete_by_id(id) delete_refund_transaction_by_id(id) end
Delete RefundTransaction
Delete an instance of RefundTransaction
by its ID. @param refund_transaction_id ID of refundTransaction to delete. @param [Hash] opts the optional parameters @return [nil]
# File lib/tradenity/resources/refund_transaction.rb, line 449 def delete_refund_transaction_by_id(refund_transaction_id, opts = {}) delete_refund_transaction_by_id_with_http_info(refund_transaction_id, opts) nil end
Delete RefundTransaction
Delete an instance of RefundTransaction
by its ID. @param refund_transaction_id ID of refundTransaction to delete. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/tradenity/resources/refund_transaction.rb, line 459 def delete_refund_transaction_by_id_with_http_info(refund_transaction_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: RefundTransaction.delete_refund_transaction_by_id ...' end # verify the required parameter 'refund_transaction_id' is set if api_client.config.client_side_validation && refund_transaction_id.nil? fail ArgumentError, "Missing the required parameter 'refund_transaction_id' when calling RefundTransaction.delete_refund_transaction_by_id" end # resource path local_var_path = '/refundTransactions/{refundTransactionId}'.sub('{' + 'refundTransactionId' + '}', refund_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: RefundTransaction#delete_refund_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List RefundTransactions Return a list of RefundTransactions @param [Hash] opts the optional parameters @return [Page<RefundTransaction>]
# File lib/tradenity/resources/refund_transaction.rb, line 354 def find_all list_all_refund_transactions end
Find List of RefundTransaction
Return multiple instances of RefundTransaction
by its attributes. @param [Hash] opts the search parameters @return [Page<Collection>]
# File lib/tradenity/resources/refund_transaction.rb, line 362 def find_all_by(opts = {}) list_all_refund_transactions(opts) end
Find RefundTransaction
Return single instance of RefundTransaction
by its ID. @param id ID of RefundTransaction
to return @return [RefundTransaction]
# File lib/tradenity/resources/refund_transaction.rb, line 378 def find_by_id(id) get_refund_transaction_by_id(id) end
Find RefundTransaction
by its parameters Return single instance of Collection
by its attributes. @param [Hash] opts search parameters @return [RefundTransaction]
# File lib/tradenity/resources/refund_transaction.rb, line 370 def find_one_by(opts = {}) list_all_refund_transactions(opts)[0] end
Find RefundTransaction
Return single instance of RefundTransaction
by its ID. @param refund_transaction_id ID of refundTransaction to return @param [Hash] opts the optional parameters @return [RefundTransaction]
# File lib/tradenity/resources/refund_transaction.rb, line 502 def get_refund_transaction_by_id(refund_transaction_id, opts = {}) data, _status_code, _headers = get_refund_transaction_by_id_with_http_info(refund_transaction_id, opts) data end
Find RefundTransaction
Return single instance of RefundTransaction
by its ID. @param refund_transaction_id ID of refundTransaction to return @param [Hash] opts the optional parameters @return [Array<(RefundTransaction
, Fixnum, Hash)>] RefundTransaction
data, response status code and response headers
# File lib/tradenity/resources/refund_transaction.rb, line 512 def get_refund_transaction_by_id_with_http_info(refund_transaction_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: RefundTransaction.get_refund_transaction_by_id ...' end # verify the required parameter 'refund_transaction_id' is set if api_client.config.client_side_validation && refund_transaction_id.nil? fail ArgumentError, "Missing the required parameter 'refund_transaction_id' when calling RefundTransaction.get_refund_transaction_by_id" end # resource path local_var_path = '/refundTransactions/{refundTransactionId}'.sub('{' + 'refundTransactionId' + '}', refund_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 => 'RefundTransaction') if api_client.config.debugging api_client.config.logger.debug "API called: RefundTransaction#get_refund_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List RefundTransactions Return a list of RefundTransactions @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<RefundTransaction>]
# File lib/tradenity/resources/refund_transaction.rb, line 558 def list_all_refund_transactions(opts = {}) data, _status_code, _headers = list_all_refund_transactions_with_http_info(opts) data end
List RefundTransactions Return a list of RefundTransactions @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
<RefundTransaction>, Fixnum, Hash)>] Page
<RefundTransaction> data, response status code and response headers
# File lib/tradenity/resources/refund_transaction.rb, line 570 def list_all_refund_transactions_with_http_info(opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: RefundTransaction.list_all_refund_transactions ...' end # resource path local_var_path = '/refundTransactions' # 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<RefundTransaction>') if api_client.config.debugging api_client.config.logger.debug "API called: RefundTransaction#list_all_refund_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/tradenity/resources/refund_transaction.rb, line 94 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 if attributes.has_key?(:'refundOperation') self.refund_operation = attributes[:'refundOperation'] end if attributes.has_key?(:'refund_operation') self.refund_operation = attributes[:'refund_operation'] end end
Replace RefundTransaction
Replace all attributes of RefundTransaction
@param refund_transaction_id ID of refundTransaction to replace @param refund_transaction Attributes of refundTransaction to replace @param [Hash] opts the optional parameters @return [RefundTransaction]
# File lib/tradenity/resources/refund_transaction.rb, line 614 def replace_refund_transaction_by_id(refund_transaction_id, refund_transaction, opts = {}) data, _status_code, _headers = replace_refund_transaction_by_id_with_http_info(refund_transaction_id, refund_transaction, opts) data end
Replace RefundTransaction
Replace all attributes of RefundTransaction
@param refund_transaction_id ID of refundTransaction to replace @param refund_transaction Attributes of refundTransaction to replace @param [Hash] opts the optional parameters @return [Array<(RefundTransaction
, Fixnum, Hash)>] RefundTransaction
data, response status code and response headers
# File lib/tradenity/resources/refund_transaction.rb, line 625 def replace_refund_transaction_by_id_with_http_info(refund_transaction_id, refund_transaction, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: RefundTransaction.replace_refund_transaction_by_id ...' end # verify the required parameter 'refund_transaction_id' is set if api_client.config.client_side_validation && refund_transaction_id.nil? fail ArgumentError, "Missing the required parameter 'refund_transaction_id' when calling RefundTransaction.replace_refund_transaction_by_id" end # verify the required parameter 'refund_transaction' is set if api_client.config.client_side_validation && refund_transaction.nil? fail ArgumentError, "Missing the required parameter 'refund_transaction' when calling RefundTransaction.replace_refund_transaction_by_id" end # resource path local_var_path = '/refundTransactions/{refundTransactionId}'.sub('{' + 'refundTransactionId' + '}', refund_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 = api_client.object_to_http_body(refund_transaction) auth_names = [] data, status_code, headers = api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RefundTransaction') if api_client.config.debugging api_client.config.logger.debug "API called: RefundTransaction#replace_refund_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attribute type mapping.
# File lib/tradenity/resources/refund_transaction.rb, line 80 def self.swagger_types { :'id' => :'String', :'__meta' => :'InstanceMeta', :'created_at' => :'DateTime', :'updated_at' => :'DateTime', :'status' => :'String', :'type' => :'String', :'refund_operation' => :'RefundOperation' } end
Update RefundTransaction
Update attributes of RefundTransaction
@param refund_transaction_id ID of refundTransaction to update. @param refund_transaction Attributes of refundTransaction to update. @param [Hash] opts the optional parameters @return [RefundTransaction]
# File lib/tradenity/resources/refund_transaction.rb, line 674 def update_refund_transaction_by_id(refund_transaction_id, refund_transaction, opts = {}) data, _status_code, _headers = update_refund_transaction_by_id_with_http_info(refund_transaction_id, refund_transaction, opts) data end
Update RefundTransaction
Update attributes of RefundTransaction
@param refund_transaction_id ID of refundTransaction to update. @param refund_transaction Attributes of refundTransaction to update. @param [Hash] opts the optional parameters @return [Array<(RefundTransaction
, Fixnum, Hash)>] RefundTransaction
data, response status code and response headers
# File lib/tradenity/resources/refund_transaction.rb, line 685 def update_refund_transaction_by_id_with_http_info(refund_transaction_id, refund_transaction, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: RefundTransaction.update_refund_transaction_by_id ...' end # verify the required parameter 'refund_transaction_id' is set if api_client.config.client_side_validation && refund_transaction_id.nil? fail ArgumentError, "Missing the required parameter 'refund_transaction_id' when calling RefundTransaction.update_refund_transaction_by_id" end # verify the required parameter 'refund_transaction' is set if api_client.config.client_side_validation && refund_transaction.nil? fail ArgumentError, "Missing the required parameter 'refund_transaction' when calling RefundTransaction.update_refund_transaction_by_id" end # resource path local_var_path = '/refundTransactions/{refundTransactionId}'.sub('{' + 'refundTransactionId' + '}', refund_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 = api_client.object_to_http_body(refund_transaction) auth_names = [] data, status_code, headers = api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RefundTransaction') if api_client.config.debugging api_client.config.logger.debug "API called: RefundTransaction#update_refund_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/tradenity/resources/refund_transaction.rb, line 194 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 && refund_operation == o.refund_operation end
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/refund_transaction.rb, line 241 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
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/refund_transaction.rb, line 307 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
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/refund_transaction.rb, line 220 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
Create RefundTransaction
Create a new RefundTransaction
# File lib/tradenity/resources/refund_transaction.rb, line 328 def create data = self.class.create_refund_transaction(self) self.id = data.id data end
Delete RefundTransaction
Delete this instance of RefundTransaction
. @return [nil]
# File lib/tradenity/resources/refund_transaction.rb, line 344 def delete self.class.delete_refund_transaction_by_id(self.id) end
@see the `==` method @param [Object] Object to be compared
# File lib/tradenity/resources/refund_transaction.rb, line 207 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/tradenity/resources/refund_transaction.rb, line 213 def hash [__meta, created_at, updated_at, status, type, refund_operation].hash end
# File lib/tradenity/resources/refund_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
# File lib/tradenity/resources/refund_transaction.rb, line 17 def id=(id) @id = id end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/tradenity/resources/refund_transaction.rb, line 142 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 if @refund_operation.nil? invalid_properties.push('invalid value for "refund_operation", refund_operation cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/tradenity/resources/refund_transaction.rb, line 174 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/tradenity/resources/refund_transaction.rb, line 293 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/tradenity/resources/refund_transaction.rb, line 281 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/tradenity/resources/refund_transaction.rb, line 184 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
Update RefundTransaction
Update attributes of RefundTransaction
@return [RefundTransaction]
# File lib/tradenity/resources/refund_transaction.rb, line 337 def update self.class.update_refund_transaction_by_id(self.id, self) end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/tradenity/resources/refund_transaction.rb, line 161 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) return false if @refund_operation.nil? true end