Class: GroupDocsPlatformCloud::AuthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_platform_cloud/api/auth_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthApi

Returns a new instance of AuthApi.



19
20
21
 
# File 'lib/groupdocs_platform_cloud/api/auth_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/groupdocs_platform_cloud/api/auth_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#auth_delete_token(token, opts = {}) ⇒ File

Delete access token

Parameters:

  • token —

    Access Token

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/groupdocs_platform_cloud/api/auth_api.rb', line 28

def auth_delete_token(token, opts = {})
  data, _status_code, _headers = auth_delete_token_with_http_info(token, opts)
  return data
end

#auth_delete_token_with_http_info(token, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Delete access token

Parameters:

  • token —

    Access Token

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
76
 
# File 'lib/groupdocs_platform_cloud/api/auth_api.rb', line 38

def auth_delete_token_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthApi.auth_delete_token ..."
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling AuthApi.auth_delete_token"
  end
  # resource path
  local_var_path = "/auth/token/{token}".sub('{' + 'token' + '}', token.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'])
  # 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 = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthApi#auth_delete_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#auth_get_tokens(opts = {}) ⇒ AccessTokenListResponse

Get access tokens

Parameters:

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/groupdocs_platform_cloud/api/auth_api.rb', line 82

def auth_get_tokens(opts = {})
  data, _status_code, _headers = auth_get_tokens_with_http_info(opts)
  return data
end

#auth_get_tokens_with_http_info(opts = {}) ⇒ Array<(AccessTokenListResponse, Fixnum, Hash)>

Get access tokens

Parameters:

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

    the optional parameters

Returns:

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

    AccessTokenListResponse data, response status code and response headers



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
 
# File 'lib/groupdocs_platform_cloud/api/auth_api.rb', line 91

def auth_get_tokens_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthApi.auth_get_tokens ..."
  end
  # resource path
  local_var_path = "/auth/token"

  # 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 = 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 => 'AccessTokenListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthApi#auth_get_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#auth_post_token(opts = {}) ⇒ AccessTokenResponse

Create access token

Parameters:

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

    the optional parameters

Returns:



131
132
133
134
 
# File 'lib/groupdocs_platform_cloud/api/auth_api.rb', line 131

def auth_post_token(opts = {})
  data, _status_code, _headers = auth_post_token_with_http_info(opts)
  return data
end

#auth_post_token_with_http_info(opts = {}) ⇒ Array<(AccessTokenResponse, Fixnum, Hash)>

Create access token

Parameters:

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

    the optional parameters

Returns:

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

    AccessTokenResponse data, response status code and response headers



140
141
142
143
144
145
146
147
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
 
# File 'lib/groupdocs_platform_cloud/api/auth_api.rb', line 140

def auth_post_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AuthApi.auth_post_token ..."
  end
  # resource path
  local_var_path = "/auth/token"

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'AccessTokenResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthApi#auth_post_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end