Class: DocuSign_Admin::SubscriptionProvisionModelAssetGroupWork

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionProvisionModelAssetGroupWork

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
235
236
237
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 174

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'AssetGroupWorkId')
    self.asset_group_work_id = attributes[:'AssetGroupWorkId']
  end

  if attributes.has_key?(:'AssetGroupId')
    self.asset_group_id = attributes[:'AssetGroupId']
  end

  if attributes.has_key?(:'AssetGroupWorkType')
    self.asset_group_work_type = attributes[:'AssetGroupWorkType']
  end

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

  if attributes.has_key?(:'OrderId')
    self.order_id = attributes[:'OrderId']
  end

  if attributes.has_key?(:'TargetAccountId')
    self. = attributes[:'TargetAccountId']
  end

  if attributes.has_key?(:'SourceAccountId')
    self. = attributes[:'SourceAccountId']
  end

  if attributes.has_key?(:'SourceAccountExternalId')
    self. = attributes[:'SourceAccountExternalId']
  end

  if attributes.has_key?(:'SourceAccountName')
    self. = attributes[:'SourceAccountName']
  end

  if attributes.has_key?(:'SourceAccountSite')
    self. = attributes[:'SourceAccountSite']
  end

  if attributes.has_key?(:'CloneRequestId')
    self.clone_request_id = attributes[:'CloneRequestId']
  end

  if attributes.has_key?(:'CloneAccountDetails')
    self. = attributes[:'CloneAccountDetails']
  end

  if attributes.has_key?(:'CreateSubAccountDetails')
    self. = attributes[:'CreateSubAccountDetails']
  end

  if attributes.has_key?(:'Attempts')
    self.attempts = attributes[:'Attempts']
  end

  if attributes.has_key?(:'RetryOn')
    self.retry_on = attributes[:'RetryOn']
  end

  if attributes.has_key?(:'Message')
    self.message = attributes[:'Message']
  end

  if attributes.has_key?(:'CreatedByName')
    self.created_by_name = attributes[:'CreatedByName']
  end

  if attributes.has_key?(:'CreatedByEmail')
    self.created_by_email = attributes[:'CreatedByEmail']
  end

  if attributes.has_key?(:'ErrorDetails')
    self.error_details = attributes[:'ErrorDetails']
  end

  if attributes.has_key?(:'OldAssetGroupSubscriptionId')
    self.old_asset_group_subscription_id = attributes[:'OldAssetGroupSubscriptionId']
  end

  if attributes.has_key?(:'NewAssetGroupSubscriptionId')
    self.new_asset_group_subscription_id = attributes[:'NewAssetGroupSubscriptionId']
  end

  if attributes.has_key?(:'SourceSystem')
    self.source_system = attributes[:'SourceSystem']
  end

  if attributes.has_key?(:'SourceId')
    self.source_id = attributes[:'SourceId']
  end

  if attributes.has_key?(:'CreatedBy')
    self.created_by = attributes[:'CreatedBy']
  end

  if attributes.has_key?(:'CreatedByType')
    self.created_by_type = attributes[:'CreatedByType']
  end

  if attributes.has_key?(:'CreatedDate')
    self.created_date = attributes[:'CreatedDate']
  end

  if attributes.has_key?(:'UpdatedBy')
    self.updated_by = attributes[:'UpdatedBy']
  end

  if attributes.has_key?(:'UpdatedByType')
    self.updated_by_type = attributes[:'UpdatedByType']
  end

  if attributes.has_key?(:'UpdatedDate')
    self.updated_date = attributes[:'UpdatedDate']
  end

  if attributes.has_key?(:'UpdateHistory')
    if (value = attributes[:'UpdateHistory']).is_a?(Array)
      self.update_history = value
    end
  end
end

Instance Attribute Details

#asset_group_idObject

Returns the value of attribute asset_group_id.



18
19
20
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 18

def asset_group_id
  @asset_group_id
end

#asset_group_work_idObject

Returns the value of attribute asset_group_work_id.



16
17
18
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 16

def asset_group_work_id
  @asset_group_work_id
end

#asset_group_work_typeObject

Returns the value of attribute asset_group_work_type.



20
21
22
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 20

def asset_group_work_type
  @asset_group_work_type
end

#attemptsObject

Returns the value of attribute attempts.



42
43
44
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 42

def attempts
  @attempts
end

#clone_account_detailsObject

Returns the value of attribute clone_account_details.



38
39
40
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 38

def 
  @clone_account_details
end

#clone_request_idObject

Returns the value of attribute clone_request_id.



36
37
38
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 36

def clone_request_id
  @clone_request_id
end

#create_sub_account_detailsObject

