Class: AmznSpApi::TokensApiModel::RestrictedResource

Inherits:
Object
  • Object
show all
Defined in:
lib/tokens_api_model/models/restricted_resource.rb

Overview

Model of a restricted resource.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RestrictedResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 70

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::TokensApiModel::RestrictedResource` 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::TokensApiModel::RestrictedResource`. 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.method = attributes[:method] if attributes.key?(:method)

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

  return unless attributes.key?(:data_elements)
  return unless (value = attributes[:data_elements]).is_a?(Array)

  self.data_elements = value
end

Instance Attribute Details

#data_elements ⇒ Object

Indicates the type of Personally Identifiable Information requested. This parameter is required only when getting an RDT for use with the getOrder, getOrders, or getOrderItems operation of the Orders API. For more information, see the [Tokens API Use Case Guide](doc:tokens-api-use-case-guide). Possible values include: - buyerInfo. On the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available. - shippingAddress. This includes information for fulfilling orders. - buyerTaxInformation. This includes information for issuing tax invoices.



22
23
24
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 22

def data_elements
  @data_elements
end

#method ⇒ Object

The HTTP method in the restricted resource.



16
17
18
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 16

def method
  @method
end

#path ⇒ Object

The path in the restricted resource. Here are some path examples: - “‘/orders/v0/orders“`. For getting an RDT for the getOrders operation of the Orders API. For bulk orders. - “`/orders/v0/orders/123-1234567-1234567“`. For getting an RDT for the getOrder operation of the Orders API. For a specific order. - “`/orders/v0/orders/123-1234567-1234567/orderItems“`. For getting an RDT for the getOrderItems operation of the Orders API. For the order items in a specific order. - “`/mfn/v0/shipments/FBA1234ABC5D“`. For getting an RDT for the getShipment operation of the Shipping API. For a specific shipment. - “`/mfn/v0/shipments/shipmentId“`. For getting an RDT for the getShipment operation of the Shipping API. For any of a selling partner’s shipments that you specify when you call the getShipment operation.



19
20
21
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 19

def path
  @path
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 46

def self.attribute_map
  {
    'method': :method,
    'path': :path,
    'data_elements': :dataElements
  }
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



148
149
150
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 148

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 55

def self.openapi_types
  {
    'method': :Object,
    'path': :Object,
    'data_elements': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 124

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

  self.class == other.class &&
    method == other.method &&
    path == other.path &&
    data_elements == other.data_elements
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



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
210
211
212
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 177

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::TokensApiModel.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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 246

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 155

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


135
136
137
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



141
142
143
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 141

def hash
  [method, path, data_elements].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



92
93
94
95
96
97
98
99
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 92

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

  invalid_properties.push('invalid value for "path", path cannot be nil.') if @path.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



222
223
224
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 222

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 228

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



216
217
218
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 216

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



103
104
105
106
107
108
109
110
111
 
# File 'lib/tokens_api_model/models/restricted_resource.rb', line 103

def valid?
  return false if @method.nil?

  method_validator = EnumAttributeValidator.new('Object', %w[GET PUT POST DELETE])
  return false unless method_validator.valid?(@method)
  return false if @path.nil?

  true
end