Class: Zernio::WebhookPayloadPostPlatformPlatform

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

Overview

The specific platform that transitioned to a terminal state.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
159
160
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 111

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

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

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

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

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

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

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

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

Instance Attribute Details

#deleted_at ⇒ Object

When the platform-side deletion was detected by Zernio sync (ISO 8601). Present only on post.platform.deleted.



41
42
43
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 41

def deleted_at
  @deleted_at
end

#error ⇒ Object

Error message from the platform. Present on failed only.



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

def error
  @error
end

#error_category ⇒ Object

Error category for programmatic handling. Present on failed only. Same taxonomy as platforms[].errorCategory on GET /v1/posts.



35
36
37
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 35

def error_category
  @error_category
end

#error_source ⇒ Object

Who must act on the failure: user (fix content or reconnect), platform (outage or policy), system (Zernio). Present on failed only.



38
39
40
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 38

def error_source
  @error_source
end

#name ⇒ Object

Platform name (e.g. twitter, tiktok, instagram).



20
21
22
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 20

def name
  @name
end

#platform_post_id ⇒ Object

Platform-native post id. Present on published and deleted, absent on failed.



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

def platform_post_id
  @platform_post_id
end

#published_url ⇒ Object

Public URL to the platform-side post. Present on published (when the platform exposes one and it is not a draft) and on deleted (when one was recorded at publish time).



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

def published_url
  @published_url
end

#status ⇒ Object

Terminal status this event fires on. Matches the event suffix.



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

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



80
81
82
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 66

def self.attribute_map
  {
    :'name' => :'name',
    :'status' => :'status',
    :'platform_post_id' => :'platformPostId',
    :'published_url' => :'publishedUrl',
    :'error' => :'error',
    :'error_category' => :'errorCategory',
    :'error_source' => :'errorSource',
    :'deleted_at' => :'deletedAt'
  }
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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 263

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



104
105
106
107
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 90

def self.openapi_types
  {
    :'name' => :'String',
    :'status' => :'String',
    :'platform_post_id' => :'String',
    :'published_url' => :'String',
    :'error' => :'String',
    :'error_category' => :'String',
    :'error_source' => :'String',
    :'deleted_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      status == o.status &&
      platform_post_id == o.platform_post_id &&
      published_url == o.published_url &&
      error == o.error &&
      error_category == o.error_category &&
      error_source == o.error_source &&
      deleted_at == o.deleted_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 256

def hash
  [name, status, platform_post_id, published_url, error, error_category, error_source, deleted_at].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



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 164

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

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 285

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



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb', line 180

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["published", "failed", "deleted"])
  return false unless status_validator.valid?(@status)
  error_category_validator = EnumAttributeValidator.new('String', ["auth_expired", "user_content", "user_abuse", "account_issue", "platform_rejected", "platform_error", "platform_rate_limit", "quota_exhausted", "system_error", "unknown"])
  return false unless error_category_validator.valid?(@error_category)
  error_source_validator = EnumAttributeValidator.new('String', ["user", "platform", "system"])
  return false unless error_source_validator.valid?(@error_source)
  true
end