Class: Zernio::VerifyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zernio-sdk/api/verify_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VerifyApi

Returns a new instance of VerifyApi.



19
20
21
 
# File 'lib/zernio-sdk/api/verify_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/zernio-sdk/api/verify_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#check_verification(verification_id, check_verification_request, opts = {}) ⇒ CheckVerification200Response

Check a verification code Verify the code the user typed. Wrong, expired, and exhausted codes answer 200 with valid: false and the settled status — only an unknown id is a 404. A correct code consumes the verification (single-use, status: approved) and fires the verification.approved webhook; the 5th wrong attempt settles it as max_attempts_reached and fires verification.failed.

Parameters:

  • verification_id (String)
  • check_verification_request (CheckVerificationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/zernio-sdk/api/verify_api.rb', line 28

def check_verification(verification_id, check_verification_request, opts = {})
  data, _status_code, _headers = check_verification_with_http_info(verification_id, check_verification_request, opts)
  data
end

#check_verification_with_http_info(verification_id, check_verification_request, opts = {}) ⇒ Array<(CheckVerification200Response, Integer, Hash)>

Check a verification code Verify the code the user typed. Wrong, expired, and exhausted codes answer 200 with `valid: false` and the settled `status` — only an unknown id is a 404. A correct code consumes the verification (single-use, `status: approved`) and fires the `verification.approved` webhook; the 5th wrong attempt settles it as `max_attempts_reached` and fires `verification.failed`.

Parameters:

  • verification_id (String)
  • check_verification_request (CheckVerificationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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
 
# File 'lib/zernio-sdk/api/verify_api.rb', line 39

def check_verification_with_http_info(verification_id, check_verification_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerifyApi.check_verification ...'
  end
  # verify the required parameter 'verification_id' is set
  if @api_client.config.client_side_validation && verification_id.nil?
    fail ArgumentError, "Missing the required parameter 'verification_id' when calling VerifyApi.check_verification"
  end
  # verify the required parameter 'check_verification_request' is set
  if @api_client.config.client_side_validation && check_verification_request.nil?
    fail ArgumentError, "Missing the required parameter 'check_verification_request' when calling VerifyApi.check_verification"
  end
  # resource path
  local_var_path = '/v1/verify/verifications/{verificationId}/check'.sub('{' + 'verificationId' + '}', CGI.escape(verification_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(check_verification_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CheckVerification200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"VerifyApi.check_verification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VerifyApi#check_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_verification(create_verification_request, opts = {}) ⇒ Verification

Send a verification code Generate a one-time code, deliver it to the recipient, and store only its hash. Check the user-typed code with POST /v1/verify/verifications/verificationId/check. Re-POSTing for the same (channel, to) while a verification is active RESENDS a fresh code on the existing verification (200 with resend: true) instead of creating a new one; resends are limited to one per 60 seconds (429 with retryAfterSeconds inside the cooldown). The stored brandName/codeLength/ttlMinutes win on a resend. Codes deliver by SMS from a phone number on your account (from optional when you own exactly one SMS-enabled number) and the message uses a fixed template. Each accepted send bills one verification fee plus the standard message rate.

Parameters:

Returns:



101
102
103
104
 
# File 'lib/zernio-sdk/api/verify_api.rb', line 101

def create_verification(create_verification_request, opts = {})
  data, _status_code, _headers = create_verification_with_http_info(create_verification_request, opts)
  data
end

#create_verification_with_http_info(create_verification_request, opts = {}) ⇒ Array<(Verification, Integer, Hash)>

Send a verification code Generate a one-time code, deliver it to the recipient, and store only its hash. Check the user-typed code with POST /v1/verify/verifications/verificationId/check. Re-POSTing for the same (channel, to) while a verification is active RESENDS a fresh code on the existing verification (200 with `resend: true`) instead of creating a new one; resends are limited to one per 60 seconds (429 with `retryAfterSeconds` inside the cooldown). The stored brandName/codeLength/ttlMinutes win on a resend. Codes deliver by SMS from a phone number on your account (`from` optional when you own exactly one SMS-enabled number) and the message uses a fixed template. Each accepted send bills one verification fee plus the standard message rate.

Parameters:

Returns:

  • (Array<(Verification, Integer, Hash)>) —

    Verification data, response status code and response headers



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/zernio-sdk/api/verify_api.rb', line 111

def create_verification_with_http_info(create_verification_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerifyApi.create_verification ...'
  end
  # verify the required parameter 'create_verification_request' is set
  if @api_client.config.client_side_validation && create_verification_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_verification_request' when calling VerifyApi.create_verification"
  end
  # resource path
  local_var_path = '/v1/verify/verifications'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_verification_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Verification'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"VerifyApi.create_verification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VerifyApi#create_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_verification(verification_id, opts = {}) ⇒ Verification

Get a verification Current state of a verification. status is effective (a pending code past its expiry reads as expired). Verification records are deleted 24 hours after creation, after which this returns 404.

Parameters:

  • verification_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



169
170
171
172
 
# File 'lib/zernio-sdk/api/verify_api.rb', line 169

def get_verification(verification_id, opts = {})
  data, _status_code, _headers = get_verification_with_http_info(verification_id, opts)
  data
end

#get_verification_with_http_info(verification_id, opts = {}) ⇒ Array<(Verification, Integer, Hash)>

Get a verification Current state of a verification. `status` is effective (a pending code past its expiry reads as `expired`). Verification records are deleted 24 hours after creation, after which this returns 404.

Parameters:

  • verification_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Verification, Integer, Hash)>) —

    Verification data, response status code and response headers



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
 
# File 'lib/zernio-sdk/api/verify_api.rb', line 179

def get_verification_with_http_info(verification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerifyApi.get_verification ...'
  end
  # verify the required parameter 'verification_id' is set
  if @api_client.config.client_side_validation && verification_id.nil?
    fail ArgumentError, "Missing the required parameter 'verification_id' when calling VerifyApi.get_verification"
  end
  # resource path
  local_var_path = '/v1/verify/verifications/{verificationId}'.sub('{' + 'verificationId' + '}', CGI.escape(verification_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Verification'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"VerifyApi.get_verification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VerifyApi#get_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end