Class: DocuSign_eSign::Workspace

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/workspace.rb

Overview

Provides properties that describe a workspace.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Workspace

Initializes the object

Parameters:

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

    Model attributes in the form of hash


93
94
95
96
97
98
99
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
# File 'lib/docusign_esign/models/workspace.rb', line 93

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billable_account_idObject

Returns the value of attribute billable_account_id


19
20
21
# File 'lib/docusign_esign/models/workspace.rb', line 19

def 
  @billable_account_id
end

#caller_informationObject

Returns the value of attribute caller_information


21
22
23
# File 'lib/docusign_esign/models/workspace.rb', line 21

def caller_information
  @caller_information
end

#createdObject

Returns the value of attribute created


24
25
26
# File 'lib/docusign_esign/models/workspace.rb', line 24

def created
  @created
end

#created_by_informationObject

Returns the value of attribute created_by_information


26
27
28
# File 'lib/docusign_esign/models/workspace.rb', line 26

def created_by_information
  @created_by_information
end

#last_modifiedObject

Utc date and time the comment was last updated (can only be done by creator.)


29
30
31
# File 'lib/docusign_esign/models/workspace.rb', line 29

def last_modified
  @last_modified
end

#last_modified_by_informationObject

Returns the value of attribute last_modified_by_information


31
32
33
# File 'lib/docusign_esign/models/workspace.rb', line 31

def last_modified_by_information
  @last_modified_by_information
end

#settingsObject

Returns the value of attribute settings


33
34
35
# File 'lib/docusign_esign/models/workspace.rb', line 33

def settings
  @settings
end

#statusObject

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.


36
37
38
# File 'lib/docusign_esign/models/workspace.rb', line 36

def status
  @status
end

#workspace_base_urlObject

The relative URL that may be used to access the workspace.


39
40
41
# File 'lib/docusign_esign/models/workspace.rb', line 39

def workspace_base_url
  @workspace_base_url
end

#workspace_descriptionObject

Text describing the purpose of the workspace.


42
43
44
# File 'lib/docusign_esign/models/workspace.rb', line 42

def workspace_description
  @workspace_description
end

#workspace_idObject

The id of the workspace, always populated.


45
46
47
# File 'lib/docusign_esign/models/workspace.rb', line 45

def workspace_id
  @workspace_id
end

#workspace_nameObject

The name of the workspace.


48
49
50
# File 'lib/docusign_esign/models/workspace.rb', line 48

def workspace_name
  @workspace_name
end

#workspace_uriObject

The relative URI that may be used to access the workspace.


51
52
53
# File 'lib/docusign_esign/models/workspace.rb', line 51

def workspace_uri
  @workspace_uri
end

Class Method Details

.attribute_mapObject

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


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/docusign_esign/models/workspace.rb', line 54

def self.attribute_map
  {
    :'billable_account_id' => :'billableAccountId',
    :'caller_information' => :'callerInformation',
    :'created' => :'created',
    :'created_by_information' => :'createdByInformation',
    :'last_modified' => :'lastModified',
    :'last_modified_by_information' => :'lastModifiedByInformation',
    :'settings' => :'settings',
    :'status' => :'status',
    :'workspace_base_url' => :'workspaceBaseUrl',
    :'workspace_description' => :'workspaceDescription',
    :'workspace_id' => :'workspaceId',
    :'workspace_name' => :'workspaceName',
    :'workspace_uri' => :'workspaceUri'
  }
end

.swagger_typesObject

Attribute type mapping.


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/docusign_esign/models/workspace.rb', line 73

def self.swagger_types
  {
    :'billable_account_id' => :'String',
    :'caller_information' => :'WorkspaceUser',
    :'created' => :'String',
    :'created_by_information' => :'WorkspaceUser',
    :'last_modified' => :'String',
    :'last_modified_by_information' => :'WorkspaceUser',
    :'settings' => :'WorkspaceSettings',
    :'status' => :'String',
    :'workspace_base_url' => :'String',
    :'workspace_description' => :'String',
    :'workspace_id' => :'String',
    :'workspace_name' => :'String',
    :'workspace_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/docusign_esign/models/workspace.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      caller_information == o.caller_information &&
      created == o.created &&
      created_by_information == o.created_by_information &&
      last_modified == o.last_modified &&
      last_modified_by_information == o.last_modified_by_information &&
      settings == o.settings &&
      status == o.status &&
      workspace_base_url == o.workspace_base_url &&
      workspace_description == o.workspace_description &&
      workspace_id == o.workspace_id &&
      workspace_name == o.workspace_name &&
      workspace_uri == o.workspace_uri
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


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
# File 'lib/docusign_esign/models/workspace.rb', line 221

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


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

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


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/docusign_esign/models/workspace.rb', line 200

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

187
188
189
# File 'lib/docusign_esign/models/workspace.rb', line 187

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


193
194
195
# File 'lib/docusign_esign/models/workspace.rb', line 193

def hash
  [, caller_information, created, created_by_information, last_modified, last_modified_by_information, settings, status, workspace_base_url, workspace_description, workspace_id, workspace_name, workspace_uri].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


154
155
156
157
# File 'lib/docusign_esign/models/workspace.rb', line 154

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


267
268
269
# File 'lib/docusign_esign/models/workspace.rb', line 267

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


273
274
275
276
277
278
279
280
281
# File 'lib/docusign_esign/models/workspace.rb', line 273

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


261
262
263
# File 'lib/docusign_esign/models/workspace.rb', line 261

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


161
162
163
# File 'lib/docusign_esign/models/workspace.rb', line 161

def valid?
  true
end