Class: Late::PostLog

Inherits:
ApiModelBase show all
Defined in:
lib/late-sdk/models/post_log.rb

Overview

Publishing log entry showing details of a post publishing attempt

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



140
141
142
143
144
145
146
147
148
149
150
151
152
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
 
# File 'lib/late-sdk/models/post_log.rb', line 140

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_id ⇒ Object

Returns the value of attribute _id.



19
20
21
 
# File 'lib/late-sdk/models/post_log.rb', line 19

def _id
  @_id
end

#account_id ⇒ Object

Returns the value of attribute account_id.



29
30
31
 
# File 'lib/late-sdk/models/post_log.rb', line 29

def 
  @account_id
end

#account_username ⇒ Object

Returns the value of attribute account_username.



31
32
33
 
# File 'lib/late-sdk/models/post_log.rb', line 31

def 
  @account_username
end

#action ⇒ Object

Type of action logged: publish (initial attempt), retry (after failure), media_upload, rate_limit_pause, token_refresh, cancelled



34
35
36
 
# File 'lib/late-sdk/models/post_log.rb', line 34

def action
  @action
end

#attempt_number ⇒ Object

Attempt number (1 for first try, 2+ for retries)



52
53
54
 
# File 'lib/late-sdk/models/post_log.rb', line 52

def attempt_number
  @attempt_number
end

#created_at ⇒ Object

Returns the value of attribute created_at.



54
55
56
 
# File 'lib/late-sdk/models/post_log.rb', line 54

def created_at
  @created_at
end

#duration_ms ⇒ Object

How long the operation took in milliseconds



49
50
51
 
# File 'lib/late-sdk/models/post_log.rb', line 49

def duration_ms
  @duration_ms
end

#endpoint ⇒ Object

Platform API endpoint called



42
43
44
 
# File 'lib/late-sdk/models/post_log.rb', line 42

def endpoint
  @endpoint
end

#platform ⇒ Object

Returns the value of attribute platform.



27
28
29
 
# File 'lib/late-sdk/models/post_log.rb', line 27

def platform
  @platform
end

#post_id ⇒ Object

Returns the value of attribute post_id.



21
22
23
 
# File 'lib/late-sdk/models/post_log.rb', line 21

def post_id
  @post_id
end

#profile_id ⇒ Object

Returns the value of attribute profile_id.



25
26
27
 
# File 'lib/late-sdk/models/post_log.rb', line 25

def profile_id
  @profile_id
end

#request ⇒ Object

Returns the value of attribute request.



44
45
46
 
# File 'lib/late-sdk/models/post_log.rb', line 44

def request
  @request
end

#response ⇒ Object

Returns the value of attribute response.



46
47
48
 
# File 'lib/late-sdk/models/post_log.rb', line 46

def response
  @response
end

#status ⇒ Object

Returns the value of attribute status.



36
37
38
 
# File 'lib/late-sdk/models/post_log.rb', line 36

def status
  @status
end

#status_code ⇒ Object

HTTP status code from platform API



39
40
41
 
# File 'lib/late-sdk/models/post_log.rb', line 39

def status_code
  @status_code
end

#user_id ⇒ Object

Returns the value of attribute user_id.



23
24
25
 
# File 'lib/late-sdk/models/post_log.rb', line 23

def user_id
  @user_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



101
102
103
 
# File 'lib/late-sdk/models/post_log.rb', line 101

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



106
107
108
 
# File 'lib/late-sdk/models/post_log.rb', line 106

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/late-sdk/models/post_log.rb', line 79

def self.attribute_map
  {
    :'_id' => :'_id',
    :'post_id' => :'postId',
    :'user_id' => :'userId',
    :'profile_id' => :'profileId',
    :'platform' => :'platform',
    :'account_id' => :'accountId',
    :'account_username' => :'accountUsername',
    :'action' => :'action',
    :'status' => :'status',
    :'status_code' => :'statusCode',
    :'endpoint' => :'endpoint',
    :'request' => :'request',
    :'response' => :'response',
    :'duration_ms' => :'durationMs',
    :'attempt_number' => :'attemptNumber',
    :'created_at' => :'createdAt'
  }
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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/late-sdk/models/post_log.rb', line 308

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



133
134
135
136
 
# File 'lib/late-sdk/models/post_log.rb', line 133

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

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/late-sdk/models/post_log.rb', line 111

def self.openapi_types
  {
    :'_id' => :'String',
    :'post_id' => :'PostLogPostId',
    :'user_id' => :'String',
    :'profile_id' => :'String',
    :'platform' => :'String',
    :'account_id' => :'String',
    :'account_username' => :'String',
    :'action' => :'String',
    :'status' => :'String',
    :'status_code' => :'Integer',
    :'endpoint' => :'String',
    :'request' => :'PostLogRequest',
    :'response' => :'PostLogResponse',
    :'duration_ms' => :'Integer',
    :'attempt_number' => :'Integer',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/late-sdk/models/post_log.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _id == o._id &&
      post_id == o.post_id &&
      user_id == o.user_id &&
      profile_id == o.profile_id &&
      platform == o.platform &&
       == o. &&
       == o. &&
      action == o.action &&
      status == o.status &&
      status_code == o.status_code &&
      endpoint == o.endpoint &&
      request == o.request &&
      response == o.response &&
      duration_ms == o.duration_ms &&
      attempt_number == o.attempt_number &&
      created_at == o.created_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


295
296
297
 
# File 'lib/late-sdk/models/post_log.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/late-sdk/models/post_log.rb', line 301

def hash
  [_id, post_id, user_id, profile_id, platform, , , action, status, status_code, endpoint, request, response, duration_ms, attempt_number, created_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



221
222
223
224
225
 
# File 'lib/late-sdk/models/post_log.rb', line 221

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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/late-sdk/models/post_log.rb', line 330

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



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/late-sdk/models/post_log.rb', line 229

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  platform_validator = EnumAttributeValidator.new('String', ["tiktok", "instagram", "facebook", "youtube", "linkedin", "twitter", "threads", "pinterest", "reddit", "bluesky", "googlebusiness", "telegram", "snapchat"])
  return false unless platform_validator.valid?(@platform)
  action_validator = EnumAttributeValidator.new('String', ["publish", "retry", "media_upload", "rate_limit_pause", "token_refresh", "cancelled"])
  return false unless action_validator.valid?(@action)
  status_validator = EnumAttributeValidator.new('String', ["success", "failed", "pending", "skipped"])
  return false unless status_validator.valid?(@status)
  true
end