Class: DocuSign_eSign::RecipientPreviewRequest
- Inherits:
-
Object
- Object
- DocuSign_eSign::RecipientPreviewRequest
- Defined in:
- lib/docusign_esign/models/recipient_preview_request.rb
Instance Attribute Summary collapse
-
#assertion_id ⇒ Object
Returns the value of attribute assertion_id.
-
#authentication_instant ⇒ Object
Returns the value of attribute authentication_instant.
-
#authentication_method ⇒ Object
Returns the value of attribute authentication_method.
-
#client_ur_ls ⇒ Object
Returns the value of attribute client_ur_ls.
-
#ping_frequency ⇒ Object
Returns the value of attribute ping_frequency.
-
#ping_url ⇒ Object
Returns the value of attribute ping_url.
-
#recipient_id ⇒ Object
Unique for the recipient.
-
#return_url ⇒ Object
Returns the value of attribute return_url.
-
#security_domain ⇒ Object
Returns the value of attribute security_domain.
-
#x_frame_options ⇒ Object
Returns the value of attribute x_frame_options.
-
#x_frame_options_allow_from_url ⇒ Object
Returns the value of attribute x_frame_options_allow_from_url.
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 = {}) ⇒ RecipientPreviewRequest
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 = {}) ⇒ RecipientPreviewRequest
Initializes the object
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 129 130 131 132 133 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 84 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?(:'assertionId') self.assertion_id = attributes[:'assertionId'] end if attributes.has_key?(:'authenticationInstant') self.authentication_instant = attributes[:'authenticationInstant'] end if attributes.has_key?(:'authenticationMethod') self.authentication_method = attributes[:'authenticationMethod'] end if attributes.has_key?(:'clientURLs') self.client_ur_ls = attributes[:'clientURLs'] end if attributes.has_key?(:'pingFrequency') self.ping_frequency = attributes[:'pingFrequency'] end if attributes.has_key?(:'pingUrl') self.ping_url = attributes[:'pingUrl'] end if attributes.has_key?(:'recipientId') self.recipient_id = attributes[:'recipientId'] end if attributes.has_key?(:'returnUrl') self.return_url = attributes[:'returnUrl'] end if attributes.has_key?(:'securityDomain') self.security_domain = attributes[:'securityDomain'] end if attributes.has_key?(:'xFrameOptions') self. = attributes[:'xFrameOptions'] end if attributes.has_key?(:'xFrameOptionsAllowFromUrl') self. = attributes[:'xFrameOptionsAllowFromUrl'] end end |
Instance Attribute Details
#assertion_id ⇒ Object
Returns the value of attribute assertion_id.
17 18 19 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 17 def assertion_id @assertion_id end |
#authentication_instant ⇒ Object
Returns the value of attribute authentication_instant.
20 21 22 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 20 def authentication_instant @authentication_instant end |
#authentication_method ⇒ Object
Returns the value of attribute authentication_method.
23 24 25 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 23 def authentication_method @authentication_method end |
#client_ur_ls ⇒ Object
Returns the value of attribute client_ur_ls.
25 26 27 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 25 def client_ur_ls @client_ur_ls end |
#ping_frequency ⇒ Object
Returns the value of attribute ping_frequency.
28 29 30 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 28 def ping_frequency @ping_frequency end |
#ping_url ⇒ Object
Returns the value of attribute ping_url.
31 32 33 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 31 def ping_url @ping_url end |
#recipient_id ⇒ Object
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
34 35 36 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 34 def recipient_id @recipient_id end |
#return_url ⇒ Object
Returns the value of attribute return_url.
37 38 39 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 37 def return_url @return_url end |
#security_domain ⇒ Object
Returns the value of attribute security_domain.
40 41 42 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 40 def security_domain @security_domain end |
#x_frame_options ⇒ Object
Returns the value of attribute x_frame_options.
43 44 45 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 43 def @x_frame_options end |
#x_frame_options_allow_from_url ⇒ Object
Returns the value of attribute x_frame_options_allow_from_url.
46 47 48 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 46 def @x_frame_options_allow_from_url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 49 def self.attribute_map { :'assertion_id' => :'assertionId', :'authentication_instant' => :'authenticationInstant', :'authentication_method' => :'authenticationMethod', :'client_ur_ls' => :'clientURLs', :'ping_frequency' => :'pingFrequency', :'ping_url' => :'pingUrl', :'recipient_id' => :'recipientId', :'return_url' => :'returnUrl', :'security_domain' => :'securityDomain', :'x_frame_options' => :'xFrameOptions', :'x_frame_options_allow_from_url' => :'xFrameOptionsAllowFromUrl' } end |
.swagger_types ⇒ Object
Attribute type mapping.
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 66 def self.swagger_types { :'assertion_id' => :'String', :'authentication_instant' => :'String', :'authentication_method' => :'String', :'client_ur_ls' => :'RecipientTokenClientURLs', :'ping_frequency' => :'String', :'ping_url' => :'String', :'recipient_id' => :'String', :'return_url' => :'String', :'security_domain' => :'String', :'x_frame_options' => :'String', :'x_frame_options_allow_from_url' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 150 def ==(o) return true if self.equal?(o) self.class == o.class && assertion_id == o.assertion_id && authentication_instant == o.authentication_instant && authentication_method == o.authentication_method && client_ur_ls == o.client_ur_ls && ping_frequency == o.ping_frequency && ping_url == o.ping_url && recipient_id == o.recipient_id && return_url == o.return_url && security_domain == o.security_domain && == o. && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 233 234 235 236 237 238 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 202 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
268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 268 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
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 181 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
168 169 170 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 168 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
174 175 176 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 174 def hash [assertion_id, authentication_instant, authentication_method, client_ur_ls, ping_frequency, ping_url, recipient_id, return_url, security_domain, , ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
137 138 139 140 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 137 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
248 249 250 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 248 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
254 255 256 257 258 259 260 261 262 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 254 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
242 243 244 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 242 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
144 145 146 |
# File 'lib/docusign_esign/models/recipient_preview_request.rb', line 144 def valid? true end |