Class: DocuSign_eSign::EnvelopeTransferRule

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeTransferRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash


76
77
78
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
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 76

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#carbon_copy_original_ownerObject

Returns the value of attribute carbon_copy_original_owner


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

def carbon_copy_original_owner
  @carbon_copy_original_owner
end

#enabledObject

Returns the value of attribute enabled


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

def enabled
  @enabled
end

#envelope_transfer_rule_idObject

Returns the value of attribute envelope_transfer_rule_id


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

def envelope_transfer_rule_id
  @envelope_transfer_rule_id
end

#event_typeObject

Returns the value of attribute event_type


27
28
29
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 27

def event_type
  @event_type
end

#from_groupObject

Returns the value of attribute from_group


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

def from_group
  @from_group
end

#from_userObject

Returns the value of attribute from_user


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

def from_user
  @from_user
end

#modified_dateObject

Returns the value of attribute modified_date


34
35
36
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 34

def modified_date
  @modified_date
end

#modified_userObject

Returns the value of attribute modified_user


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

def modified_user
  @modified_user
end

#to_folderObject

Returns the value of attribute to_folder


38
39
40
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 38

def to_folder
  @to_folder
end

#to_userObject

Returns the value of attribute to_user


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

def to_user
  @to_user
end

Class Method Details

.attribute_mapObject

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


43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 43

def self.attribute_map
  {
    :'carbon_copy_original_owner' => :'carbonCopyOriginalOwner',
    :'enabled' => :'enabled',
    :'envelope_transfer_rule_id' => :'envelopeTransferRuleId',
    :'event_type' => :'eventType',
    :'from_group' => :'fromGroup',
    :'from_user' => :'fromUser',
    :'modified_date' => :'modifiedDate',
    :'modified_user' => :'modifiedUser',
    :'to_folder' => :'toFolder',
    :'to_user' => :'toUser'
  }
end

.swagger_typesObject

Attribute type mapping.


59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 59

def self.swagger_types
  {
    :'carbon_copy_original_owner' => :'String',
    :'enabled' => :'String',
    :'envelope_transfer_rule_id' => :'String',
    :'event_type' => :'String',
    :'from_group' => :'Group',
    :'from_user' => :'UserInformation',
    :'modified_date' => :'String',
    :'modified_user' => :'UserInformation',
    :'to_folder' => :'Folder',
    :'to_user' => :'UserInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      carbon_copy_original_owner == o.carbon_copy_original_owner &&
      enabled == o.enabled &&
      envelope_transfer_rule_id == o.envelope_transfer_rule_id &&
      event_type == o.event_type &&
      from_group == o.from_group &&
      from_user == o.from_user &&
      modified_date == o.modified_date &&
      modified_user == o.modified_user &&
      to_folder == o.to_folder &&
      to_user == o.to_user
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


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

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


255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 255

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


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

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

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

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


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

def hash
  [carbon_copy_original_owner, enabled, envelope_transfer_rule_id, event_type, from_group, from_user, modified_date, modified_user, to_folder, to_user].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


125
126
127
128
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 125

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


235
236
237
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 235

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


241
242
243
244
245
246
247
248
249
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 241

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


229
230
231
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 229

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


132
133
134
# File 'lib/docusign_esign/models/envelope_transfer_rule.rb', line 132

def valid?
  true
end