Class: DocuSign_eSign::Filter

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

Overview

Use this object to create a filtered view of the items in a folder.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Filter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
134
135
 
# File 'lib/docusign_esign/models/filter.rb', line 86

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action_required ⇒ Object

Access token information.



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

def action_required
  @action_required
end

#expires ⇒ Object

Returns the value of attribute expires.



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

def expires
  @expires
end

#folder_ids ⇒ Object

Returns the value of attribute folder_ids.



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

def folder_ids
  @folder_ids
end

#from_date_time ⇒ Object

Returns the value of attribute from_date_time.



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

def from_date_time
  @from_date_time
end

#is_template ⇒ Object

Returns the value of attribute is_template.



30
31
32
 
# File 'lib/docusign_esign/models/filter.rb', line 30

def is_template
  @is_template
end

#order ⇒ Object

Returns the value of attribute order.



33
34
35
 
# File 'lib/docusign_esign/models/filter.rb', line 33

def order
  @order
end

#order_by ⇒ Object

Returns the value of attribute order_by.



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

def order_by
  @order_by
end

#search_target ⇒ Object

Returns the value of attribute search_target.



39
40
41
 
# File 'lib/docusign_esign/models/filter.rb', line 39

def search_target
  @search_target
end

#search_text ⇒ Object

Returns the value of attribute search_text.



42
43
44
 
# File 'lib/docusign_esign/models/filter.rb', line 42

def search_text
  @search_text
end

#status ⇒ Object

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.



45
46
47
 
# File 'lib/docusign_esign/models/filter.rb', line 45

def status
  @status
end

#to_date_time ⇒ Object

Must be set to "bearer".



48
49
50
 
# File 'lib/docusign_esign/models/filter.rb', line 48

def to_date_time
  @to_date_time
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/docusign_esign/models/filter.rb', line 51

def self.attribute_map
  {
    :'action_required' => :'actionRequired',
    :'expires' => :'expires',
    :'folder_ids' => :'folderIds',
    :'from_date_time' => :'fromDateTime',
    :'is_template' => :'isTemplate',
    :'order' => :'order',
    :'order_by' => :'orderBy',
    :'search_target' => :'searchTarget',
    :'search_text' => :'searchText',
    :'status' => :'status',
    :'to_date_time' => :'toDateTime'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/docusign_esign/models/filter.rb', line 68

def self.swagger_types
  {
    :'action_required' => :'String',
    :'expires' => :'String',
    :'folder_ids' => :'String',
    :'from_date_time' => :'String',
    :'is_template' => :'String',
    :'order' => :'String',
    :'order_by' => :'String',
    :'search_target' => :'String',
    :'search_text' => :'String',
    :'status' => :'String',
    :'to_date_time' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/docusign_esign/models/filter.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action_required == o.action_required &&
      expires == o.expires &&
      folder_ids == o.folder_ids &&
      from_date_time == o.from_date_time &&
      is_template == o.is_template &&
      order == o.order &&
      order_by == o.order_by &&
      search_target == o.search_target &&
      search_text == o.search_text &&
      status == o.status &&
      to_date_time == o.to_date_time
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



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
239
240
 
# File 'lib/docusign_esign/models/filter.rb', line 204

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/docusign_esign/models/filter.rb', line 270

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/docusign_esign/models/filter.rb', line 183

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


170
171
172
 
# File 'lib/docusign_esign/models/filter.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/docusign_esign/models/filter.rb', line 176

def hash
  [action_required, expires, folder_ids, from_date_time, is_template, order, order_by, search_target, search_text, status, to_date_time].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



139
140
141
142
 
# File 'lib/docusign_esign/models/filter.rb', line 139

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
 
# File 'lib/docusign_esign/models/filter.rb', line 250

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
 
# File 'lib/docusign_esign/models/filter.rb', line 256

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

Returns:

  • (String) —

    String presentation of the object



244
245
246
 
# File 'lib/docusign_esign/models/filter.rb', line 244

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



146
147
148
 
# File 'lib/docusign_esign/models/filter.rb', line 146

def valid?
  true
end