Class: Zernio::WebhookPayloadAccountAdsInitialSyncCompletedAccount

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.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 = {}) ⇒ WebhookPayloadAccountAdsInitialSyncCompletedAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
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
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::WebhookPayloadAccountAdsInitialSyncCompletedAccount` 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 `Zernio::WebhookPayloadAccountAdsInitialSyncCompletedAccount`. 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?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

  if attributes.key?(:'profile_id')
    self.profile_id = attributes[:'profile_id']
  else
    self.profile_id = nil
  end

  if attributes.key?(:'platform')
    self.platform = attributes[:'platform']
  else
    self.platform = nil
  end

  if attributes.key?(:'username')
    self.username = attributes[:'username']
  else
    self.username = nil
  end

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The account's unique identifier (same as used in /v1/accounts/accountId)



19
20
21
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 19

def 
  @account_id
end

#display_name ⇒ Object

Returns the value of attribute display_name.



28
29
30
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 28

def display_name
  @display_name
end

#platform ⇒ Object

Returns the value of attribute platform.



24
25
26
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 24

def platform
  @platform
end

#platform_ad_account_id ⇒ Object

When the consumer scoped the connect call to a single ad account, this echoes that ID back so the webhook can be correlated to the originating connect request without consulting the consumer's DB. Meta uses the act_* shape.



37
38
39
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 37

def 
  @platform_ad_account_id
end

#platform_ad_account_ids ⇒ Object

Every ad-account ID that the connected token could see at discovery time. Useful for "we synced ads from these accounts" UX without a follow-up API call. Empty array when the token had no ad-account visibility.



40
41
42
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 40

def 
  @platform_ad_account_ids
end

#platform_user_id ⇒ Object

The platform-side account/ad-account ID (e.g. Meta ad account ID).



31
32
33
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 31

def platform_user_id
  @platform_user_id
end

#profile_id ⇒ Object

The profile's unique identifier this account belongs to



22
23
24
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 22

def profile_id
  @profile_id
end

#profile_picture ⇒ Object

URL of the account's profile picture, when available.



34
35
36
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 34

def profile_picture
  @profile_picture
end

#username ⇒ Object

Returns the value of attribute username.



26
27
28
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 26

def username
  @username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 43

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'profile_id' => :'profileId',
    :'platform' => :'platform',
    :'username' => :'username',
    :'display_name' => :'displayName',
    :'platform_user_id' => :'platformUserId',
    :'profile_picture' => :'profilePicture',
    :'platform_ad_account_id' => :'platformAdAccountId',
    :'platform_ad_account_ids' => :'platformAdAccountIds'
  }
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 257

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

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 68

def self.openapi_types
  {
    :'account_id' => :'String',
    :'profile_id' => :'String',
    :'platform' => :'String',
    :'username' => :'String',
    :'display_name' => :'String',
    :'platform_user_id' => :'String',
    :'profile_picture' => :'String',
    :'platform_ad_account_id' => :'String',
    :'platform_ad_account_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      profile_id == o.profile_id &&
      platform == o.platform &&
      username == o.username &&
      display_name == o.display_name &&
      platform_user_id == o.platform_user_id &&
      profile_picture == o.profile_picture &&
       == o. &&
       == o.
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


244
245
246
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 250

def hash
  [, profile_id, platform, username, display_name, platform_user_id, profile_picture, , ].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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 153

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

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

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

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 279

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



177
178
179
180
181
182
183
184
 
# File 'lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed_account.rb', line 177

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if @profile_id.nil?
  return false if @platform.nil?
  return false if @username.nil?
  true
end