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

Parameters:

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

    Model attributes in the form of hash



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
136
137
138
139
140
141
142
143
144
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 89

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

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

  if attributes.has_key?(:'reject_redirect_url')
    self.reject_redirect_url = attributes[:'reject_redirect_url']
  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

  if attributes.has_key?(:'internal_data')
    if (value = attributes[:'internal_data']).is_a?(Hash)
      self.internal_data = value
    end
  end

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

Instance Attribute Details

#approve_redirect_url ⇒ Object

An HTTPS URL to redirect the user to if the prompt is approved. This URL is kept secret until the user is redirected to it.



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

def approve_redirect_url
  @approve_redirect_url
end

#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.



42
43
44
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 42

def expires_in
  @expires_in
end

#idempotency_key ⇒ Object

Allows calling ‘create_prompt` multiple times idempotently, such that a prompt is sent at-most once. This key should contain sufficient randomness. Idempotent requests are stored for 24 hours. After that time, the same key will create a new request.



49
50
51
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 49

def idempotency_key
  @idempotency_key
end

#internal_data ⇒ Object

Returns the value of attribute internal_data.



46
47
48
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 46

def internal_data
  @internal_data
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.



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

def long_poll
  @long_poll
end

#metadata ⇒ Object

Returns the value of attribute metadata.



44
45
46
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 44

def metadata
  @metadata
end

#reject_redirect_url ⇒ Object

An HTTPS URL to redirect the user to if the prompt is rejected. This URL is kept secret until the user is redirected to it.



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

def reject_redirect_url
  @reject_redirect_url
end

#reject_text ⇒ Object

The reject action text. If not specified the reject button will NOT be rendered, and the user will only see an approve action button.



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

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.



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

def self.attribute_map
  {
    :'user' => :'user',
    :'body' => :'body',
    :'title' => :'title',
    :'approve_text' => :'approve_text',
    :'approve_redirect_url' => :'approve_redirect_url',
    :'reject_text' => :'reject_text',
    :'reject_redirect_url' => :'reject_redirect_url',
    :'long_poll' => :'long_poll',
    :'expires_in' => :'expires_in',
    :'metadata' => :'metadata',
    :'internal_data' => :'internal_data',
    :'idempotency_key' => :'idempotency_key'
  }
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



203
204
205
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 203

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 70

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      approve_redirect_url == o.approve_redirect_url &&
      reject_text == o.reject_text &&
      reject_redirect_url == o.reject_redirect_url &&
      long_poll == o.long_poll &&
      expires_in == o.expires_in &&
      metadata == o.metadata &&
      internal_data == o.internal_data &&
      idempotency_key == o.idempotency_key
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 231

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 296

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



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 210

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 196

def hash
  [user, body, title, approve_text, approve_redirect_url, reject_text, reject_redirect_url, long_poll, expires_in, metadata, internal_data, idempotency_key].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



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 148

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



276
277
278
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 276

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



282
283
284
285
286
287
288
289
290
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 282

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



270
271
272
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 270

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



163
164
165
166
167
 
# File 'lib/approveapi_swagger/models/create_prompt_request.rb', line 163

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