Class: Zernio::ListAdAccounts200ResponseAccountsInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ ListAdAccounts200ResponseAccountsInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 153

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_status ⇒ Object

Returns the value of attribute account_status.



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

def 
  @account_status
end

#approval_status ⇒ Object

X only. X's own ad account approval status. Observed values are ACCEPTED, PENDING and REJECTED, but X does not publish the full vocabulary, so treat an unrecognised value as not usable. Other platforms report accountStatus or status instead.



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

def approval_status
  @approval_status
end

#billing_status ⇒ Object

Meta only. Whether the ad account has a payment method, derived as follows: - missing when accountStatus is 3 (UNSETTLED) or 9 (IN_GRACE_PERIOD), when disableReason is 3 (RISK_PAYMENT), or when the connected person has the MANAGE task on the account (admin, who always sees billing) and Meta returns no funding source. Ad creation on such an account fails at the ad step with Meta code 100 / subcode 1359188: add a payment method in Meta's Billing & payments center. - ok when Meta returns a funding source. This is presence, not validity: Meta can still refuse the card or balance at ad creation. - unknown when the connected person is not an admin of the account, or the token cannot read the billing fields.



57
58
59
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 57

def billing_status
  @billing_status
end

#business_id ⇒ Object

Meta only. Owning Business Manager ID when available on the grant.



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

def business_id
  @business_id
end

#business_name ⇒ Object

Owning business name when supplied by the platform.



29
30
31
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 29

def business_name
  @business_name
end

#currency ⇒ Object

Returns the value of attribute currency.



23
24
25
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 23

def currency
  @currency
end

#disable_reason ⇒ Object

Meta only. Meta's disable_reason code, forwarded unchanged. Present when accountStatus is 2 (DISABLED) and Meta gives a reason, which is what separates a policy action from a payment problem. Meta does not publish a stable list of values for this field, so none are enumerated here: resolve the code against Meta's own ad account reference. Absent when Meta reports no reason, or when the connected token cannot read the field.



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

def disable_reason
  @disable_reason
end

#funding_source ⇒ Object

Meta only. Meta's funding_source ID for the ad account, forwarded unchanged. ABSENT both when this connection's token cannot see billing and when the account has no payment method; read billingStatus to tell the two apart.



52
53
54
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 52

def funding_source
  @funding_source
end

#funding_source_details ⇒ Object

Returns the value of attribute funding_source_details.



54
55
56
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 54

def funding_source_details
  @funding_source_details
end

#id ⇒ Object

Platform ad account ID (e.g. act_123)



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

def id
  @id
end

#minimum_daily_budget ⇒ Object

Meta only. Minimum daily budget for the account, in the account currency's major units. This is the impressions-billed minimum; other billing events have higher minimums. Absent when the connected token cannot read it.



49
50
51
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 49

def minimum_daily_budget
  @minimum_daily_budget
end

#name ⇒ Object

Returns the value of attribute name.



21
22
23
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 21

def name
  @name
end

#selectable ⇒ Object

Meta and X only. Whether the account can create/run ads now. Absent (treat as true) on other platforms.



60
61
62
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 60

def selectable
  @selectable
end

#status ⇒ Object

LinkedIn only. LinkedIn's own ad account status. In practice always ACTIVE, because the LinkedIn query filters to active accounts. Meta, Google, TikTok and Pinterest report accountStatus instead; X reports approvalStatus.



32
33
34
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 32

def status
  @status
end

#timezone_name ⇒ Object

IANA timezone of the ad account (Meta only). Drives daily-budget reset and Insights day boundaries.



43
44
45
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 43

def timezone_name
  @timezone_name
end

#timezone_offset_hours_utc ⇒ Object

Signed UTC offset in hours, reflecting current DST (Meta only).



46
47
48
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 46

def timezone_offset_hours_utc
  @timezone_offset_hours_utc
end

#unusable_reason ⇒ Object

Meta and X only. Human-readable reason when selectable is false; null when selectable.



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

def unusable_reason
  @unusable_reason
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



111
112
113
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 111

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



116
117
118
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 116

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 88

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'currency' => :'currency',
    :'business_id' => :'businessId',
    :'business_name' => :'businessName',
    :'status' => :'status',
    :'account_status' => :'accountStatus',
    :'approval_status' => :'approvalStatus',
    :'disable_reason' => :'disableReason',
    :'timezone_name' => :'timezoneName',
    :'timezone_offset_hours_utc' => :'timezoneOffsetHoursUtc',
    :'minimum_daily_budget' => :'minimumDailyBudget',
    :'funding_source' => :'fundingSource',
    :'funding_source_details' => :'fundingSourceDetails',
    :'billing_status' => :'billingStatus',
    :'selectable' => :'selectable',
    :'unusable_reason' => :'unusableReason'
  }
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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 302

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



144
145
146
147
148
149
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 144

def self.openapi_nullable
  Set.new([
    :'account_status',
    :'unusable_reason'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 121

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'currency' => :'String',
    :'business_id' => :'String',
    :'business_name' => :'String',
    :'status' => :'String',
    :'account_status' => :'Object',
    :'approval_status' => :'String',
    :'disable_reason' => :'Integer',
    :'timezone_name' => :'String',
    :'timezone_offset_hours_utc' => :'Float',
    :'minimum_daily_budget' => :'Float',
    :'funding_source' => :'String',
    :'funding_source_details' => :'ListAdAccounts200ResponseAccountsInnerFundingSourceDetails',
    :'billing_status' => :'String',
    :'selectable' => :'Boolean',
    :'unusable_reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      currency == o.currency &&
      business_id == o.business_id &&
      business_name == o.business_name &&
      status == o.status &&
       == o. &&
      approval_status == o.approval_status &&
      disable_reason == o.disable_reason &&
      timezone_name == o.timezone_name &&
      timezone_offset_hours_utc == o.timezone_offset_hours_utc &&
      minimum_daily_budget == o.minimum_daily_budget &&
      funding_source == o.funding_source &&
      funding_source_details == o.funding_source_details &&
      billing_status == o.billing_status &&
      selectable == o.selectable &&
      unusable_reason == o.unusable_reason
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


289
290
291
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



295
296
297
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 295

def hash
  [id, name, currency, business_id, business_name, status, , approval_status, disable_reason, timezone_name, timezone_offset_hours_utc, minimum_daily_budget, funding_source, funding_source_details, billing_status, selectable, unusable_reason].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



238
239
240
241
242
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 238

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 324

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



246
247
248
249
250
251
 
# File 'lib/zernio-sdk/models/list_ad_accounts200_response_accounts_inner.rb', line 246

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  billing_status_validator = EnumAttributeValidator.new('String', ["ok", "missing", "unknown"])
  return false unless billing_status_validator.valid?(@billing_status)
  true
end