class Tradenity::OptionSet

Attributes

__meta[RW]
created_at[RW]
description[RW]
name[RW]
options[RW]
slug[RW]
status[RW]
updated_at[RW]

Public Class Methods

api_client() click to toggle source
# File lib/tradenity/resources/option_set.rb, line 326
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/option_set.rb, line 71
def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'slug' => :'slug',
    :'description' => :'description',
    :'status' => :'status',
    :'options' => :'options'
  }
end
create_option_set(option_set, opts = {}) click to toggle source

Create OptionSet Create a new OptionSet @param option_set Attributes of optionSet to create @param [Hash] opts the optional parameters @return [OptionSet]

# File lib/tradenity/resources/option_set.rb, line 399
def create_option_set(option_set, opts = {})
  data, _status_code, _headers = create_option_set_with_http_info(option_set, opts)
  data
end
create_option_set_with_http_info(option_set, opts = {}) click to toggle source

Create OptionSet Create a new OptionSet @param option_set Attributes of optionSet to create @param [Hash] opts the optional parameters @return [Array<(OptionSet, Fixnum, Hash)>] OptionSet data, response status code and response headers

# File lib/tradenity/resources/option_set.rb, line 409
def create_option_set_with_http_info(option_set, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OptionSet.create_option_set ...'
  end
  # verify the required parameter 'option_set' is set
  if api_client.config.client_side_validation && option_set.nil?
    fail ArgumentError, "Missing the required parameter 'option_set' when calling OptionSet.create_option_set"
  end
  # resource path
  local_var_path = '/optionSets'

  # 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_set)
  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 => 'OptionSet')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OptionSet#create_option_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_by_id(id) click to toggle source

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

# File lib/tradenity/resources/option_set.rb, line 390
def delete_by_id(id)
  delete_option_set_by_id(id)
end
delete_option_set_by_id(option_set_id, opts = {}) click to toggle source

Delete OptionSet Delete an instance of OptionSet by its ID. @param option_set_id ID of optionSet to delete. @param [Hash] opts the optional parameters @return [nil]

# File lib/tradenity/resources/option_set.rb, line 453
def delete_option_set_by_id(option_set_id, opts = {})
  delete_option_set_by_id_with_http_info(option_set_id, opts)
  nil
end
delete_option_set_by_id_with_http_info(option_set_id, opts = {}) click to toggle source

Delete OptionSet Delete an instance of OptionSet by its ID. @param option_set_id ID of optionSet 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_set.rb, line 463
def delete_option_set_by_id_with_http_info(option_set_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OptionSet.delete_option_set_by_id ...'
  end
  # verify the required parameter 'option_set_id' is set
  if api_client.config.client_side_validation && option_set_id.nil?
    fail ArgumentError, "Missing the required parameter 'option_set_id' when calling OptionSet.delete_option_set_by_id"
  end
  # resource path
  local_var_path = '/optionSets/{optionSetId}'.sub('{' + 'optionSetId' + '}', option_set_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: OptionSet#delete_option_set_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 OptionSets Return a list of OptionSets @param [Hash] opts the optional parameters @return [Page<OptionSet>]

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

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

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

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

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

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

# File lib/tradenity/resources/option_set.rb, line 374
def find_one_by(opts = {})
  list_all_option_sets(opts)[0]
end
get_option_set_by_id(option_set_id, opts = {}) click to toggle source

Find OptionSet Return single instance of OptionSet by its ID. @param option_set_id ID of optionSet to return @param [Hash] opts the optional parameters @return [OptionSet]

# File lib/tradenity/resources/option_set.rb, line 506
def get_option_set_by_id(option_set_id, opts = {})
  data, _status_code, _headers = get_option_set_by_id_with_http_info(option_set_id, opts)
  data
end
get_option_set_by_id_with_http_info(option_set_id, opts = {}) click to toggle source

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

# File lib/tradenity/resources/option_set.rb, line 516
def get_option_set_by_id_with_http_info(option_set_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OptionSet.get_option_set_by_id ...'
  end
  # verify the required parameter 'option_set_id' is set
  if api_client.config.client_side_validation && option_set_id.nil?
    fail ArgumentError, "Missing the required parameter 'option_set_id' when calling OptionSet.get_option_set_by_id"
  end
  # resource path
  local_var_path = '/optionSets/{optionSetId}'.sub('{' + 'optionSetId' + '}', option_set_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 => 'OptionSet')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OptionSet#get_option_set_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_all_option_sets(opts = {}) click to toggle source

List OptionSets Return a list of OptionSets @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<OptionSet>]

# File lib/tradenity/resources/option_set.rb, line 562
def list_all_option_sets(opts = {})
  data, _status_code, _headers = list_all_option_sets_with_http_info(opts)
  data
end
list_all_option_sets_with_http_info(opts = {}) click to toggle source

List OptionSets Return a list of OptionSets @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<OptionSet>, Fixnum, Hash)>] Page<OptionSet> data, response status code and response headers

