Class: DocuSign_eSign::BccEmailArchive

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BccEmailArchive

Initializes the object

Parameters:

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

    Model attributes in the form of hash


79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 79

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_idObject

The account ID associated with the envelope.


18
19
20
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 18

def 
  @account_id
end

#bcc_email_archive_idObject

Returns the value of attribute bcc_email_archive_id


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

def bcc_email_archive_id
  @bcc_email_archive_id
end

#createdObject

Returns the value of attribute created


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

def created
  @created
end

#created_byObject

Returns the value of attribute created_by


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

def created_by
  @created_by
end

#emailObject

Returns the value of attribute email


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

def email
  @email
end

#email_notification_idObject

Returns the value of attribute email_notification_id


32
33
34
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 32

def email_notification_id
  @email_notification_id
end

#modifiedObject

Returns the value of attribute modified


35
36
37
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 35

def modified
  @modified
end

#modified_byObject

Returns the value of attribute modified_by


37
38
39
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 37

def modified_by
  @modified_by
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.


40
41
42
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 40

def status
  @status
end

#uriObject

Returns the value of attribute uri


43
44
45
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 43

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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


46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 46

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'bcc_email_archive_id' => :'bccEmailArchiveId',
    :'created' => :'created',
    :'created_by' => :'createdBy',
    :'email' => :'email',
    :'email_notification_id' => :'emailNotificationId',
    :'modified' => :'modified',
    :'modified_by' => :'modifiedBy',
    :'status' => :'status',
    :'uri' => :'uri'
  }
end

.swagger_typesObject

Attribute type mapping.


62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 62

def self.swagger_types
  {
    :'account_id' => :'String',
    :'bcc_email_archive_id' => :'String',
    :'created' => :'String',
    :'created_by' => :'UserInfo',
    :'email' => :'String',
    :'email_notification_id' => :'String',
    :'modified' => :'String',
    :'modified_by' => :'UserInfo',
    :'status' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      bcc_email_archive_id == o.bcc_email_archive_id &&
      created == o.created &&
      created_by == o.created_by &&
      email == o.email &&
      email_notification_id == o.email_notification_id &&
      modified == o.modified &&
      modified_by == o.modified_by &&
      status == o.status &&
      uri == o.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


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

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


258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 258

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


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 171

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

158
159
160
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 158

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


164
165
166
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 164

def hash
  [, bcc_email_archive_id, created, created_by, email, email_notification_id, modified, modified_by, status, 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


128
129
130
131
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 128

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


238
239
240
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 238

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


244
245
246
247
248
249
250
251
252
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 244

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


232
233
234
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 232

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


135
136
137
# File 'lib/docusign_esign/models/bcc_email_archive.rb', line 135

def valid?
  true
end