Class: CloudsmithApi::EntitlementsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/api/entitlements_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EntitlementsApi

Returns a new instance of EntitlementsApi.



19
20
21
 
# File 'lib/cloudsmith-api/api/entitlements_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/cloudsmith-api/api/entitlements_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#entitlements_create(owner, repo, opts = {}) ⇒ RepositoryToken

Create a specific entitlement in a repository. Create a specific entitlement in a repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :data (RepositoryTokenRequest)
  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results (default to false)

Returns:



30
31
32
33
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 30

def entitlements_create(owner, repo, opts = {})
  data, _status_code, _headers = entitlements_create_with_http_info(owner, repo, opts)
  data
end

#entitlements_create_with_http_info(owner, repo, opts = {}) ⇒ Array<(RepositoryToken, Fixnum, Hash)>

Create a specific entitlement in a repository. Create a specific entitlement in a repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RepositoryToken data, response status code and response headers



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
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 43

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

  # query parameters
  query_params = {}
  query_params[:'show_tokens'] = opts[:'show_tokens'] if !opts[:'show_tokens'].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 = @api_client.object_to_http_body(opts[:'data'])
  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 => 'RepositoryToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_delete(owner, repo, identifier, opts = {}) ⇒ nil

Delete a specific entitlement in a repository. Delete a specific entitlement in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 94

def entitlements_delete(owner, repo, identifier, opts = {})
  entitlements_delete_with_http_info(owner, repo, identifier, opts)
  nil
end

#entitlements_delete_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a specific entitlement in a repository. Delete a specific entitlement in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 106

def entitlements_delete_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitlementsApi.entitlements_delete ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling EntitlementsApi.entitlements_delete"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling EntitlementsApi.entitlements_delete"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling EntitlementsApi.entitlements_delete"
  end
  # resource path
  local_var_path = '/entitlements/{owner}/{repo}/{identifier}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.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 = ['apikey']
  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: EntitlementsApi#entitlements_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_disable(owner, repo, identifier, opts = {}) ⇒ nil

Disable an entitlement token in a repository. Disable an entitlement token in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


159
160
161
162
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 159

def entitlements_disable(owner, repo, identifier, opts = {})
  entitlements_disable_with_http_info(owner, repo, identifier, opts)
  nil
end

#entitlements_disable_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Disable an entitlement token in a repository. Disable an entitlement token in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



171
172
173
174
175
176
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
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 171

def entitlements_disable_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitlementsApi.entitlements_disable ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling EntitlementsApi.entitlements_disable"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling EntitlementsApi.entitlements_disable"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling EntitlementsApi.entitlements_disable"
  end
  # resource path
  local_var_path = '/entitlements/{owner}/{repo}/{identifier}/disable/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.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 = ['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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_disable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_enable(owner, repo, identifier, opts = {}) ⇒ nil

Enable an entitlement token in a repository. Enable an entitlement token in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


224
225
226
227
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 224

def entitlements_enable(owner, repo, identifier, opts = {})
  entitlements_enable_with_http_info(owner, repo, identifier, opts)
  nil
end

#entitlements_enable_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Enable an entitlement token in a repository. Enable an entitlement token in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
277
278
279
280
281
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 236

def entitlements_enable_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitlementsApi.entitlements_enable ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling EntitlementsApi.entitlements_enable"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling EntitlementsApi.entitlements_enable"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling EntitlementsApi.entitlements_enable"
  end
  # resource path
  local_var_path = '/entitlements/{owner}/{repo}/{identifier}/enable/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.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 = ['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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_enable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_list(owner, repo, opts = {}) ⇒ Array<RepositoryToken>

Get a list of all entitlements in a repository. Get a list of all entitlements in a repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results (default to false)

  • :query (String) —

    A search term for querying names of entitlements.

  • :active (BOOLEAN) —

    If true, only include active tokens (default to false)

Returns:



293
294
295
296
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 293

def entitlements_list(owner, repo, opts = {})
  data, _status_code, _headers = entitlements_list_with_http_info(owner, repo, opts)
  data
end

#entitlements_list_with_http_info(owner, repo, opts = {}) ⇒ Array<(Array<RepositoryToken>, Fixnum, Hash)>

Get a list of all entitlements in a repository. Get a list of all entitlements in a repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

  • :query (String) —

    A search term for querying names of entitlements.

  • :active (BOOLEAN) —

    If true, only include active tokens

Returns:

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

    Array<RepositoryToken> data, response status code and response headers



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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 309

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

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'show_tokens'] = opts[:'show_tokens'] if !opts[:'show_tokens'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'active'] = opts[:'active'] if !opts[:'active'].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 = ['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 => 'Array<RepositoryToken>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_partial_update(owner, repo, identifier, opts = {}) ⇒ RepositoryToken

Update a specific entitlement in a repository. Update a specific entitlement in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



366
367
368
369
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 366

def entitlements_partial_update(owner, repo, identifier, opts = {})
  data, _status_code, _headers = entitlements_partial_update_with_http_info(owner, repo, identifier, opts)
  data
end

#entitlements_partial_update_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(RepositoryToken, Fixnum, Hash)>

Update a specific entitlement in a repository. Update a specific entitlement in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    RepositoryToken data, response status code and response headers



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 380

def entitlements_partial_update_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitlementsApi.entitlements_partial_update ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling EntitlementsApi.entitlements_partial_update"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling EntitlementsApi.entitlements_partial_update"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling EntitlementsApi.entitlements_partial_update"
  end
  # resource path
  local_var_path = '/entitlements/{owner}/{repo}/{identifier}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'show_tokens'] = opts[:'show_tokens'] if !opts[:'show_tokens'].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 = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apikey']
  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 => 'RepositoryToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_read(owner, repo, identifier, opts = {}) ⇒ RepositoryToken

