class DocuSign_eSign::ReportInProductRunRequest

Attributes

authentication_success_filter[RW]
custom_field_filter[RW]
date_range_custom_from_date[RW]
date_range_custom_to_date[RW]
date_range_filter[RW]
envelope_date_type_filter[RW]
envelope_recipient_name_contains_filter[RW]
envelope_status_filter[RW]
envelope_subject_contains_filter[RW]
fields[RW]
for_download[RW]
is_dashboard[RW]
period_length_filter[RW]
report_customized_id[RW]
report_description[RW]
report_id[RW]
report_invocation_type[RW]
report_name[RW]
sent_by_filter[RW]
sent_by_ids[RW]
sort_direction[RW]
sort_field[RW]
start_position[RW]

Starting position of the current result set.

verification_status_filter[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 89
def self.attribute_map
  {
    :'authentication_success_filter' => :'authenticationSuccessFilter',
    :'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',
    :'verification_status_filter' => :'verificationStatusFilter'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 150
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?(:'authenticationSuccessFilter')
    self.authentication_success_filter = attributes[:'authenticationSuccessFilter']
  end

  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

  if attributes.has_key?(:'verificationStatusFilter')
    self.verification_status_filter = attributes[:'verificationStatusFilter']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 119
def self.swagger_types
  {
    :'authentication_success_filter' => :'String',
    :'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',
    :'verification_status_filter' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 270
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authentication_success_filter == o.authentication_success_filter &&
      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 &&
      verification_status_filter == o.verification_status_filter
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 335
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 401
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 314
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 301
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 307
def hash
  [authentication_success_filter, 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, verification_status_filter].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 257
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 381
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 387
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 375
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/report_in_product_run_request.rb, line 264
def valid?
  true
end