# File lib/tradenity/resources/option_set.rb, line 574
def list_all_option_sets_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OptionSet.list_all_option_sets ...'
  end
  # resource path
  local_var_path = '/optionSets'

  # 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<OptionSet>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OptionSet#list_all_option_sets\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/option_set.rb, line 102
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?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'options')
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  end
end
replace_option_set_by_id(option_set_id, option_set, opts = {}) click to toggle source

Replace OptionSet Replace all attributes of OptionSet @param option_set_id ID of optionSet to replace @param option_set Attributes of optionSet to replace @param [Hash] opts the optional parameters @return [OptionSet]

# File lib/tradenity/resources/option_set.rb, line 618
def replace_option_set_by_id(option_set_id, option_set, opts = {})
  data, _status_code, _headers = replace_option_set_by_id_with_http_info(option_set_id, option_set, opts)
  data
end
replace_option_set_by_id_with_http_info(option_set_id, option_set, opts = {}) click to toggle source

Replace OptionSet Replace all attributes of OptionSet @param option_set_id ID of optionSet to replace @param option_set Attributes of optionSet to replace @param [Hash] opts the optional parameters @return [Array<(OptionSet, Fixnum, Hash)>] OptionSet data, response status code and response headers

# File lib/tradenity/resources/option_set.rb, line 629
def replace_option_set_by_id_with_http_info(option_set_id, option_set, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OptionSet.replace_option_set_by_id ...'
  end
  # verify the required parameter 'option_set_id' is set
  if api_client.config.client_side_validation && option_set_id.nil?
    fail ArgumentError, "Missing the required parameter 'option_set_id' when calling OptionSet.replace_option_set_by_id"
  end
  # verify the required parameter 'option_set' is set
  if api_client.config.client_side_validation && option_set.nil?
    fail ArgumentError, "Missing the required parameter 'option_set' when calling OptionSet.replace_option_set_by_id"
  end
  # resource path
  local_var_path = '/optionSets/{optionSetId}'.sub('{' + 'optionSetId' + '}', option_set_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_set)
  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 => 'OptionSet')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OptionSet#replace_option_set_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/tradenity/resources/option_set.rb, line 86
def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'slug' => :'String',
    :'description' => :'String',
    :'status' => :'String',
    :'options' => :'Array<Option>'
  }
end
update_option_set_by_id(option_set_id, option_set, opts = {}) click to toggle source

Update OptionSet Update attributes of OptionSet @param option_set_id ID of optionSet to update. @param option_set Attributes of optionSet to update. @param [Hash] opts the optional parameters @return [OptionSet]

# File lib/tradenity/resources/option_set.rb, line 678
def update_option_set_by_id(option_set_id, option_set, opts = {})
  data, _status_code, _headers = update_option_set_by_id_with_http_info(option_set_id, option_set, opts)
  data
end
update_option_set_by_id_with_http_info(option_set_id, option_set, opts = {}) click to toggle source

Update OptionSet Update attributes of OptionSet @param option_set_id ID of optionSet to update. @param option_set Attributes of optionSet to update. @param [Hash] opts the optional parameters @return [Array<(OptionSet, Fixnum, Hash)>] OptionSet data, response status code and response headers

# File lib/tradenity/resources/option_set.rb, line 689
def update_option_set_by_id_with_http_info(option_set_id, option_set, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: OptionSet.update_option_set_by_id ...'
  end
  # verify the required parameter 'option_set_id' is set
  if api_client.config.client_side_validation && option_set_id.nil?
    fail ArgumentError, "Missing the required parameter 'option_set_id' when calling OptionSet.update_option_set_by_id"
  end
  # verify the required parameter 'option_set' is set
  if api_client.config.client_side_validation && option_set.nil?
    fail ArgumentError, "Missing the required parameter 'option_set' when calling OptionSet.update_option_set_by_id"
  end
  # resource path
  local_var_path = '/optionSets/{optionSetId}'.sub('{' + 'optionSetId' + '}', option_set_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_set)
  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 => 'OptionSet')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: OptionSet#update_option_set_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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/option_set.rb, line 196
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 &&
      status == o.status &&
      options == o.options
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/option_set.rb, line 245
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/option_set.rb, line 311
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/option_set.rb, line 224
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() click to toggle source

Create OptionSet Create a new OptionSet

# File lib/tradenity/resources/option_set.rb, line 332
def create
  data = self.class.create_option_set(self)
  self.id = data.id
  data
end
delete() click to toggle source

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

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

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

# File lib/tradenity/resources/option_set.rb, line 211
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/option_set.rb, line 217
def hash
  [__meta, created_at, updated_at, name, slug, description, status, options].hash
end
id() click to toggle source
# File lib/tradenity/resources/option_set.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/option_set.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/option_set.rb, line 156
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 @status.nil?
    invalid_properties.push('invalid value for "status", status 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/option_set.rb, line 186
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
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/option_set.rb, line 291
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/option_set.rb, line 297
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/option_set.rb, line 285
def to_s
  to_hash.to_s
end
update() click to toggle source

Update OptionSet Update attributes of OptionSet @return [OptionSet]

# File lib/tradenity/resources/option_set.rb, line 341
def update
  self.class.update_option_set_by_id(self.id, self)
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/option_set.rb, line 175
def valid?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled'])
  return false unless status_validator.valid?(@status)
  true
end