Get a specific entitlement in a repository. Get a specific entitlement in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fuzzy (BOOLEAN) —

    If true, entitlement identifiers including name will be fuzzy matched. (default to false)

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results (default to false)

Returns:



437
438
439
440
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 437

def entitlements_read(owner, repo, identifier, opts = {})
  data, _status_code, _headers = entitlements_read_with_http_info(owner, repo, identifier, opts)
  data
end

#entitlements_read_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(RepositoryToken, Fixnum, Hash)>

Get a specific entitlement in a repository. Get a specific entitlement in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fuzzy (BOOLEAN) —

    If true, entitlement identifiers including name will be fuzzy matched.

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

Returns:

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

    RepositoryToken data, response status code and response headers



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 451

def entitlements_read_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitlementsApi.entitlements_read ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling EntitlementsApi.entitlements_read"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling EntitlementsApi.entitlements_read"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling EntitlementsApi.entitlements_read"
  end
  # resource path
  local_var_path = '/entitlements/{owner}/{repo}/{identifier}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'fuzzy'] = opts[:'fuzzy'] if !opts[:'fuzzy'].nil?
  query_params[:'show_tokens'] = opts[:'show_tokens'] if !opts[:'show_tokens'].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 = ['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 => 'RepositoryToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_refresh(owner, repo, identifier, opts = {}) ⇒ RepositoryTokenRefresh

Refresh an entitlement token in a repository. Refresh an entitlement token in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



509
510
511
512
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 509

def entitlements_refresh(owner, repo, identifier, opts = {})
  data, _status_code, _headers = entitlements_refresh_with_http_info(owner, repo, identifier, opts)
  data
end

#entitlements_refresh_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(RepositoryTokenRefresh, Fixnum, Hash)>

Refresh an entitlement token in a repository. Refresh an entitlement token in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    RepositoryTokenRefresh data, response status code and response headers



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 523

def entitlements_refresh_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitlementsApi.entitlements_refresh ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling EntitlementsApi.entitlements_refresh"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling EntitlementsApi.entitlements_refresh"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling EntitlementsApi.entitlements_refresh"
  end
  # resource path
  local_var_path = '/entitlements/{owner}/{repo}/{identifier}/refresh/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'show_tokens'] = opts[:'show_tokens'] if !opts[:'show_tokens'].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 = @api_client.object_to_http_body(opts[:'data'])
  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 => 'RepositoryTokenRefresh')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_reset(owner, repo, identifier, opts = {}) ⇒ nil

Reset the statistics for an entitlement token in a repository. Reset the statistics for an entitlement token in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results (default to false)

Returns:

  • (nil) 


579
580
581
582
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 579

def entitlements_reset(owner, repo, identifier, opts = {})
  entitlements_reset_with_http_info(owner, repo, identifier, opts)
  nil
end

#entitlements_reset_with_http_info(owner, repo, identifier, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Reset the statistics for an entitlement token in a repository. Reset the statistics for an entitlement token in a repository.

Parameters:

  • owner
  • repo
  • identifier
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

Returns:

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

    nil, response status code and response headers



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 592

def entitlements_reset_with_http_info(owner, repo, identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitlementsApi.entitlements_reset ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling EntitlementsApi.entitlements_reset"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling EntitlementsApi.entitlements_reset"
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling EntitlementsApi.entitlements_reset"
  end
  # resource path
  local_var_path = '/entitlements/{owner}/{repo}/{identifier}/reset/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'show_tokens'] = opts[:'show_tokens'] if !opts[:'show_tokens'].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 = ['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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_reset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entitlements_sync(owner, repo, opts = {}) ⇒ RepositoryTokenSync

Synchronise tokens from a source repository. Synchronise tokens from a source repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



647
648
649
650
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 647

def entitlements_sync(owner, repo, opts = {})
  data, _status_code, _headers = entitlements_sync_with_http_info(owner, repo, opts)
  data
end

#entitlements_sync_with_http_info(owner, repo, opts = {}) ⇒ Array<(RepositoryTokenSync, Fixnum, Hash)>

Synchronise tokens from a source repository. Synchronise tokens from a source repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RepositoryTokenSync data, response status code and response headers



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 660

def entitlements_sync_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EntitlementsApi.entitlements_sync ...'
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling EntitlementsApi.entitlements_sync"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling EntitlementsApi.entitlements_sync"
  end
  # resource path
  local_var_path = '/entitlements/{owner}/{repo}/sync/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s)

  # query parameters
  query_params = {}
  query_params[:'show_tokens'] = opts[:'show_tokens'] if !opts[:'show_tokens'].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 = @api_client.object_to_http_body(opts[:'data'])
  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 => 'RepositoryTokenSync')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EntitlementsApi#entitlements_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end