class Tradenity::CustomerGroup
Attributes
Public Class Methods
# File lib/tradenity/resources/customer_group.rb, line 315 def self.api_client ApiClient.default end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/tradenity/resources/customer_group.rb, line 69 def self.attribute_map { :'id' => :'id', :'__meta' => :'__meta', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt', :'name' => :'name', :'slug' => :'slug', :'status' => :'status', :'description' => :'description' } end
Create CustomerGroup
Create a new CustomerGroup
@param customer_group Attributes of customerGroup to create @param [Hash] opts the optional parameters @return [CustomerGroup]
# File lib/tradenity/resources/customer_group.rb, line 388 def create_customer_group(customer_group, opts = {}) data, _status_code, _headers = create_customer_group_with_http_info(customer_group, opts) data end
Create CustomerGroup
Create a new CustomerGroup
@param customer_group Attributes of customerGroup to create @param [Hash] opts the optional parameters @return [Array<(CustomerGroup
, Fixnum, Hash)>] CustomerGroup
data, response status code and response headers
# File lib/tradenity/resources/customer_group.rb, line 398 def create_customer_group_with_http_info(customer_group, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: CustomerGroup.create_customer_group ...' end # verify the required parameter 'customer_group' is set if api_client.config.client_side_validation && customer_group.nil? fail ArgumentError, "Missing the required parameter 'customer_group' when calling CustomerGroup.create_customer_group" end # resource path local_var_path = '/customerGroups' # 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(customer_group) 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 => 'CustomerGroup') if api_client.config.debugging api_client.config.logger.debug "API called: CustomerGroup#create_customer_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete CustomerGroup
Delete an instance of CustomerGroup
by its ID. @param id ID of CustomerGroup
to delete. @return [nil]
# File lib/tradenity/resources/customer_group.rb, line 379 def delete_by_id(id) delete_customer_group_by_id(id) end
Delete CustomerGroup
Delete an instance of CustomerGroup
by its ID. @param customer_group_id ID of customerGroup to delete. @param [Hash] opts the optional parameters @return [nil]
# File lib/tradenity/resources/customer_group.rb, line 442 def delete_customer_group_by_id(customer_group_id, opts = {}) delete_customer_group_by_id_with_http_info(customer_group_id, opts) nil end
Delete CustomerGroup
Delete an instance of CustomerGroup
by its ID. @param customer_group_id ID of customerGroup to delete. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/tradenity/resources/customer_group.rb, line 452 def delete_customer_group_by_id_with_http_info(customer_group_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: CustomerGroup.delete_customer_group_by_id ...' end # verify the required parameter 'customer_group_id' is set if api_client.config.client_side_validation && customer_group_id.nil? fail ArgumentError, "Missing the required parameter 'customer_group_id' when calling CustomerGroup.delete_customer_group_by_id" end # resource path local_var_path = '/customerGroups/{customerGroupId}'.sub('{' + 'customerGroupId' + '}', customer_group_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: CustomerGroup#delete_customer_group_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List CustomerGroups Return a list of CustomerGroups @param [Hash] opts the optional parameters @return [Page<CustomerGroup>]
# File lib/tradenity/resources/customer_group.rb, line 347 def find_all list_all_customer_groups end
Find List of CustomerGroup
Return multiple instances of CustomerGroup
by its attributes. @param [Hash] opts the search parameters @return [Page<Collection>]
# File lib/tradenity/resources/customer_group.rb, line 355 def find_all_by(opts = {}) list_all_customer_groups(opts) end
Find CustomerGroup
Return single instance of CustomerGroup
by its ID. @param id ID of CustomerGroup
to return @return [CustomerGroup]
# File lib/tradenity/resources/customer_group.rb, line 371 def find_by_id(id) get_customer_group_by_id(id) end
Find CustomerGroup
by its parameters Return single instance of Collection
by its attributes. @param [Hash] opts search parameters @return [CustomerGroup]
# File lib/tradenity/resources/customer_group.rb, line 363 def find_one_by(opts = {}) list_all_customer_groups(opts)[0] end
Find CustomerGroup
Return single instance of CustomerGroup
by its ID. @param customer_group_id ID of customerGroup to return @param [Hash] opts the optional parameters @return [CustomerGroup]
# File lib/tradenity/resources/customer_group.rb, line 495 def get_customer_group_by_id(customer_group_id, opts = {}) data, _status_code, _headers = get_customer_group_by_id_with_http_info(customer_group_id, opts) data end
Find CustomerGroup
Return single instance of CustomerGroup
by its ID. @param customer_group_id ID of customerGroup to return @param [Hash] opts the optional parameters @return [Array<(CustomerGroup
, Fixnum, Hash)>] CustomerGroup
data, response status code and response headers
# File lib/tradenity/resources/customer_group.rb, line 505 def get_customer_group_by_id_with_http_info(customer_group_id, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: CustomerGroup.get_customer_group_by_id ...' end # verify the required parameter 'customer_group_id' is set if api_client.config.client_side_validation && customer_group_id.nil? fail ArgumentError, "Missing the required parameter 'customer_group_id' when calling CustomerGroup.get_customer_group_by_id" end # resource path local_var_path = '/customerGroups/{customerGroupId}'.sub('{' + 'customerGroupId' + '}', customer_group_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 => 'CustomerGroup') if api_client.config.debugging api_client.config.logger.debug "API called: CustomerGroup#get_customer_group_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List CustomerGroups Return a list of CustomerGroups @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<CustomerGroup>]
# File lib/tradenity/resources/customer_group.rb, line 551 def list_all_customer_groups(opts = {}) data, _status_code, _headers = list_all_customer_groups_with_http_info(opts) data end
List CustomerGroups Return a list of CustomerGroups @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
<CustomerGroup>, Fixnum, Hash)>] Page
<CustomerGroup> data, response status code and response headers
# File lib/tradenity/resources/customer_group.rb, line 563 def list_all_customer_groups_with_http_info(opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: CustomerGroup.list_all_customer_groups ...' end # resource path local_var_path = '/customerGroups' # 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<CustomerGroup>') if api_client.config.debugging api_client.config.logger.debug "API called: CustomerGroup#list_all_customer_groups\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/customer_group.rb, line 98 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?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end end
Replace CustomerGroup
Replace all attributes of CustomerGroup
@param customer_group_id ID of customerGroup to replace @param customer_group Attributes of customerGroup to replace @param [Hash] opts the optional parameters @return [CustomerGroup]
# File lib/tradenity/resources/customer_group.rb, line 607 def replace_customer_group_by_id(customer_group_id, customer_group, opts = {}) data, _status_code, _headers = replace_customer_group_by_id_with_http_info(customer_group_id, customer_group, opts) data end
Replace CustomerGroup
Replace all attributes of CustomerGroup
@param customer_group_id ID of customerGroup to replace @param customer_group Attributes of customerGroup to replace @param [Hash] opts the optional parameters @return [Array<(CustomerGroup
, Fixnum, Hash)>] CustomerGroup
data, response status code and response headers
# File lib/tradenity/resources/customer_group.rb, line 618 def replace_customer_group_by_id_with_http_info(customer_group_id, customer_group, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: CustomerGroup.replace_customer_group_by_id ...' end # verify the required parameter 'customer_group_id' is set if api_client.config.client_side_validation && customer_group_id.nil? fail ArgumentError, "Missing the required parameter 'customer_group_id' when calling CustomerGroup.replace_customer_group_by_id" end # verify the required parameter 'customer_group' is set if api_client.config.client_side_validation && customer_group.nil? fail ArgumentError, "Missing the required parameter 'customer_group' when calling CustomerGroup.replace_customer_group_by_id" end # resource path local_var_path = '/customerGroups/{customerGroupId}'.sub('{' + 'customerGroupId' + '}', customer_group_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(customer_group) 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 => 'CustomerGroup') if api_client.config.debugging api_client.config.logger.debug "API called: CustomerGroup#replace_customer_group_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/customer_group.rb, line 83 def self.swagger_types { :'id' => :'String', :'__meta' => :'InstanceMeta', :'created_at' => :'DateTime', :'updated_at' => :'DateTime', :'name' => :'String', :'slug' => :'String', :'status' => :'String', :'description' => :'String' } end
Update CustomerGroup
Update attributes of CustomerGroup
@param customer_group_id ID of customerGroup to update. @param customer_group Attributes of customerGroup to update. @param [Hash] opts the optional parameters @return [CustomerGroup]
# File lib/tradenity/resources/customer_group.rb, line 667 def update_customer_group_by_id(customer_group_id, customer_group, opts = {}) data, _status_code, _headers = update_customer_group_by_id_with_http_info(customer_group_id, customer_group, opts) data end
Update CustomerGroup
Update attributes of CustomerGroup
@param customer_group_id ID of customerGroup to update. @param customer_group Attributes of customerGroup to update. @param [Hash] opts the optional parameters @return [Array<(CustomerGroup
, Fixnum, Hash)>] CustomerGroup
data, response status code and response headers
# File lib/tradenity/resources/customer_group.rb, line 678 def update_customer_group_by_id_with_http_info(customer_group_id, customer_group, opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: CustomerGroup.update_customer_group_by_id ...' end # verify the required parameter 'customer_group_id' is set if api_client.config.client_side_validation && customer_group_id.nil? fail ArgumentError, "Missing the required parameter 'customer_group_id' when calling CustomerGroup.update_customer_group_by_id" end # verify the required parameter 'customer_group' is set if api_client.config.client_side_validation && customer_group.nil? fail ArgumentError, "Missing the required parameter 'customer_group' when calling CustomerGroup.update_customer_group_by_id" end # resource path local_var_path = '/customerGroups/{customerGroupId}'.sub('{' + 'customerGroupId' + '}', customer_group_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(customer_group) 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 => 'CustomerGroup') if api_client.config.debugging api_client.config.logger.debug "API called: CustomerGroup#update_customer_group_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/customer_group.rb, line 186 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 && status == o.status && description == o.description 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/customer_group.rb, line 234 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/customer_group.rb, line 300 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/customer_group.rb, line 213 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 CustomerGroup
Create a new CustomerGroup
# File lib/tradenity/resources/customer_group.rb, line 321 def create data = self.class.create_customer_group(self) self.id = data.id data end
Delete CustomerGroup
Delete this instance of CustomerGroup
. @return [nil]
# File lib/tradenity/resources/customer_group.rb, line 337 def delete self.class.delete_customer_group_by_id(self.id) end
@see the `==` method @param [Object] Object to be compared
# File lib/tradenity/resources/customer_group.rb, line 200 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/tradenity/resources/customer_group.rb, line 206 def hash [__meta, created_at, updated_at, name, slug, status, description].hash end
# File lib/tradenity/resources/customer_group.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/customer_group.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/customer_group.rb, line 146 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
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/tradenity/resources/customer_group.rb, line 176 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/customer_group.rb, line 286 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/customer_group.rb, line 274 def to_s to_hash.to_s end
Update CustomerGroup
Update attributes of CustomerGroup
@return [CustomerGroup]
# File lib/tradenity/resources/customer_group.rb, line 330 def update self.class.update_customer_group_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/customer_group.rb, line 165 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