Class: ApproveAPISwagger::CreatePromptRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/approveapi_swagger/models/create_prompt_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePromptRequest

Initializes the object



70
71
72
73
74
75
76
77
78
79
80
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
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 70

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

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

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

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

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

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

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

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

Instance Attribute Details

#approve_text ⇒ Object

The approve action text. Defaults to ‘Approve’.



27
28
29
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 27

def approve_text
  @approve_text
end

#body ⇒ Object

The body of the approval request to show the user.



21
22
23
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 21

def body
  @body
end

#expires_in ⇒ Object

The number of seconds until this request can no longer be answered.



36
37
38
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 36

def expires_in
  @expires_in
end

#long_poll ⇒ Object

If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.



33
34
35
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 33

def long_poll
  @long_poll
end

#metadata ⇒ Object

Returns the value of attribute metadata.



38
39
40
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 38

def metadata
  @metadata
end

#reject_text ⇒ Object

The reject action text. Defaults to ‘Reject’.



30
31
32
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 30

def reject_text
  @reject_text
end

#title ⇒ Object

The title of an approval request. Defaults to an empty string.



24
25
26
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 24

def title
  @title
end

#user ⇒ Object

The user to send the approval request to. Can be either an email address or a phone number.



18
19
20
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 18

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 41

def self.attribute_map
  {
    :'user' => :'user',
    :'body' => :'body',
    :'title' => :'title',
    :'approve_text' => :'approve_text',
    :'reject_text' => :'reject_text',
    :'long_poll' => :'long_poll',
    :'expires_in' => :'expires_in',
    :'metadata' => :'metadata'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



162
163
164
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 162

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 55

def self.openapi_types
  {
    :'user' => :'String',
    :'body' => :'String',
    :'title' => :'String',
    :'approve_text' => :'String',
    :'reject_text' => :'String',
    :'long_poll' => :'BOOLEAN',
    :'expires_in' => :'Float',
    :'metadata' => :'PromptMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user == o.user &&
      body == o.body &&
      title == o.title &&
      approve_text == o.approve_text &&
      reject_text == o.reject_text &&
      long_poll == o.long_poll &&
      expires_in == o.expires_in &&
      metadata == o.metadata
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 190

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
    ApproveAPISwagger.const_get(type).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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 255

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 169

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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

See Also:

  • `==` method


149
150
151
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



155
156
157
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 155

def hash
  [user, body, title, approve_text, reject_text, long_poll, expires_in, metadata].hash
end

#list_invalid_properties ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 111

def list_invalid_properties
  invalid_properties = Array.new
  if @user.nil?
    invalid_properties.push('invalid value for "user", user cannot be nil.')
  end

  if @body.nil?
    invalid_properties.push('invalid value for "body", body cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



235
236
237
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 235

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 241

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



229
230
231
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 229

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



126
127
128
129
130
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 126

def valid?
  return false if @user.nil?
  return false if @body.nil?
  true
end