Class: PinterestSdkClient::InviteResponse

Inherits:
ApiModelBase show all
Defined in:
lib/pinterest_sdk/models/invite_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ InviteResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::InviteResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::InviteResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'invite_data')
    self.invite_data = attributes[:'invite_data']
  end

  if attributes.key?(:'is_received_invite')
    self.is_received_invite = attributes[:'is_received_invite']
  end

  if attributes.key?(:'user')
    self.user = attributes[:'user']
  end

  if attributes.key?(:'assets_summary')
    self.assets_summary = attributes[:'assets_summary']
  end

  if attributes.key?(:'business_roles')
    if (value = attributes[:'business_roles']).is_a?(Array)
      self.business_roles = value
    end
  end

  if attributes.key?(:'created_by_business')
    self.created_by_business = attributes[:'created_by_business']
  end

  if attributes.key?(:'created_by_user')
    self.created_by_user = attributes[:'created_by_user']
  end

  if attributes.key?(:'created_time')
    self.created_time = attributes[:'created_time']
  end
end

Instance Attribute Details

#assets_summary ⇒ Object

Returns the value of attribute assets_summary.



29
30
31
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 29

def assets_summary
  @assets_summary
end

#business_roles ⇒ Object

The access level a user would be granted on the business if the invite/request is accepted. This can be EMPLOYEE, BIZ_ADMIN, or PARTNER.



32
33
34
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 32

def business_roles
  @business_roles
end

#created_by_business ⇒ Object

Metadata for the business that created the invite/request.



35
36
37
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 35

def created_by_business
  @created_by_business
end

#created_by_user ⇒ Object

Metadata for the user that created the invite/request.



38
39
40
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 38

def created_by_user
  @created_by_user
end

#created_time ⇒ Object

The time the invite/request was created. Returned in milliseconds.



41
42
43
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 41

def created_time
  @created_time
end

#id ⇒ Object

Unique identifier of the invite/request.



19
20
21
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 19

def id
  @id
end

#invite_data ⇒ Object

Returns the value of attribute invite_data.



21
22
23
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 21

def invite_data
  @invite_data
end

#is_received_invite ⇒ Object

Indicates whether the invite/request was received.



24
25
26
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 24

def is_received_invite
  @is_received_invite
end

#user ⇒ Object

Metadata for the member/partner that was sent the invite/request.



27
28
29
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 27

def user
  @user
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



59
60
61
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 64

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 44

def self.attribute_map
  {
    :'id' => :'id',
    :'invite_data' => :'invite_data',
    :'is_received_invite' => :'is_received_invite',
    :'user' => :'user',
    :'assets_summary' => :'assets_summary',
    :'business_roles' => :'business_roles',
    :'created_by_business' => :'created_by_business',
    :'created_by_user' => :'created_by_user',
    :'created_time' => :'created_time'
  }
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 221

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



93
94
95
96
97
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 93

def self.openapi_all_of
  [
  :'BaseInviteDataResponse'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
88
89
90
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 84

def self.openapi_nullable
  Set.new([
    :'assets_summary',
    :'created_by_business',
    :'created_by_user',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 69

def self.openapi_types
  {
    :'id' => :'String',
    :'invite_data' => :'BaseInviteDataResponseInviteData',
    :'is_received_invite' => :'Boolean',
    :'user' => :'BusinessAccessUserSummary',
    :'assets_summary' => :'InviteAssetsSummary',
    :'business_roles' => :'Array<String>',
    :'created_by_business' => :'Object',
    :'created_by_user' => :'Object',
    :'created_time' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      invite_data == o.invite_data &&
      is_received_invite == o.is_received_invite &&
      user == o.user &&
      assets_summary == o.assets_summary &&
      business_roles == o.business_roles &&
      created_by_business == o.created_by_business &&
      created_by_user == o.created_by_user &&
      created_time == o.created_time
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


208
209
210
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 214

def hash
  [id, invite_data, is_received_invite, user, assets_summary, business_roles, created_by_business, created_by_user, created_time].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



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 156

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+$/)
  if !@id.nil? && @id !~ pattern
    invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



169
170
171
172
173
 
# File 'lib/pinterest_sdk/models/invite_response.rb', line 169

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@id.nil? && @id !~ Regexp.new(/^\d+$/)
  true
end