Class: DocuSign_eSign::SigningGroup
- Inherits:
-
Object
- Object
- DocuSign_eSign::SigningGroup
- Defined in:
- lib/docusign_esign/models/signing_group.rb
Overview
Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.
Instance Attribute Summary collapse
-
#created ⇒ Object
Returns the value of attribute created.
-
#created_by ⇒ Object
Returns the value of attribute created_by.
-
#error_details ⇒ Object
Array or errors.
-
#group_email ⇒ Object
Returns the value of attribute group_email.
-
#group_name ⇒ Object
The name of the group.
-
#group_type ⇒ Object
Returns the value of attribute group_type.
-
#modified ⇒ Object
Returns the value of attribute modified.
-
#modified_by ⇒ Object
Returns the value of attribute modified_by.
-
#signing_group_id ⇒ Object
When set to true and the feature is enabled in the sender’s account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
-
#users ⇒ Object
Returns the value of attribute users.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SigningGroup
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ SigningGroup
Initializes the object
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 125 126 127 128 |
# File 'lib/docusign_esign/models/signing_group.rb', line 81 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?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'createdBy') self.created_by = attributes[:'createdBy'] end if attributes.has_key?(:'errorDetails') self.error_details = attributes[:'errorDetails'] end if attributes.has_key?(:'groupEmail') self.group_email = attributes[:'groupEmail'] end if attributes.has_key?(:'groupName') self.group_name = attributes[:'groupName'] end if attributes.has_key?(:'groupType') self.group_type = attributes[:'groupType'] 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?(:'signingGroupId') self.signing_group_id = attributes[:'signingGroupId'] end if attributes.has_key?(:'users') if (value = attributes[:'users']).is_a?(Array) self.users = value end end end |
Instance Attribute Details
#created ⇒ Object
Returns the value of attribute created.
18 19 20 |
# File 'lib/docusign_esign/models/signing_group.rb', line 18 def created @created end |
#created_by ⇒ Object
Returns the value of attribute created_by.
21 22 23 |
# File 'lib/docusign_esign/models/signing_group.rb', line 21 def created_by @created_by end |
#error_details ⇒ Object
Array or errors.
24 25 26 |
# File 'lib/docusign_esign/models/signing_group.rb', line 24 def error_details @error_details end |
#group_email ⇒ Object
Returns the value of attribute group_email.
27 28 29 |
# File 'lib/docusign_esign/models/signing_group.rb', line 27 def group_email @group_email end |
#group_name ⇒ Object
The name of the group.
30 31 32 |
# File 'lib/docusign_esign/models/signing_group.rb', line 30 def group_name @group_name end |
#group_type ⇒ Object
Returns the value of attribute group_type.
33 34 35 |
# File 'lib/docusign_esign/models/signing_group.rb', line 33 def group_type @group_type end |
#modified ⇒ Object
Returns the value of attribute modified.
36 37 38 |
# File 'lib/docusign_esign/models/signing_group.rb', line 36 def modified @modified end |
#modified_by ⇒ Object
Returns the value of attribute modified_by.
39 40 41 |
# File 'lib/docusign_esign/models/signing_group.rb', line 39 def modified_by @modified_by end |
#signing_group_id ⇒ Object
When set to true and the feature is enabled in the sender’s account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
42 43 44 |
# File 'lib/docusign_esign/models/signing_group.rb', line 42 def signing_group_id @signing_group_id end |
#users ⇒ Object
Returns the value of attribute users.
45 46 47 |
# File 'lib/docusign_esign/models/signing_group.rb', line 45 def users @users end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/docusign_esign/models/signing_group.rb', line 48 def self.attribute_map { :'created' => :'created', :'created_by' => :'createdBy', :'error_details' => :'errorDetails', :'group_email' => :'groupEmail', :'group_name' => :'groupName', :'group_type' => :'groupType', :'modified' => :'modified', :'modified_by' => :'modifiedBy', :'signing_group_id' => :'signingGroupId', :'users' => :'users' } end |
.swagger_types ⇒ Object
Attribute type mapping.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/docusign_esign/models/signing_group.rb', line 64 def self.swagger_types { :'created' => :'String', :'created_by' => :'String', :'error_details' => :'ErrorDetails', :'group_email' => :'String', :'group_name' => :'String', :'group_type' => :'String', :'modified' => :'String', :'modified_by' => :'String', :'signing_group_id' => :'String', :'users' => :'Array<SigningGroupUser>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/docusign_esign/models/signing_group.rb', line 145 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && created_by == o.created_by && error_details == o.error_details && group_email == o.group_email && group_name == o.group_name && group_type == o.group_type && modified == o.modified && modified_by == o.modified_by && signing_group_id == o.signing_group_id && users == o.users end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/docusign_esign/models/signing_group.rb', line 196 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
262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/docusign_esign/models/signing_group.rb', line 262 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
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/docusign_esign/models/signing_group.rb', line 175 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
162 163 164 |
# File 'lib/docusign_esign/models/signing_group.rb', line 162 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
168 169 170 |
# File 'lib/docusign_esign/models/signing_group.rb', line 168 def hash [created, created_by, error_details, group_email, group_name, group_type, modified, modified_by, signing_group_id, users].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
132 133 134 135 |
# File 'lib/docusign_esign/models/signing_group.rb', line 132 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
242 243 244 |
# File 'lib/docusign_esign/models/signing_group.rb', line 242 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
248 249 250 251 252 253 254 255 256 |
# File 'lib/docusign_esign/models/signing_group.rb', line 248 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
236 237 238 |
# File 'lib/docusign_esign/models/signing_group.rb', line 236 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
139 140 141 |
# File 'lib/docusign_esign/models/signing_group.rb', line 139 def valid? true end |