Class: SunshineConversationsClient::OAuthEndpointsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OAuthEndpointsApi

Returns a new instance of OAuthEndpointsApi.



16
17
18
 
# File 'lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#authorize(client_id, response_type, opts = {}) ⇒ nil

Authorize This endpoint begins the OAuth flow. It relies on a browser session for authentication. If the user is not logged in to Zendesk they will be redirected to the login page. If the user has many Zendesk accounts, they will first be prompted to select the one they wish to integrate with. They will then be presented with an Allow/Deny dialog, describing details of the access your integration is requesting. Use ‘oauth-bridge.zendesk.com/sc` as the base URL when redirecting the user to this endpoint. “` oauth-bridge.zendesk.com/sc/oauth/authorize?response_type=code&client_id=client_id “`

Parameters:

  • client_id (String) —

    Your integration’s unique identifier

  • response_type (String) —

    For now the only acceptable value is code.

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

    the optional parameters

Options Hash (opts):

  • :state (String) —

    You may pass in any arbitrary string value here which will be returned to you along with the code via browser redirect.

  • :redirect_uri (String) —

    You may pass in a redirect_uri to determine which URI the response is redirected to. This URI must be contained in the list configured by your integration. If this option is not passed, the first URI present in the list will be used.

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 27

def authorize(client_id, response_type, opts = {})
  authorize_with_http_info(client_id, response_type, opts)
  nil
end

#authorize_with_http_info(client_id, response_type, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Authorize This endpoint begins the OAuth flow. It relies on a browser session for authentication. If the user is not logged in to Zendesk they will be redirected to the login page. If the user has many Zendesk accounts, they will first be prompted to select the one they wish to integrate with. They will then be presented with an Allow/Deny dialog, describing details of the access your integration is requesting. Use &#x60;oauth-bridge.zendesk.com/sc&#x60; as the base URL when redirecting the user to this endpoint. &#x60;&#x60;&#x60; oauth-bridge.zendesk.com/sc/oauth/authorize?response_type&#x3D;code&amp;client_id&#x3D;client_id &#x60;&#x60;&#x60;

Parameters:

  • client_id (String) —

    Your integration’s unique identifier

  • response_type (String) —

    For now the only acceptable value is code.

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

    the optional parameters

Options Hash (opts):

  • :state (String) —

    You may pass in any arbitrary string value here which will be returned to you along with the code via browser redirect.

  • :redirect_uri (String) —

    You may pass in a redirect_uri to determine which URI the response is redirected to. This URI must be contained in the list configured by your integration. If this option is not passed, the first URI present in the list will be used.

Returns:

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

    nil, response status code and response headers



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/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 40

def authorize_with_http_info(client_id, response_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthEndpointsApi.authorize ...'
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling OAuthEndpointsApi.authorize"
  end
  # verify the required parameter 'response_type' is set
  if @api_client.config.client_side_validation && response_type.nil?
    fail ArgumentError, "Missing the required parameter 'response_type' when calling OAuthEndpointsApi.authorize"
  end
  # resource path
  local_var_path = '/oauth/authorize'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'client_id'] = client_id
  query_params[:'response_type'] = response_type
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain']) 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]

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

  new_options = opts.merge(
    :operation => :"OAuthEndpointsApi.authorize",
    :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: OAuthEndpointsApi#authorize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_token(get_token_request, opts = {}) ⇒ GetToken200Response

Get Token This endpoint is used to exchange an authorization code for an access token. It should only be used in server-to-server calls. Use ‘oauth-bridge.zendesk.com/sc` as the base URL when invoking this endpoint. “` POST oauth-bridge.zendesk.com/sc/oauth/token “`

Parameters:

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

    the optional parameters

Returns:



101
102
103
104
 
# File 'lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 101

def get_token(get_token_request, opts = {})
  data, _status_code, _headers = get_token_with_http_info(get_token_request, opts)
  data
end

#get_token_info(opts = {}) ⇒ AppResponse

