Class: LaunchDarklyApi::AccessTokensApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/access_tokens_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccessTokensApi

Returns a new instance of AccessTokensApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/access_tokens_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/launchdarkly_api/api/access_tokens_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_token(token_id, opts = {}) ⇒ nil

Delete an access token by ID.

Parameters:

  • token_id —

    The access token ID.

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 26

def delete_token(token_id, opts = {})
  delete_token_with_http_info(token_id, opts)
  nil
end

#delete_token_with_http_info(token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an access token by ID.

Parameters:

  • token_id —

    The access token ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



35
36
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
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 35

def delete_token_with_http_info(token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessTokensApi.delete_token ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.delete_token"
  end
  # resource path
  local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_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'])
  # 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 = ['Token']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccessTokensApi#delete_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_token(token_id, opts = {}) ⇒ Token

Get a single access token by ID.

Parameters:

  • token_id —

    The access token ID.

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 77

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

#get_token_with_http_info(token_id, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Get a single access token by ID.

Parameters:

  • token_id —

    The access token ID.

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



86
87
88
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
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 86

def get_token_with_http_info(token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessTokensApi.get_token ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.get_token"
  end
  # resource path
  local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_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'])
  # 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 = ['Token']
  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 => 'Token')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccessTokensApi#get_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tokens(opts = {}) ⇒ Tokens

Returns a list of tokens in the account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :show_all (BOOLEAN) —

    If set to true, and the authentication access token has the &quot;Admin&quot; role, personal access tokens for all members will be retrieved.

Returns:



129
130
131
132
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 129

def get_tokens(opts = {})
  data, _status_code, _headers = get_tokens_with_http_info(opts)
  data
end

#get_tokens_with_http_info(opts = {}) ⇒ Array<(Tokens, Fixnum, Hash)>

Returns a list of tokens in the account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :show_all (BOOLEAN) —

    If set to true, and the authentication access token has the &quot;Admin&quot; role, personal access tokens for all members will be retrieved.

Returns:

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

    Tokens data, response status code and response headers



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
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 138

def get_tokens_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessTokensApi.get_tokens ...'
  end
  # resource path
  local_var_path = '/tokens'

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

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

#patch_token(token_id, patch_delta, opts = {}) ⇒ Token

Modify an access token by ID.

Parameters:

  • token_id —

    The access token ID.

  • patch_delta —

    Requires a JSON Patch representation of the desired changes to the project. &#39;jsonpatch.com/&#39;

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

    the optional parameters

Returns:



179
180
181
182
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 179

def patch_token(token_id, patch_delta, opts = {})
  data, _status_code, _headers = patch_token_with_http_info(token_id, patch_delta, opts)
  data
end

#patch_token_with_http_info(token_id, patch_delta, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Modify an access token by ID.

Parameters:

  • token_id —

    The access token ID.

  • patch_delta —

    Requires a JSON Patch representation of the desired changes to the project. &#39;jsonpatch.com/&#39;

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



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
226
227
228
229
230
231
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 189

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

#post_token(token_body, opts = {}) ⇒ Token

Create a new token.

Parameters:

  • token_body —

    Create a new access token.

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

    the optional parameters

Returns:



236
237
238
239
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 236

def post_token(token_body, opts = {})
  data, _status_code, _headers = post_token_with_http_info(token_body, opts)
  data
end

#post_token_with_http_info(token_body, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Create a new token.

Parameters:

  • token_body —

    Create a new access token.

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

    the optional parameters

Returns:

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

    Token data, response status code and response headers



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
277
278
279
280
281
282
283
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 245

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

  # 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(token_body)
  auth_names = ['Token']
  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 => 'Token')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccessTokensApi#post_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reset_token(token_id, opts = {}) ⇒ Token

Reset an access token’s secret key with an optional expiry time for the old key.

Parameters:

  • token_id —

    The access token ID.

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.

Returns:



289
290
291
292
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 289

def reset_token(token_id, opts = {})
  data, _status_code, _headers = reset_token_with_http_info(token_id, opts)
  data
end

#reset_token_with_http_info(token_id, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Reset an access token&#39;s secret key with an optional expiry time for the old key.

Parameters:

  • token_id —

    The access token ID.

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.

Returns:

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

    Token data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/launchdarkly_api/api/access_tokens_api.rb', line 299

def reset_token_with_http_info(token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccessTokensApi.reset_token ...'
  end
  # verify the required parameter 'token_id' is set
  if @api_client.config.client_side_validation && token_id.nil?
    fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.reset_token"
  end
  # resource path
  local_var_path = '/tokens/{tokenId}/reset'.sub('{' + 'tokenId' + '}', token_id.to_s)

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

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