class Tradenity::Option
Attributes
Public Class Methods
# File lib/tradenity/resources/option.rb, line 379 def self.api_client ApiClient.default end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/tradenity/resources/option.rb, line 77 def self.attribute_map { :'id' => :'id', :'__meta' => :'__meta', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt', :'name' => :'name', :'slug' => :'slug', :'description' => :'description', :'required' => :'required', :'data_type' => :'dataType', :'status' => :'status', :'position' => :'position', :'values' => :'values' } end
Create Option
Create a new Option
@param option Attributes of option to create @param [Hash] opts the optional parameters @return [Option]
# File lib/tradenity/resources/option.rb, line 452 def create_option(option, opts = {}) data, _status_code, _headers = create_option_with_http_info(option, opts) data end
Create Option
Create a new Option
@param option Attributes of option to create @param [Hash] opts the optional parameters @return [Array<(Option
, Fixnum, Hash)>] Option
data, response status code and response headers
# File lib/tradenity/resources/option.rb, line 462 def create_option_with_http_info(option, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: Option.create_option ...' end # verify the required parameter 'option' is set if api_client.config.client_side_validation && option.nil? fail ArgumentError, "Missing the required parameter 'option' when calling Option.create_option" end # resource path local_var_path = '/options' # 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(option) 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 => 'Option') if api_client.config.debugging api_client.config.logger.debug "API called: Option#create_option\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete Option
Delete an instance of Option
by its ID. @param option_id ID of option to delete. @param [Hash] opts the optional parameters @return [nil]
# File lib/tradenity/resources/option.rb, line 506 def delete_option_by_id(option_id, opts = {}) delete_option_by_id_with_http_info(option_id, opts) nil end
Delete Option
Delete an instance of Option
by its ID. @param option_id ID of option to delete. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/tradenity/resources/option.rb, line 516 def delete_option_by_id_with_http_info(option_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: Option.delete_option_by_id ...' end # verify the required parameter 'option_id' is set if api_client.config.client_side_validation && option_id.nil? fail ArgumentError, "Missing the required parameter 'option_id' when calling Option.delete_option_by_id" end # resource path local_var_path = '/options/{optionId}'.sub('{' + 'optionId' + '}', option_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: Option#delete_option_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Options Return a list of Options @param [Hash] opts the optional parameters @return [Page<Option>]
# File lib/tradenity/resources/option.rb, line 411 def find_all list_all_options end
Find Option
by its parameters Return single instance of Collection
by its attributes. @param [Hash] opts search parameters @return [Option]
# File lib/tradenity/resources/option.rb, line 427 def find_one_by(opts = {}) list_all_options(opts)[0] end
Find Option
Return single instance of Option
by its ID. @param option_id ID of option to return @param [Hash] opts the optional parameters @return [Option]
# File lib/tradenity/resources/option.rb, line 559 def get_option_by_id(option_id, opts = {}) data, _status_code, _headers = get_option_by_id_with_http_info(option_id, opts) data end
Find Option
Return single instance of Option
by its ID. @param option_id ID of option to return @param [Hash] opts the optional parameters @return [Array<(Option
, Fixnum, Hash)>] Option
data, response status code and response headers
# File lib/tradenity/resources/option.rb, line 569 def get_option_by_id_with_http_info(option_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: Option.get_option_by_id ...' end # verify the required parameter 'option_id' is set if api_client.config.client_side_validation && option_id.nil? fail ArgumentError, "Missing the required parameter 'option_id' when calling Option.get_option_by_id" end # resource path local_var_path = '/options/{optionId}'.sub('{' + 'optionId' + '}', option_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 => 'Option') if api_client.config.debugging api_client.config.logger.debug "API called: Option#get_option_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Options Return a list of Options @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<Option>]
# File lib/tradenity/resources/option.rb, line 615 def list_all_options(opts = {}) data, _status_code, _headers = list_all_options_with_http_info(opts) data end
List Options Return a list of Options @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
<Option>, Fixnum, Hash)>] Page
<Option> data, response status code and response headers
# File lib/tradenity/resources/option.rb, line 627 def list_all_options_with_http_info(opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: Option.list_all_options ...' end # resource path local_var_path = '/options' # 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<Option>') if api_client.config.debugging api_client.config.logger.debug "API called: Option#list_all_options\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/option.rb, line 114 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?(:'slug') self.slug = attributes[:'slug'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'required') self.required = attributes[:'required'] end if attributes.has_key?(:'dataType') self.data_type = attributes[:'dataType'] end if attributes.has_key?(:'data_type') self.data_type = attributes[:'data_type'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'position') self.position = attributes[:'position'] end if attributes.has_key?(:'values') if (value = attributes[:'values']).is_a?(Array) self.values = value end end end
Replace Option
Replace all attributes of Option
@param option_id ID of option to replace @param option Attributes of option to replace @param [Hash] opts the optional parameters @return [Option]
# File lib/tradenity/resources/option.rb, line 671 def replace_option_by_id(option_id, option, opts = {}) data, _status_code, _headers = replace_option_by_id_with_http_info(option_id, option, opts) data end
Replace Option
Replace all attributes of Option
@param option_id ID of option to replace @param option Attributes of option to replace @param [Hash] opts the optional parameters @return [Array<(Option
, Fixnum, Hash)>] Option
data, response status code and response headers
# File lib/tradenity/resources/option.rb, line 682 def replace_option_by_id_with_http_info(option_id, option, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: Option.replace_option_by_id ...' end # verify the required parameter 'option_id' is set if api_client.config.client_side_validation && option_id.nil? fail ArgumentError, "Missing the required parameter 'option_id' when calling Option.replace_option_by_id" end # verify the required parameter 'option' is set if api_client.config.client_side_validation && option.nil? fail ArgumentError, "Missing the required parameter 'option' when calling Option.replace_option_by_id" end # resource path local_var_path = '/options/{optionId}'.sub('{' + 'optionId' + '}', option_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(option) 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 => 'Option') if api_client.config.debugging api_client.config.logger.debug "API called: Option#replace_option_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/option.rb, line 95 def self.swagger_types { :'id' => :'String', :'__meta' => :'InstanceMeta', :'created_at' => :'DateTime', :'updated_at' => :'DateTime', :'name' => :'String', :'slug' => :'String', :'description' => :'String', :'required' => :'BOOLEAN', :'data_type' => :'String', :'status' => :'String', :'position' => :'Integer', :'values' => :'Array<OptionValue>' } end
Update Option
Update attributes of Option
@param option_id ID of option to update. @param option Attributes of option to update. @param [Hash] opts the optional parameters @return [Option]
# File lib/tradenity/resources/option.rb, line 731 def update_option_by_id(option_id, option, opts = {}) data, _status_code, _headers = update_option_by_id_with_http_info(option_id, option, opts) data end
Update Option
Update attributes of Option
@param option_id ID of option to update. @param option Attributes of option to update. @param [Hash] opts the optional parameters @return [Array<(Option
, Fixnum, Hash)>] Option
data, response status code and response headers
# File lib/tradenity/resources/option.rb, line 742 def update_option_by_id_with_http_info(option_id, option, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: Option.update_option_by_id ...' end # verify the required parameter 'option_id' is set if api_client.config.client_side_validation && option_id.nil? fail ArgumentError, "Missing the required parameter 'option_id' when calling Option.update_option_by_id" end # verify the required parameter 'option' is set if api_client.config.client_side_validation && option.nil? fail ArgumentError, "Missing the required parameter 'option' when calling Option.update_option_by_id" end # resource path local_var_path = '/options/{optionId}'.sub('{' + 'optionId' + '}', option_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(option) 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 => 'Option') if api_client.config.debugging api_client.config.logger.debug "API called: Option#update_option_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/option.rb, line 246 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 && slug == o.slug && description == o.description && required == o.required && data_type == o.data_type && status == o.status && position == o.position && values == o.values 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/option.rb, line 298 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/option.rb, line 364 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/option.rb, line 277 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
Custom attribute writer method checking allowed values (enum). @param [Object] data_type
Object to be assigned
# File lib/tradenity/resources/option.rb, line 226 def data_type=(data_type) validator = EnumAttributeValidator.new('String', ['string', 'number', 'date', 'color']) unless validator.valid?(data_type) fail ArgumentError, 'invalid value for "data_type", must be one of #{validator.allowable_values}.' end @data_type = data_type end
@see the `==` method @param [Object] Object to be compared
# File lib/tradenity/resources/option.rb, line 264 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/tradenity/resources/option.rb, line 270 def hash [__meta, created_at, updated_at, name, slug, description, required, data_type, status, position, values].hash end
# File lib/tradenity/resources/option.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/option.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/option.rb, line 184 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @slug.nil? invalid_properties.push('invalid value for "slug", slug cannot be nil.') end if @data_type.nil? invalid_properties.push('invalid value for "data_type", data_type cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @position.nil? invalid_properties.push('invalid value for "position", position 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/option.rb, line 236 def status=(status) validator = EnumAttributeValidator.new('String', ['enabled', 'disabled']) 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/option.rb, line 350 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/option.rb, line 338 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/option.rb, line 211 def valid? return false if @name.nil? return false if @slug.nil? return false if @data_type.nil? data_type_validator = EnumAttributeValidator.new('String', ['string', 'number', 'date', 'color']) return false unless data_type_validator.valid?(@data_type) return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled']) return false unless status_validator.valid?(@status) return false if @position.nil? true end