Get Token Info This endpoint can be used to retrieve the app linked to the OAuth token. Typically used after receiving an access token via OAuth, in order to retrieve the app’s ‘id` and `subdomain` to be used in future calls. May also be used to confirm that the credentials are still valid. Use `oauth-bridge.zendesk.com/sc` as the base URL when invoking this endpoint. “` GET oauth-bridge.zendesk.com/sc/v2/tokenInfo “`

Parameters:

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

    the optional parameters

Returns:



168
169
170
171
 
# File 'lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 168

def get_token_info(opts = {})
  data, _status_code, _headers = get_token_info_with_http_info(opts)
  data
end

#get_token_info_with_http_info(opts = {}) ⇒ Array<(AppResponse, Integer, Hash)>

Get Token Info This endpoint can be used to retrieve the app linked to the OAuth token. Typically used after receiving an access token via OAuth, in order to retrieve the app&#39;s &#x60;id&#x60; and &#x60;subdomain&#x60; to be used in future calls. May also be used to confirm that the credentials are still valid. Use &#x60;oauth-bridge.zendesk.com/sc&#x60; as the base URL when invoking this endpoint. &#x60;&#x60;&#x60; GET oauth-bridge.zendesk.com/sc/v2/tokenInfo &#x60;&#x60;&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    AppResponse data, response status code and response headers



177
178
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
 
# File 'lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 177

def get_token_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthEndpointsApi.get_token_info ...'
  end
  # resource path
  local_var_path = '/v2/tokenInfo'

  # 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] || 'AppResponse'

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

  new_options = opts.merge(
    :operation => :"OAuthEndpointsApi.get_token_info",
    :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: OAuthEndpointsApi#get_token_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_token_with_http_info(get_token_request, opts = {}) ⇒ Array<(GetToken200Response, Integer, Hash)>

Get Token This endpoint is used to exchange an authorization code for an access token. It should only be used in server-to-server calls. Use &#x60;oauth-bridge.zendesk.com/sc&#x60; as the base URL when invoking this endpoint. &#x60;&#x60;&#x60; POST oauth-bridge.zendesk.com/sc/oauth/token &#x60;&#x60;&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    GetToken200Response 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/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 111

def get_token_with_http_info(get_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthEndpointsApi.get_token ...'
  end
  # verify the required parameter 'get_token_request' is set
  if @api_client.config.client_side_validation && get_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_token_request' when calling OAuthEndpointsApi.get_token"
  end
  # resource path
  local_var_path = '/oauth/token'

  # 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(get_token_request)

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

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

  new_options = opts.merge(
    :operation => :"OAuthEndpointsApi.get_token",
    :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: OAuthEndpointsApi#get_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_access(opts = {}) ⇒ Object

Revoke Access This endpoint is used to revoke your integration’s access to the user’s app. Revoking access means your integration will no longer be able to interact with the app, and any webhooks the integration had previously configured will be removed. Calling this endpoint is equivalent to the user removing your integration manually. Your integration’s ‘removeUrl` (if configured) will also be called when an integration is removed in this way.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


225
226
227
228
 
# File 'lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 225

def revoke_access(opts = {})
  data, _status_code, _headers = revoke_access_with_http_info(opts)
  data
end

#revoke_access_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Revoke Access This endpoint is used to revoke your integration&#39;s access to the user&#39;s app. Revoking access means your integration will no longer be able to interact with the app, and any webhooks the integration had previously configured will be removed. Calling this endpoint is equivalent to the user removing your integration manually. Your integration&#39;s &#x60;removeUrl&#x60; (if configured) will also be called when an integration is removed in this way.

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb', line 234

def revoke_access_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthEndpointsApi.revoke_access ...'
  end
  # resource path
  local_var_path = '/oauth/authorization'

  # 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] || 'Object'

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

  new_options = opts.merge(
    :operation => :"OAuthEndpointsApi.revoke_access",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthEndpointsApi#revoke_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end