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):

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

  • :data (EntitlementsCreate)

Returns:



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

def entitlements_create(owner, repo, opts = {})
  data, _status_code, _headers = entitlements_create_with_http_info(owner, repo, opts)
  return 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):

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

  • :data (EntitlementsCreate)

Returns:

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

    RepositoryToken data, response status code and response headers



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

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 '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', 'basic', 'csrf_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 => '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)
  return 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
 
# 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 = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'csrf_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: 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) 


156
157
158
159
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 156

def entitlements_disable(owner, repo, identifier, opts = {})
  entitlements_disable_with_http_info(owner, repo, identifier, opts)
  return 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



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

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 = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'csrf_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)
  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) 


218
219
220
221
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 218

def entitlements_enable(owner, repo, identifier, opts = {})
  entitlements_enable_with_http_info(owner, repo, identifier, opts)
  return 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



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

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 = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'csrf_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)
  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

Returns:



282
283
284
285
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 282

def entitlements_list(owner, repo, opts = {})
  data, _status_code, _headers = entitlements_list_with_http_info(owner, repo, opts)
  return 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

Returns:

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

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



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

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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'csrf_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 => '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:



348
349
350
351
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 348

def entitlements_partial_update(owner, repo, identifier, opts = {})
  data, _status_code, _headers = entitlements_partial_update_with_http_info(owner, repo, identifier, opts)
  return 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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
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
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 362

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 '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', 'basic', 'csrf_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 => '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):

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

Returns:



417
418
419
420
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 417

def entitlements_read(owner, repo, identifier, opts = {})
  data, _status_code, _headers = entitlements_read_with_http_info(owner, repo, identifier, opts)
  return 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):

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

Returns:

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

    RepositoryToken data, response status code and response headers



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 430

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[:'show_tokens'] = opts[:'show_tokens'] if !opts[:'show_tokens'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'csrf_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 => '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):

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

  • :data (EntitlementsRefresh)

Returns:



484
485
486
487
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 484

def entitlements_refresh(owner, repo, identifier, opts = {})
  data, _status_code, _headers = entitlements_refresh_with_http_info(owner, repo, identifier, opts)
  return 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):

  • :show_tokens (BOOLEAN) —

    Show entitlement token strings in results

  • :data (EntitlementsRefresh)

Returns:

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

    RepositoryTokenRefresh data, response status code and response headers



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 498

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 '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', 'basic', 'csrf_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 => '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

Returns:

  • (nil) 


552
553
554
555
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 552

def entitlements_reset(owner, repo, identifier, opts = {})
  entitlements_reset_with_http_info(owner, repo, identifier, opts)
  return 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

Returns:

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

    nil, response status code and response headers



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 564

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 = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'csrf_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)
  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:



614
615
616
617
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 614

def entitlements_sync(owner, repo, opts = {})
  data, _status_code, _headers = entitlements_sync_with_http_info(owner, repo, opts)
  return 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



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/cloudsmith-api/api/entitlements_api.rb', line 626

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 = {}

  # header parameters
  header_params = {}
  # 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', 'basic', 'csrf_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 => '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