Class: Shipeasy::Admin::Generated::ConnectorRecord

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/shipeasy_admin/models/connector_record.rb

Overview

A connector row. The encrypted credentials cipher backing the connector is intentionally never serialised.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



139
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 139

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

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

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

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

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

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

  if attributes.key?(:'config')
    if (value = attributes[:'config']).is_a?(Hash)
      self.config = value
    end
  else
    self.config = nil
  end

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

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

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

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

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

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

Instance Attribute Details

#account_label ⇒ Object

Display label for the connected account / target (e.g. the OAuth account email, or a trigger's idempotency key such as its repo url or routine id). null until the connector is authenticated/configured.



40
41
42
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 40

def 
  @account_label
end

#config ⇒ Object

Provider-specific, non-secret configuration (e.g. a Google Sheets spreadsheetId/sheetTitle, a Slack channel ref, or a trigger's repo coordinates + routine id). Secrets are never stored here — they live in an encrypted credentials cipher that is never returned by the API.



37
38
39
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 37

def config
  @config
end

#created_at ⇒ Object

ISO-8601 timestamp of creation.



52
53
54
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 52

def created_at
  @created_at
end

#enabled ⇒ Object

Whether the connector is active. OAuth providers are created false and flip to true only after the OAuth/config flow completes; trigger providers default to true on create. A disabled connector never dispatches and never auto-fires.



31
32
33
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 31

def enabled
  @enabled
end

#events ⇒ Object

Events this connector is subscribed to. Empty array = no auto-dispatch / no auto-fire (the connector can still be fired/tested manually).



34
35
36
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 34

def events
  @events
end

#id ⇒ Object

Stable opaque connector id (a UUID).



20
21
22
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 20

def id
  @id
end

#last_attempt_at ⇒ Object

ISO-8601 timestamp of the most recent dispatch/fire attempt, or null if none has run.



46
47
48
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 46

def last_attempt_at
  @last_attempt_at
end

#last_error ⇒ Object

Error message from the most recent failed dispatch/fire attempt, or null if the last attempt succeeded (or none has run).



43
44
45
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 43

def last_error
  @last_error
end

#last_success_at ⇒ Object

ISO-8601 timestamp of the most recent successful dispatch/fire, or null if none has succeeded. Preserved across later failures.



49
50
51
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 49

def last_success_at
  @last_success_at
end

#name ⇒ Object

Human-readable connector label shown in the dashboard.



28
29
30
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 28

def name
  @name
end

#project_id ⇒ Object

Id of the project the connector belongs to.



23
24
25
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 23

def project_id
  @project_id
end

#provider ⇒ Object

Returns the value of attribute provider.



25
26
27
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 25

def provider
  @provider
end

#updated_at ⇒ Object

ISO-8601 timestamp of last mutation.



55
56
57
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 55

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



99
100
101
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 99

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 104

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 80

def self.attribute_map
  {
    :'id' => :'id',
    :'project_id' => :'projectId',
    :'provider' => :'provider',
    :'name' => :'name',
    :'enabled' => :'enabled',
    :'events' => :'events',
    :'config' => :'config',
    :'account_label' => :'accountLabel',
    :'last_error' => :'lastError',
    :'last_attempt_at' => :'lastAttemptAt',
    :'last_success_at' => :'lastSuccessAt',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 430

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



128
129
130
131
132
133
134
135
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 128

def self.openapi_nullable
  Set.new([
    :'account_label',
    :'last_error',
    :'last_attempt_at',
    :'last_success_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 109

def self.openapi_types
  {
    :'id' => :'String',
    :'project_id' => :'String',
    :'provider' => :'ConnectorProvider',
    :'name' => :'String',
    :'enabled' => :'Boolean',
    :'events' => :'Array<ConnectorEvent>',
    :'config' => :'Hash<String, Object>',
    :'account_label' => :'String',
    :'last_error' => :'String',
    :'last_attempt_at' => :'String',
    :'last_success_at' => :'String',
    :'created_at' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 397

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      project_id == o.project_id &&
      provider == o.provider &&
      name == o.name &&
      enabled == o.enabled &&
      events == o.events &&
      config == o.config &&
       == o. &&
      last_error == o.last_error &&
      last_attempt_at == o.last_attempt_at &&
      last_success_at == o.last_success_at &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


417
418
419
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 417

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



423
424
425
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 423

def hash
  [id, project_id, provider, name, enabled, events, config, , last_error, last_attempt_at, last_success_at, created_at, updated_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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 238

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

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

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

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

  if @name.to_s.length > 80
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 80.')
  end

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

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

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

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

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



452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 452

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/shipeasy_admin/models/connector_record.rb', line 286

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @project_id.nil?
  return false if @provider.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 80
  return false if @enabled.nil?
  return false if @events.nil?
  return false if @config.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end