Returns the value of attribute create_sub_account_details.



40
41
42
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 40

def 
  @create_sub_account_details
end

#created_byObject

Returns the value of attribute created_by.



62
63
64
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 62

def created_by
  @created_by
end

#created_by_emailObject

Returns the value of attribute created_by_email.



50
51
52
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 50

def created_by_email
  @created_by_email
end

#created_by_nameObject

Returns the value of attribute created_by_name.



48
49
50
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 48

def created_by_name
  @created_by_name
end

#created_by_typeObject

0 stands for Application, 1 stands for User, 2 stands for Generic, 3 stands for RestAPIAuth, 4 stands for Resource, 5 stands for Restricted



65
66
67
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 65

def created_by_type
  @created_by_type
end

#created_dateObject

Returns the value of attribute created_date.



67
68
69
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 67

def created_date
  @created_date
end

#error_detailsObject

Returns the value of attribute error_details.



52
53
54
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 52

def error_details
  @error_details
end

#messageObject

Returns the value of attribute message.



46
47
48
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 46

def message
  @message
end

#new_asset_group_subscription_idObject

Returns the value of attribute new_asset_group_subscription_id.



56
57
58
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 56

def new_asset_group_subscription_id
  @new_asset_group_subscription_id
end

#old_asset_group_subscription_idObject

Returns the value of attribute old_asset_group_subscription_id.



54
55
56
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 54

def old_asset_group_subscription_id
  @old_asset_group_subscription_id
end

#order_idObject

Returns the value of attribute order_id.



24
25
26
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 24

def order_id
  @order_id
end

#retry_onObject

Returns the value of attribute retry_on.



44
45
46
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 44

def retry_on
  @retry_on
end

#source_account_external_idObject

Returns the value of attribute source_account_external_id.



30
31
32
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 30

def 
  @source_account_external_id
end

#source_account_idObject

Returns the value of attribute source_account_id.



28
29
30
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 28

def 
  @source_account_id
end

#source_account_nameObject

Returns the value of attribute source_account_name.



32
33
34
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 32

def 
  @source_account_name
end

#source_account_siteObject

Returns the value of attribute source_account_site.



34
35
36
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 34

def 
  @source_account_site
end

#source_idObject

Returns the value of attribute source_id.



60
61
62
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 60

def source_id
  @source_id
end

#source_systemObject

Returns the value of attribute source_system.



58
59
60
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 58

def source_system
  @source_system
end

#statusObject

Returns the value of attribute status.



22
23
24
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 22

def status
  @status
end

#target_account_idObject

Returns the value of attribute target_account_id.



26
27
28
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 26

def 
  @target_account_id
end

#update_historyObject

Returns the value of attribute update_history.



76
77
78
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 76

def update_history
  @update_history
end

#updated_byObject

Returns the value of attribute updated_by.



69
70
71
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 69

def updated_by
  @updated_by
end

#updated_by_typeObject

0 stands for Application, 1 stands for User, 2 stands for Generic, 3 stands for RestAPIAuth, 4 stands for Resource, 5 stands for Restricted



72
73
74
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 72

def updated_by_type
  @updated_by_type
end

#updated_dateObject

Returns the value of attribute updated_date.



74
75
76
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 74

def updated_date
  @updated_date
end

Class Method Details

.attribute_mapObject

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



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
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 101

def self.attribute_map
  {
    :'asset_group_work_id' => :'AssetGroupWorkId',
    :'asset_group_id' => :'AssetGroupId',
    :'asset_group_work_type' => :'AssetGroupWorkType',
    :'status' => :'Status',
    :'order_id' => :'OrderId',
    :'target_account_id' => :'TargetAccountId',
    :'source_account_id' => :'SourceAccountId',
    :'source_account_external_id' => :'SourceAccountExternalId',
    :'source_account_name' => :'SourceAccountName',
    :'source_account_site' => :'SourceAccountSite',
    :'clone_request_id' => :'CloneRequestId',
    :'clone_account_details' => :'CloneAccountDetails',
    :'create_sub_account_details' => :'CreateSubAccountDetails',
    :'attempts' => :'Attempts',
    :'retry_on' => :'RetryOn',
    :'message' => :'Message',
    :'created_by_name' => :'CreatedByName',
    :'created_by_email' => :'CreatedByEmail',
    :'error_details' => :'ErrorDetails',
    :'old_asset_group_subscription_id' => :'OldAssetGroupSubscriptionId',
    :'new_asset_group_subscription_id' => :'NewAssetGroupSubscriptionId',
    :'source_system' => :'SourceSystem',
    :'source_id' => :'SourceId',
    :'created_by' => :'CreatedBy',
    :'created_by_type' => :'CreatedByType',
    :'created_date' => :'CreatedDate',
    :'updated_by' => :'UpdatedBy',
    :'updated_by_type' => :'UpdatedByType',
    :'updated_date' => :'UpdatedDate',
    :'update_history' => :'UpdateHistory'
  }
