Class: AmznSpApi::MerchantFulfillmentApiModel::SellerInputDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant_fulfillment_api_model/models/seller_input_definition.rb

Overview

Specifies characteristics that apply to a seller input.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SellerInputDefinition

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 59

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::MerchantFulfillmentApiModel::SellerInputDefinition` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::MerchantFulfillmentApiModel::SellerInputDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.is_required = attributes[:is_required] if attributes.key?(:is_required)

  self.data_type = attributes[:data_type] if attributes.key?(:data_type)

  self.constraints = attributes[:constraints] if attributes.key?(:constraints)

  self.input_display_text = attributes[:input_display_text] if attributes.key?(:input_display_text)

  self.input_target = attributes[:input_target] if attributes.key?(:input_target)

  self.stored_value = attributes[:stored_value] if attributes.key?(:stored_value)

  return unless attributes.key?(:restricted_set_values)

  self.restricted_set_values = attributes[:restricted_set_values]
end

Instance Attribute Details

#constraints ⇒ Object

Returns the value of attribute constraints.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 21

def constraints
  @constraints
end

#data_type ⇒ Object

The data type of the additional input field.



19
20
21
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 19

def data_type
  @data_type
end

#input_display_text ⇒ Object

The display text for the additional input field.



24
25
26
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 24

def input_display_text
  @input_display_text
end

#input_target ⇒ Object

Returns the value of attribute input_target.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 21

def input_target
  @input_target
end

#is_required ⇒ Object

When true, the additional input field is required.



16
17
18
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 16

def is_required
  @is_required
end

#restricted_set_values ⇒ Object

Returns the value of attribute restricted_set_values.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 21

def restricted_set_values
  @restricted_set_values
end

#stored_value ⇒ Object

Returns the value of attribute stored_value.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 21

def stored_value
  @stored_value
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 27

def self.attribute_map
  {
    'is_required': :IsRequired,
    'data_type': :DataType,
    'constraints': :Constraints,
    'input_display_text': :InputDisplayText,
    'input_target': :InputTarget,
    'stored_value': :StoredValue,
    'restricted_set_values': :RestrictedSetValues
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



145
146
147
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 145

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



53
54
55
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 53

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 40

def self.openapi_types
  {
    'is_required': :Object,
    'data_type': :Object,
    'constraints': :Object,
    'input_display_text': :Object,
    'input_target': :Object,
    'stored_value': :Object,
    'restricted_set_values': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 117

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    is_required == other.is_required &&
    data_type == other.data_type &&
    constraints == other.constraints &&
    input_display_text == other.input_display_text &&
    input_target == other.input_target &&
    stored_value == other.stored_value &&
    restricted_set_values == other.restricted_set_values
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 174

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
    AmznSpApi::MerchantFulfillmentApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 243

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 152

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


132
133
134
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



138
139
140
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 138

def hash
  [is_required, data_type, constraints, input_display_text, input_target, stored_value, restricted_set_values].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 88

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "is_required", is_required cannot be nil.') if @is_required.nil?

  invalid_properties.push('invalid value for "data_type", data_type cannot be nil.') if @data_type.nil?

  invalid_properties.push('invalid value for "constraints", constraints cannot be nil.') if @constraints.nil?

  invalid_properties.push('invalid value for "input_display_text", input_display_text cannot be nil.') if @input_display_text.nil?

  invalid_properties.push('invalid value for "stored_value", stored_value cannot be nil.') if @stored_value.nil?

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



219
220
221
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 219

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 225

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



213
214
215
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 213

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



105
106
107
108
109
110
111
112
113
 
# File 'lib/merchant_fulfillment_api_model/models/seller_input_definition.rb', line 105

def valid?
  return false if @is_required.nil?
  return false if @data_type.nil?
  return false if @constraints.nil?
  return false if @input_display_text.nil?
  return false if @stored_value.nil?

  true
end