Class: ApproveAPISwagger::ApproveApi

Inherits:
Object
  • Object
show all
Defined in:
lib/approveapi_swagger/api/approve_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApproveApi

Returns a new instance of ApproveApi.



19
20
21
 
# File 'lib/approveapi_swagger/api/approve_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/approveapi_swagger/api/approve_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_prompt(create_prompt_request, opts = {}) ⇒ Prompt

Sending a prompt Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).

Parameters:

  • create_prompt_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/approveapi_swagger/api/approve_api.rb', line 27

def create_prompt(create_prompt_request, opts = {})
  data, _status_code, _headers = create_prompt_with_http_info(create_prompt_request, opts)
  data
end

#create_prompt_with_http_info(create_prompt_request, opts = {}) ⇒ Array<(Prompt, Fixnum, Hash)>

Sending a prompt Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).

Parameters:

  • create_prompt_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Prompt, Fixnum, Hash)>) —

    Prompt data, response status code and response headers



37
38
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
 
# File 'lib/approveapi_swagger/api/approve_api.rb', line 37

def create_prompt_with_http_info(create_prompt_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApproveApi.create_prompt ...'
  end
  # verify the required parameter 'create_prompt_request' is set
  if @api_client.config.client_side_validation && create_prompt_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_prompt_request' when calling ApproveApi.create_prompt"
  end
  # resource path
  local_var_path = '/prompt'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_prompt_request)
  auth_names = ['apiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Prompt')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApproveApi#create_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prompt(id, opts = {}) ⇒ Prompt

Retrieve a prompt Retrieve the prompt object with the given ID.

Parameters:

  • id —

    The identifier for a pending or completed prompt. This is returned when you create a prompt.

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

    the optional parameters

Options Hash (opts):

  • :long_poll (BOOLEAN) —

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

Returns:



83
84
85
86
 
# File 'lib/approveapi_swagger/api/approve_api.rb', line 83

def get_prompt(id, opts = {})
  data, _status_code, _headers = get_prompt_with_http_info(id, opts)
  data
end

#get_prompt_status(id, opts = {}) ⇒ PromptStatus

Check prompt status Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials.

Parameters:

  • id —

    The prompt identifier.

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/approveapi_swagger/api/approve_api.rb', line 138

def get_prompt_status(id, opts = {})
  data, _status_code, _headers = get_prompt_status_with_http_info(id, opts)
  data
end

#get_prompt_status_with_http_info(id, opts = {}) ⇒ Array<(PromptStatus, Fixnum, Hash)>

Check prompt status Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials.

Parameters:

  • id —

    The prompt identifier.

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

    the optional parameters

Returns:

  • (Array<(PromptStatus, Fixnum, Hash)>) —

    PromptStatus data, response status code and response headers



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/approveapi_swagger/api/approve_api.rb', line 148

def get_prompt_status_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApproveApi.get_prompt_status ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ApproveApi.get_prompt_status"
  end
  # resource path
  local_var_path = '/prompt/{id}/status'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PromptStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApproveApi#get_prompt_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prompt_with_http_info(id, opts = {}) ⇒ Array<(Prompt, Fixnum, Hash)>

Retrieve a prompt Retrieve the prompt object with the given ID.

Parameters:

  • id —

    The identifier for a pending or completed prompt. This is returned when you create a prompt.

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

    the optional parameters

Options Hash (opts):

  • :long_poll (BOOLEAN) —

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

Returns:

  • (Array<(Prompt, Fixnum, Hash)>) —

    Prompt data, response status code and response headers



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
 
# File 'lib/approveapi_swagger/api/approve_api.rb', line 94

def get_prompt_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApproveApi.get_prompt ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ApproveApi.get_prompt"
  end
  # resource path
  local_var_path = '/prompt/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'long_poll'] = opts[:'long_poll'] if !opts[:'long_poll'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Prompt')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApproveApi#get_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end