Class: DocuSign_eSign::ReportInProductRunRequest
- Inherits:
-
Object
- Object
- DocuSign_eSign::ReportInProductRunRequest
- Defined in:
- lib/docusign_esign/models/report_in_product_run_request.rb
Instance Attribute Summary collapse
-
#custom_field_filter ⇒ Object
Returns the value of attribute custom_field_filter.
-
#date_range_custom_from_date ⇒ Object
Returns the value of attribute date_range_custom_from_date.
-
#date_range_custom_to_date ⇒ Object
Returns the value of attribute date_range_custom_to_date.
-
#date_range_filter ⇒ Object
Returns the value of attribute date_range_filter.
-
#envelope_date_type_filter ⇒ Object
Returns the value of attribute envelope_date_type_filter.
-
#envelope_recipient_name_contains_filter ⇒ Object
Returns the value of attribute envelope_recipient_name_contains_filter.
-
#envelope_status_filter ⇒ Object
Returns the value of attribute envelope_status_filter.
-
#envelope_subject_contains_filter ⇒ Object
Returns the value of attribute envelope_subject_contains_filter.
-
#fields ⇒ Object
Returns the value of attribute fields.
-
#for_download ⇒ Object
Returns the value of attribute for_download.
-
#is_dashboard ⇒ Object
Returns the value of attribute is_dashboard.
-
#period_length_filter ⇒ Object
Returns the value of attribute period_length_filter.
-
#report_customized_id ⇒ Object
Returns the value of attribute report_customized_id.
-
#report_description ⇒ Object
Returns the value of attribute report_description.
-
#report_id ⇒ Object
Returns the value of attribute report_id.
-
#report_invocation_type ⇒ Object
Returns the value of attribute report_invocation_type.
-
#report_name ⇒ Object
Returns the value of attribute report_name.
-
#sent_by_filter ⇒ Object
Returns the value of attribute sent_by_filter.
-
#sent_by_ids ⇒ Object
Returns the value of attribute sent_by_ids.
-
#sort_direction ⇒ Object
Returns the value of attribute sort_direction.
-
#sort_field ⇒ Object
Returns the value of attribute sort_field.
-
#start_position ⇒ Object
Starting position of the current result set.
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 = {}) ⇒ ReportInProductRunRequest
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 = {}) ⇒ ReportInProductRunRequest
Initializes the object
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 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 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 141 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?(:'customFieldFilter') self.custom_field_filter = attributes[:'customFieldFilter'] end if attributes.has_key?(:'dateRangeCustomFromDate') self.date_range_custom_from_date = attributes[:'dateRangeCustomFromDate'] end if attributes.has_key?(:'dateRangeCustomToDate') self.date_range_custom_to_date = attributes[:'dateRangeCustomToDate'] end if attributes.has_key?(:'dateRangeFilter') self.date_range_filter = attributes[:'dateRangeFilter'] end if attributes.has_key?(:'envelopeDateTypeFilter') self.envelope_date_type_filter = attributes[:'envelopeDateTypeFilter'] end if attributes.has_key?(:'envelopeRecipientNameContainsFilter') self.envelope_recipient_name_contains_filter = attributes[:'envelopeRecipientNameContainsFilter'] end if attributes.has_key?(:'envelopeStatusFilter') self.envelope_status_filter = attributes[:'envelopeStatusFilter'] end if attributes.has_key?(:'envelopeSubjectContainsFilter') self.envelope_subject_contains_filter = attributes[:'envelopeSubjectContainsFilter'] end if attributes.has_key?(:'fields') if (value = attributes[:'fields']).is_a?(Array) self.fields = value end end if attributes.has_key?(:'forDownload') self.for_download = attributes[:'forDownload'] end if attributes.has_key?(:'isDashboard') self.is_dashboard = attributes[:'isDashboard'] end if attributes.has_key?(:'periodLengthFilter') self.period_length_filter = attributes[:'periodLengthFilter'] end if attributes.has_key?(:'reportCustomizedId') self.report_customized_id = attributes[:'reportCustomizedId'] end if attributes.has_key?(:'reportDescription') self.report_description = attributes[:'reportDescription'] end if attributes.has_key?(:'reportId') self.report_id = attributes[:'reportId'] end if attributes.has_key?(:'reportInvocationType') self.report_invocation_type = attributes[:'reportInvocationType'] end if attributes.has_key?(:'reportName') self.report_name = attributes[:'reportName'] end if attributes.has_key?(:'sentByFilter') self.sent_by_filter = attributes[:'sentByFilter'] end if attributes.has_key?(:'sentByIds') self.sent_by_ids = attributes[:'sentByIds'] end if attributes.has_key?(:'sortDirection') self.sort_direction = attributes[:'sortDirection'] end if attributes.has_key?(:'sortField') self.sort_field = attributes[:'sortField'] end if attributes.has_key?(:'startPosition') self.start_position = attributes[:'startPosition'] end end |
Instance Attribute Details
#custom_field_filter ⇒ Object
Returns the value of attribute custom_field_filter.
18 19 20 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 18 def custom_field_filter @custom_field_filter end |
#date_range_custom_from_date ⇒ Object
Returns the value of attribute date_range_custom_from_date.
21 22 23 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 21 def date_range_custom_from_date @date_range_custom_from_date end |
#date_range_custom_to_date ⇒ Object
Returns the value of attribute date_range_custom_to_date.
24 25 26 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 24 def date_range_custom_to_date @date_range_custom_to_date end |
#date_range_filter ⇒ Object
Returns the value of attribute date_range_filter.
27 28 29 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 27 def date_range_filter @date_range_filter end |
#envelope_date_type_filter ⇒ Object
Returns the value of attribute envelope_date_type_filter.
30 31 32 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 30 def envelope_date_type_filter @envelope_date_type_filter end |
#envelope_recipient_name_contains_filter ⇒ Object
Returns the value of attribute envelope_recipient_name_contains_filter.
33 34 35 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 33 def envelope_recipient_name_contains_filter @envelope_recipient_name_contains_filter end |
#envelope_status_filter ⇒ Object
Returns the value of attribute envelope_status_filter.
36 37 38 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 36 def envelope_status_filter @envelope_status_filter end |
#envelope_subject_contains_filter ⇒ Object
Returns the value of attribute envelope_subject_contains_filter.
39 40 41 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 39 def envelope_subject_contains_filter @envelope_subject_contains_filter end |
#fields ⇒ Object
Returns the value of attribute fields.
42 43 44 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 42 def fields @fields end |
#for_download ⇒ Object
Returns the value of attribute for_download.
45 46 47 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 45 def for_download @for_download end |
#is_dashboard ⇒ Object
Returns the value of attribute is_dashboard.
48 49 50 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 48 def is_dashboard @is_dashboard end |
#period_length_filter ⇒ Object
Returns the value of attribute period_length_filter.
51 52 53 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 51 def period_length_filter @period_length_filter end |
#report_customized_id ⇒ Object
Returns the value of attribute report_customized_id.
54 55 56 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 54 def report_customized_id @report_customized_id end |
#report_description ⇒ Object
Returns the value of attribute report_description.
57 58 59 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 57 def report_description @report_description end |
#report_id ⇒ Object
Returns the value of attribute report_id.
60 61 62 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 60 def report_id @report_id end |
#report_invocation_type ⇒ Object
Returns the value of attribute report_invocation_type.
63 64 65 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 63 def report_invocation_type @report_invocation_type end |
#report_name ⇒ Object
Returns the value of attribute report_name.
66 67 68 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 66 def report_name @report_name end |
#sent_by_filter ⇒ Object
Returns the value of attribute sent_by_filter.
69 70 71 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 69 def sent_by_filter @sent_by_filter end |
#sent_by_ids ⇒ Object
Returns the value of attribute sent_by_ids.
72 73 74 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 72 def sent_by_ids @sent_by_ids end |
#sort_direction ⇒ Object
Returns the value of attribute sort_direction.
75 76 77 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 75 def sort_direction @sort_direction end |
#sort_field ⇒ Object
Returns the value of attribute sort_field.
78 79 80 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 78 def sort_field @sort_field end |
#start_position ⇒ Object
Starting position of the current result set.
81 82 83 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 81 def start_position @start_position end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 84 def self.attribute_map { :'custom_field_filter' => :'customFieldFilter', :'date_range_custom_from_date' => :'dateRangeCustomFromDate', :'date_range_custom_to_date' => :'dateRangeCustomToDate', :'date_range_filter' => :'dateRangeFilter', :'envelope_date_type_filter' => :'envelopeDateTypeFilter', :'envelope_recipient_name_contains_filter' => :'envelopeRecipientNameContainsFilter', :'envelope_status_filter' => :'envelopeStatusFilter', :'envelope_subject_contains_filter' => :'envelopeSubjectContainsFilter', :'fields' => :'fields', :'for_download' => :'forDownload', :'is_dashboard' => :'isDashboard', :'period_length_filter' => :'periodLengthFilter', :'report_customized_id' => :'reportCustomizedId', :'report_description' => :'reportDescription', :'report_id' => :'reportId', :'report_invocation_type' => :'reportInvocationType', :'report_name' => :'reportName', :'sent_by_filter' => :'sentByFilter', :'sent_by_ids' => :'sentByIds', :'sort_direction' => :'sortDirection', :'sort_field' => :'sortField', :'start_position' => :'startPosition' } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 112 def self.swagger_types { :'custom_field_filter' => :'String', :'date_range_custom_from_date' => :'String', :'date_range_custom_to_date' => :'String', :'date_range_filter' => :'String', :'envelope_date_type_filter' => :'String', :'envelope_recipient_name_contains_filter' => :'String', :'envelope_status_filter' => :'String', :'envelope_subject_contains_filter' => :'String', :'fields' => :'Array<ReportInProductField>', :'for_download' => :'String', :'is_dashboard' => :'String', :'period_length_filter' => :'String', :'report_customized_id' => :'String', :'report_description' => :'String', :'report_id' => :'String', :'report_invocation_type' => :'String', :'report_name' => :'String', :'sent_by_filter' => :'String', :'sent_by_ids' => :'String', :'sort_direction' => :'String', :'sort_field' => :'String', :'start_position' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 253 def ==(o) return true if self.equal?(o) self.class == o.class && custom_field_filter == o.custom_field_filter && date_range_custom_from_date == o.date_range_custom_from_date && date_range_custom_to_date == o.date_range_custom_to_date && date_range_filter == o.date_range_filter && envelope_date_type_filter == o.envelope_date_type_filter && envelope_recipient_name_contains_filter == o.envelope_recipient_name_contains_filter && envelope_status_filter == o.envelope_status_filter && envelope_subject_contains_filter == o.envelope_subject_contains_filter && fields == o.fields && for_download == o.for_download && is_dashboard == o.is_dashboard && period_length_filter == o.period_length_filter && report_customized_id == o.report_customized_id && report_description == o.report_description && report_id == o.report_id && report_invocation_type == o.report_invocation_type && report_name == o.report_name && sent_by_filter == o.sent_by_filter && sent_by_ids == o.sent_by_ids && sort_direction == o.sort_direction && sort_field == o.sort_field && start_position == o.start_position end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 316 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
382 383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 382 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
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 295 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
282 283 284 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 282 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
288 289 290 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 288 def hash [custom_field_filter, date_range_custom_from_date, date_range_custom_to_date, date_range_filter, envelope_date_type_filter, envelope_recipient_name_contains_filter, envelope_status_filter, envelope_subject_contains_filter, fields, for_download, is_dashboard, period_length_filter, report_customized_id, report_description, report_id, report_invocation_type, report_name, sent_by_filter, sent_by_ids, sort_direction, sort_field, start_position].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
240 241 242 243 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 240 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
362 363 364 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 362 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
368 369 370 371 372 373 374 375 376 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 368 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
356 357 358 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 356 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
247 248 249 |
# File 'lib/docusign_esign/models/report_in_product_run_request.rb', line 247 def valid? true end |