class Tradenity::State
Attributes
Public Class Methods
# File lib/tradenity/resources/state.rb, line 267 def self.api_client ApiClient.default end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/tradenity/resources/state.rb, line 45 def self.attribute_map { :'id' => :'id', :'__meta' => :'__meta', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt', :'name' => :'name', :'code' => :'code', :'country' => :'country' } end
Create State
Create a new State
@param state Attributes of state to create @param [Hash] opts the optional parameters @return [Array<(State
, Fixnum, Hash)>] State
data, response status code and response headers
# File lib/tradenity/resources/state.rb, line 350 def create_state_with_http_info(state, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: State.create_state ...' end # verify the required parameter 'state' is set if api_client.config.client_side_validation && state.nil? fail ArgumentError, "Missing the required parameter 'state' when calling State.create_state" end # resource path local_var_path = '/states' # 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(state) 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 => 'State') if api_client.config.debugging api_client.config.logger.debug "API called: State#create_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete State
Delete an instance of State
by its ID. @param state_id ID of state to delete. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/tradenity/resources/state.rb, line 404 def delete_state_by_id_with_http_info(state_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: State.delete_state_by_id ...' end # verify the required parameter 'state_id' is set if api_client.config.client_side_validation && state_id.nil? fail ArgumentError, "Missing the required parameter 'state_id' when calling State.delete_state_by_id" end # resource path local_var_path = '/states/{stateId}'.sub('{' + 'stateId' + '}', state_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: State#delete_state_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List States Return a list of States @param [Hash] opts the optional parameters @return [Page<State>]
# File lib/tradenity/resources/state.rb, line 299 def find_all list_all_states end
Find State
by its parameters Return single instance of Collection
by its attributes. @param [Hash] opts search parameters @return [State]
# File lib/tradenity/resources/state.rb, line 315 def find_one_by(opts = {}) list_all_states(opts)[0] end
Find State
Return single instance of State
by its ID. @param state_id ID of state to return @param [Hash] opts the optional parameters @return [State]
# File lib/tradenity/resources/state.rb, line 447 def get_state_by_id(state_id, opts = {}) data, _status_code, _headers = get_state_by_id_with_http_info(state_id, opts) data end
Find State
Return single instance of State
by its ID. @param state_id ID of state to return @param [Hash] opts the optional parameters @return [Array<(State
, Fixnum, Hash)>] State
data, response status code and response headers
# File lib/tradenity/resources/state.rb, line 457 def get_state_by_id_with_http_info(state_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: State.get_state_by_id ...' end # verify the required parameter 'state_id' is set if api_client.config.client_side_validation && state_id.nil? fail ArgumentError, "Missing the required parameter 'state_id' when calling State.get_state_by_id" end # resource path local_var_path = '/states/{stateId}'.sub('{' + 'stateId' + '}', state_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 => 'State') if api_client.config.debugging api_client.config.logger.debug "API called: State#get_state_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List States Return a list of States @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<State>]
# File lib/tradenity/resources/state.rb, line 503 def list_all_states(opts = {}) data, _status_code, _headers = list_all_states_with_http_info(opts) data end
List States Return a list of States @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
<State>, Fixnum, Hash)>] Page
<State> data, response status code and response headers
# File lib/tradenity/resources/state.rb, line 515 def list_all_states_with_http_info(opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: State.list_all_states ...' end # resource path local_var_path = '/states' # 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<State>') if api_client.config.debugging api_client.config.logger.debug "API called: State#list_all_states\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/state.rb, line 72 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'code') self.code = attributes[:'code'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end end
Replace State
Replace all attributes of State
@param state_id ID of state to replace @param state Attributes of state to replace @param [Hash] opts the optional parameters @return [State]
# File lib/tradenity/resources/state.rb, line 559 def replace_state_by_id(state_id, state, opts = {}) data, _status_code, _headers = replace_state_by_id_with_http_info(state_id, state, opts) data end
Replace State
Replace all attributes of State
@param state_id ID of state to replace @param state Attributes of state to replace @param [Hash] opts the optional parameters @return [Array<(State
, Fixnum, Hash)>] State
data, response status code and response headers
# File lib/tradenity/resources/state.rb, line 570 def replace_state_by_id_with_http_info(state_id, state, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: State.replace_state_by_id ...' end # verify the required parameter 'state_id' is set if api_client.config.client_side_validation && state_id.nil? fail ArgumentError, "Missing the required parameter 'state_id' when calling State.replace_state_by_id" end # verify the required parameter 'state' is set if api_client.config.client_side_validation && state.nil? fail ArgumentError, "Missing the required parameter 'state' when calling State.replace_state_by_id" end # resource path local_var_path = '/states/{stateId}'.sub('{' + 'stateId' + '}', state_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(state) 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 => 'State') if api_client.config.debugging api_client.config.logger.debug "API called: State#replace_state_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/state.rb, line 58 def self.swagger_types { :'id' => :'String', :'__meta' => :'InstanceMeta', :'created_at' => :'DateTime', :'updated_at' => :'DateTime', :'name' => :'String', :'code' => :'String', :'country' => :'Country' } end
Update State
Update attributes of State
@param state_id ID of state to update. @param state Attributes of state to update. @param [Hash] opts the optional parameters @return [State]
# File lib/tradenity/resources/state.rb, line 619 def update_state_by_id(state_id, state, opts = {}) data, _status_code, _headers = update_state_by_id_with_http_info(state_id, state, opts) data end
Update State
Update attributes of State
@param state_id ID of state to update. @param state Attributes of state to update. @param [Hash] opts the optional parameters @return [Array<(State
, Fixnum, Hash)>] State
data, response status code and response headers
# File lib/tradenity/resources/state.rb, line 630 def update_state_by_id_with_http_info(state_id, state, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: State.update_state_by_id ...' end # verify the required parameter 'state_id' is set if api_client.config.client_side_validation && state_id.nil? fail ArgumentError, "Missing the required parameter 'state_id' when calling State.update_state_by_id" end # verify the required parameter 'state' is set if api_client.config.client_side_validation && state.nil? fail ArgumentError, "Missing the required parameter 'state' when calling State.update_state_by_id" end # resource path local_var_path = '/states/{stateId}'.sub('{' + 'stateId' + '}', state_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(state) 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 => 'State') if api_client.config.debugging api_client.config.logger.debug "API called: State#update_state_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/state.rb, line 139 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 && name == o.name && code == o.code && country == o.country 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/state.rb, line 186 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/state.rb, line 252 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/state.rb, line 165 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
@see the `==` method @param [Object] Object to be compared
# File lib/tradenity/resources/state.rb, line 152 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/tradenity/resources/state.rb, line 158 def hash [__meta, created_at, updated_at, name, code, country].hash end
# File lib/tradenity/resources/state.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/state.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/state.rb, line 116 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @country.nil? invalid_properties.push('invalid value for "country", country cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/tradenity/resources/state.rb, line 238 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/state.rb, line 226 def to_s to_hash.to_s 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/state.rb, line 131 def valid? return false if @name.nil? return false if @country.nil? true end