end

.swagger_typesObject

Attribute type mapping.



137
138
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
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 137

def self.swagger_types
  {
    :'asset_group_work_id' => :'String',
    :'asset_group_id' => :'String',
    :'asset_group_work_type' => :'String',
    :'status' => :'String',
    :'order_id' => :'String',
    :'target_account_id' => :'String',
    :'source_account_id' => :'String',
    :'source_account_external_id' => :'Integer',
    :'source_account_name' => :'String',
    :'source_account_site' => :'String',
    :'clone_request_id' => :'String',
    :'clone_account_details' => :'SubscriptionProvisionModelAccountCreateCreateAccountDetails',
    :'create_sub_account_details' => :'SubscriptionProvisionModelAccountCreateCreateSubAccountDetails',
    :'attempts' => :'Integer',
    :'retry_on' => :'DateTime',
    :'message' => :'String',
    :'created_by_name' => :'String',
    :'created_by_email' => :'String',
    :'error_details' => :'SubscriptionProvisionModelServiceErrorDetails',
    :'old_asset_group_subscription_id' => :'String',
    :'new_asset_group_subscription_id' => :'String',
    :'source_system' => :'String',
    :'source_id' => :'String',
    :'created_by' => :'String',
    :'created_by_type' => :'Integer',
    :'created_date' => :'DateTime',
    :'updated_by' => :'String',
    :'updated_by_type' => :'Integer',
    :'updated_date' => :'DateTime',
    :'update_history' => :'Array<SubscriptionProvisionModelChangeEvent>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 366

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      asset_group_work_id == o.asset_group_work_id &&
      asset_group_id == o.asset_group_id &&
      asset_group_work_type == o.asset_group_work_type &&
      status == o.status &&
      order_id == o.order_id &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      clone_request_id == o.clone_request_id &&
       == o. &&
       == o. &&
      attempts == o.attempts &&
      retry_on == o.retry_on &&
      message == o.message &&
      created_by_name == o.created_by_name &&
      created_by_email == o.created_by_email &&
      error_details == o.error_details &&
      old_asset_group_subscription_id == o.old_asset_group_subscription_id &&
      new_asset_group_subscription_id == o.new_asset_group_subscription_id &&
      source_system == o.source_system &&
      source_id == o.source_id &&
      created_by == o.created_by &&
      created_by_type == o.created_by_type &&
      created_date == o.created_date &&
      updated_by == o.updated_by &&
      updated_by_type == o.updated_by_type &&
      updated_date == o.updated_date &&
      update_history == o.update_history
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 437

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_Admin.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



503
504
505
506
507
508
509
510
511
512
513
514
515
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 503

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 416

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


403
404
405
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 403

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



409
410
411
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 409

def hash
  [asset_group_work_id, asset_group_id, asset_group_work_type, status, order_id, , , , , , clone_request_id, , , attempts, retry_on, message, created_by_name, created_by_email, error_details, old_asset_group_subscription_id, new_asset_group_subscription_id, source_system, source_id, created_by, created_by_type, created_date, updated_by, updated_by_type, updated_date, update_history].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



305
306
307
308
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 305

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



483
484
485
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 483

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



489
490
491
492
493
494
495
496
497
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 489

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



477
478
479
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 477

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



312
313
314
315
316
317
318
319
320
321
322
# File 'lib/docusign_admin/models/subscription_provision_model_asset_group_work.rb', line 312

def valid?
  asset_group_work_type_validator = EnumAttributeValidator.new('String', ['Undefined', 'GroupAssetFulfillment', 'AccountAssetFulfillment', 'AccountAssetClone', 'AccountAssetCreate', 'SubscriptionSync'])
  return false unless asset_group_work_type_validator.valid?(@asset_group_work_type)
  status_validator = EnumAttributeValidator.new('String', ['Undefined', 'Pending', 'Processing', 'ProcessingOnHold', 'PendingError', 'ProcessingError', 'Completed', 'Canceled', 'PermanentFailure'])
  return false unless status_validator.valid?(@status)
  created_by_type_validator = EnumAttributeValidator.new('Integer', ['0', '1', '2', '3', '4', '5'])
  return false unless created_by_type_validator.valid?(@created_by_type)
  updated_by_type_validator = EnumAttributeValidator.new('Integer', ['0', '1', '2', '3', '4', '5'])
  return false unless updated_by_type_validator.valid?(@updated_by_type)
  true
end