Class: DocuSign_Click::ClickwrapVersionDeleteResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_click/models/clickwrap_version_delete_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClickwrapVersionDeleteResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
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
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
161
162
163
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 100

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?(:'clickwrapVersionId')
    self.clickwrap_version_id = attributes[:'clickwrapVersionId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#clickwrap_version_id ⇒ Object

The unique version ID, a GUID, of this clickwrap version.



17
18
19
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 17

def clickwrap_version_id
  @clickwrap_version_id
end

#created_time ⇒ Object

The time that the clickwrap was created.



20
21
22
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 20

def created_time
  @created_time
end

#data_fields ⇒ Object

The list of all the data fields available for the clickwrap (custom fields and standard fields).



23
24
25
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 23

def data_fields
  @data_fields
end

#deletion_message ⇒ Object

A message describing the result of deletion request. One of: - alreadyDeleted: Clickwrap is already deleted. - deletionSuccess: Successfully deleted the clickwrap. - deletionFailure: Failed to delete the clickwrap. - cannotDelete: Active clickwrap version cannot be deleted.



26
27
28
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 26

def deletion_message
  @deletion_message
end

#deletion_success ⇒ Object

True if the clickwrap was deleted successfully. False otherwise.



29
30
31
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 29

def deletion_success
  @deletion_success
end

#last_modified ⇒ Object

The time that the clickwrap was last modified.



32
33
34
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 32

def last_modified
  @last_modified
end

#last_modified_by ⇒ Object

The user ID of the last user who modified this clickwrap.



35
36
37
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 35

def last_modified_by
  @last_modified_by
end

#owner_user_id ⇒ Object

The user ID of the owner of this clickwrap.



38
39
40
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 38

def owner_user_id
  @owner_user_id
end

#require_reacceptance ⇒ Object

When **true,** requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.



41
42
43
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 41

def require_reacceptance
  @require_reacceptance
end

#scheduled_date ⇒ Object

The time and date when this clickwrap is activated.



44
45
46
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 44

def scheduled_date
  @scheduled_date
end

#scheduled_reacceptance ⇒ Object

Specifies the interval between reacceptances in days, weeks, months, or years.



47
48
49
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 47

def scheduled_reacceptance
  @scheduled_reacceptance
end

#status ⇒ Object

Clickwrap status. Possible values: - active - inactive - deleted



50
51
52
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 50

def status
  @status
end

#version_id ⇒ Object

The ID of the version.



53
54
55
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 53

def version_id
  @version_id
end

#version_number ⇒ Object

Version of the clickwrap.



56
57
58
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 56

def version_number
  @version_number
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 59

def self.attribute_map
  {
    :'clickwrap_version_id' => :'clickwrapVersionId',
    :'created_time' => :'createdTime',
    :'data_fields' => :'dataFields',
    :'deletion_message' => :'deletionMessage',
    :'deletion_success' => :'deletionSuccess',
    :'last_modified' => :'lastModified',
    :'last_modified_by' => :'lastModifiedBy',
    :'owner_user_id' => :'ownerUserId',
    :'require_reacceptance' => :'requireReacceptance',
    :'scheduled_date' => :'scheduledDate',
    :'scheduled_reacceptance' => :'scheduledReacceptance',
    :'status' => :'status',
    :'version_id' => :'versionId',
    :'version_number' => :'versionNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'clickwrap_version_id' => :'String',
    :'created_time' => :'Object',
    :'data_fields' => :'Array<DataField>',
    :'deletion_message' => :'String',
    :'deletion_success' => :'BOOLEAN',
    :'last_modified' => :'Object',
    :'last_modified_by' => :'String',
    :'owner_user_id' => :'String',
    :'require_reacceptance' => :'BOOLEAN',
    :'scheduled_date' => :'Object',
    :'scheduled_reacceptance' => :'ClickwrapScheduledReacceptance',
    :'status' => :'String',
    :'version_id' => :'String',
    :'version_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      clickwrap_version_id == o.clickwrap_version_id &&
      created_time == o.created_time &&
      data_fields == o.data_fields &&
      deletion_message == o.deletion_message &&
      deletion_success == o.deletion_success &&
      last_modified == o.last_modified &&
      last_modified_by == o.last_modified_by &&
      owner_user_id == o.owner_user_id &&
      require_reacceptance == o.require_reacceptance &&
      scheduled_date == o.scheduled_date &&
      scheduled_reacceptance == o.scheduled_reacceptance &&
      status == o.status &&
      version_id == o.version_id &&
      version_number == o.version_number
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



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
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 235

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_Click.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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 301

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 214

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


201
202
203
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 207

def hash
  [clickwrap_version_id, created_time, data_fields, deletion_message, deletion_success, last_modified, last_modified_by, owner_user_id, require_reacceptance, scheduled_date, scheduled_reacceptance, status, version_id, version_number].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



167
168
169
170
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 167

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



281
282
283
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 281

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



287
288
289
290
291
292
293
294
295
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 287

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



275
276
277
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 275

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



174
175
176
 
# File 'lib/docusign_click/models/clickwrap_version_delete_response.rb', line 174

def valid?
  true
end