Class: CloudsmithApi::OrgsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrgsApi

Returns a new instance of OrgsApi.



19
20
21
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#orgs_api_key_rules_create(org, opts = {}) ⇒ OrganizationApiKeyRule

Create an API key rule. Create an API key rule.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



28
29
30
31
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 28

def orgs_api_key_rules_create(org, opts = {})
  data, _status_code, _headers = orgs_api_key_rules_create_with_http_info(org, opts)
  data
end

#orgs_api_key_rules_create_with_http_info(org, opts = {}) ⇒ Array<(OrganizationApiKeyRule, Fixnum, Hash)>

Create an API key rule. Create an API key rule.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationApiKeyRule, Fixnum, Hash)>)

    OrganizationApiKeyRule data, response status code and response headers



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
77
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 39

def orgs_api_key_rules_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_api_key_rules_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_api_key_rules_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/api-key-rules/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationApiKeyRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_api_key_rules_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_api_key_rules_delete(org, slug_perm, opts = {}) ⇒ nil

Delete an API key rule. Delete an API key rule.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


84
85
86
87
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 84

def orgs_api_key_rules_delete(org, slug_perm, opts = {})
  orgs_api_key_rules_delete_with_http_info(org, slug_perm, opts)
  nil
end

#orgs_api_key_rules_delete_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an API key rule. Delete an API key rule.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 95

def orgs_api_key_rules_delete_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_api_key_rules_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_api_key_rules_delete"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_api_key_rules_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/api-key-rules/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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: OrgsApi#orgs_api_key_rules_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_api_key_rules_list(org, opts = {}) ⇒ Array<OrganizationApiKeyRule>

List all API key rules for the organization. List all API key rules for the organization.

Parameters:

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

    the optional parameters

Returns:



142
143
144
145
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 142

def orgs_api_key_rules_list(org, opts = {})
  data, _status_code, _headers = orgs_api_key_rules_list_with_http_info(org, opts)
  data
end

#orgs_api_key_rules_list_with_http_info(org, opts = {}) ⇒ Array<(Array<OrganizationApiKeyRule>, Fixnum, Hash)>

List all API key rules for the organization. List all API key rules for the organization.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<OrganizationApiKeyRule>, Fixnum, Hash)>)

    Array data, response status code and response headers



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 152

def orgs_api_key_rules_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_api_key_rules_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_api_key_rules_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/api-key-rules/'.sub('{' + 'org' + '}', org.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', 'basic']
  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<OrganizationApiKeyRule>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_api_key_rules_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_api_key_rules_partial_update(org, slug_perm, opts = {}) ⇒ OrganizationApiKeyRule

Update an API key rule. Update an API key rule.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



198
199
200
201
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 198

def orgs_api_key_rules_partial_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_api_key_rules_partial_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_api_key_rules_partial_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationApiKeyRule, Fixnum, Hash)>

Update an API key rule. Update an API key rule.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationApiKeyRule, Fixnum, Hash)>)

    OrganizationApiKeyRule data, response status code and response headers



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 210

def orgs_api_key_rules_partial_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_api_key_rules_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_api_key_rules_partial_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_api_key_rules_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/api-key-rules/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationApiKeyRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_api_key_rules_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_api_key_rules_read(org, slug_perm, opts = {}) ⇒ OrganizationApiKeyRule

Retrieve an API key rule. Retrieve an API key rule.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



259
260
261
262
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 259

def orgs_api_key_rules_read(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_api_key_rules_read_with_http_info(org, slug_perm, opts)
  data
end

#orgs_api_key_rules_read_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationApiKeyRule, Fixnum, Hash)>

Retrieve an API key rule. Retrieve an API key rule.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(OrganizationApiKeyRule, Fixnum, Hash)>)

    OrganizationApiKeyRule data, response status code and response headers



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 270

def orgs_api_key_rules_read_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_api_key_rules_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_api_key_rules_read"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_api_key_rules_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/api-key-rules/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'OrganizationApiKeyRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_api_key_rules_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_api_key_rules_update(org, slug_perm, opts = {}) ⇒ OrganizationApiKeyRule

Full update of an API key rule. Full update of an API key rule.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



320
321
322
323
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 320

def orgs_api_key_rules_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_api_key_rules_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_api_key_rules_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationApiKeyRule, Fixnum, Hash)>

Full update of an API key rule. Full update of an API key rule.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationApiKeyRule, Fixnum, Hash)>)

    OrganizationApiKeyRule data, response status code and response headers



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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 332

def orgs_api_key_rules_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_api_key_rules_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_api_key_rules_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_api_key_rules_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/api-key-rules/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OrganizationApiKeyRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_api_key_rules_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_custom_domains_list(org, opts = {}) ⇒ Array<OrganizationCustomDomains>

Get the details for all custom domains. Get the details for all custom domains.

Parameters:

  • org
  • 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.

Returns:



382
383
384
385
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 382

def orgs_custom_domains_list(org, opts = {})
  data, _status_code, _headers = orgs_custom_domains_list_with_http_info(org, opts)
  data
end

#orgs_custom_domains_list_with_http_info(org, opts = {}) ⇒ Array<(Array<OrganizationCustomDomains>, Fixnum, Hash)>

Get the details for all custom domains. Get the details for all custom domains.

Parameters:

  • org
  • 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.

Returns:



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
428
429
430
431
432
433
434
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 394

def orgs_custom_domains_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_custom_domains_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_custom_domains_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/custom-domains/'.sub('{' + 'org' + '}', org.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?

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

#orgs_delete(org, opts = {}) ⇒ nil

Delete the specified organization. Delete the specified organization.

Parameters:

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

    the optional parameters

Returns:

  • (nil)


440
441
442
443
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 440

def orgs_delete(org, opts = {})
  orgs_delete_with_http_info(org, opts)
  nil
end

#orgs_delete_with_http_info(org, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the specified organization. Delete the specified organization.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def orgs_delete_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/'.sub('{' + 'org' + '}', org.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', 'basic']
  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: OrgsApi#orgs_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_deny_policy_create(org, opts = {}) ⇒ PackageDenyPolicy

Create a package deny policy. Create a package deny policy.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



494
495
496
497
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 494

def orgs_deny_policy_create(org, opts = {})
  data, _status_code, _headers = orgs_deny_policy_create_with_http_info(org, opts)
  data
end

#orgs_deny_policy_create_with_http_info(org, opts = {}) ⇒ Array<(PackageDenyPolicy, Fixnum, Hash)>

Create a package deny policy. Create a package deny policy.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PackageDenyPolicy, Fixnum, Hash)>)

    PackageDenyPolicy data, response status code and response headers



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/orgs_api.rb', line 505

def orgs_deny_policy_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_deny_policy_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_deny_policy_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/deny-policy/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'PackageDenyPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_deny_policy_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_deny_policy_delete(org, slug_perm, opts = {}) ⇒ nil

Delete a package deny policy. Delete a package deny policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


550
551
552
553
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 550

def orgs_deny_policy_delete(org, slug_perm, opts = {})
  orgs_deny_policy_delete_with_http_info(org, slug_perm, opts)
  nil
end

#orgs_deny_policy_delete_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a package deny policy. Delete a package deny policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



561
562
563
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
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 561

def orgs_deny_policy_delete_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_deny_policy_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_deny_policy_delete"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_deny_policy_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/deny-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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: OrgsApi#orgs_deny_policy_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_deny_policy_list(org, opts = {}) ⇒ Array<PackageDenyPolicy>

Get a list of all package deny policies. Get a list of all package deny policies.

Parameters:

  • org
  • 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.

Returns:



610
611
612
613
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 610

def orgs_deny_policy_list(org, opts = {})
  data, _status_code, _headers = orgs_deny_policy_list_with_http_info(org, opts)
  data
end

#orgs_deny_policy_list_with_http_info(org, opts = {}) ⇒ Array<(Array<PackageDenyPolicy>, Fixnum, Hash)>

Get a list of all package deny policies. Get a list of all package deny policies.

Parameters:

  • org
  • 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.

Returns:

  • (Array<(Array<PackageDenyPolicy>, Fixnum, Hash)>)

    Array data, response status code and response headers



622
623
624
625
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
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 622

def orgs_deny_policy_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_deny_policy_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_deny_policy_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/deny-policy/'.sub('{' + 'org' + '}', org.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?

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

#orgs_deny_policy_partial_update(org, slug_perm, opts = {}) ⇒ PackageDenyPolicy

Partially update a package deny policy. Partially update a package deny policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



670
671
672
673
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 670

def orgs_deny_policy_partial_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_deny_policy_partial_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_deny_policy_partial_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(PackageDenyPolicy, Fixnum, Hash)>

Partially update a package deny policy. Partially update a package deny policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PackageDenyPolicy, Fixnum, Hash)>)

    PackageDenyPolicy data, response status code and response headers



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 682

def orgs_deny_policy_partial_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_deny_policy_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_deny_policy_partial_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_deny_policy_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/deny-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'PackageDenyPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_deny_policy_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_deny_policy_read(org, slug_perm, opts = {}) ⇒ PackageDenyPolicy

Get a package deny policy. Get a package deny policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



731
732
733
734
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 731

def orgs_deny_policy_read(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_deny_policy_read_with_http_info(org, slug_perm, opts)
  data
end

#orgs_deny_policy_read_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(PackageDenyPolicy, Fixnum, Hash)>

Get a package deny policy. Get a package deny policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(PackageDenyPolicy, Fixnum, Hash)>)

    PackageDenyPolicy data, response status code and response headers



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 742

def orgs_deny_policy_read_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_deny_policy_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_deny_policy_read"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_deny_policy_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/deny-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'PackageDenyPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_deny_policy_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_deny_policy_update(org, slug_perm, opts = {}) ⇒ PackageDenyPolicy

Update a package deny policy. Update a package deny policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



792
793
794
795
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 792

def orgs_deny_policy_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_deny_policy_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_deny_policy_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(PackageDenyPolicy, Fixnum, Hash)>

Update a package deny policy. Update a package deny policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PackageDenyPolicy, Fixnum, Hash)>)

    PackageDenyPolicy data, response status code and response headers



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 804

def orgs_deny_policy_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_deny_policy_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_deny_policy_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_deny_policy_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/deny-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PackageDenyPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_deny_policy_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_invites_create(org, opts = {}) ⇒ OrganizationInvite

Create an organization invite for a specific user Create an organization invite for a specific user

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



853
854
855
856
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 853

def orgs_invites_create(org, opts = {})
  data, _status_code, _headers = orgs_invites_create_with_http_info(org, opts)
  data
end

#orgs_invites_create_with_http_info(org, opts = {}) ⇒ Array<(OrganizationInvite, Fixnum, Hash)>

Create an organization invite for a specific user Create an organization invite for a specific user

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationInvite, Fixnum, Hash)>)

    OrganizationInvite data, response status code and response headers



864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 864

def orgs_invites_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_invites_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_invites_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/invites/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationInvite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_invites_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_invites_delete(org, slug_perm, opts = {}) ⇒ nil

Delete a specific organization invite Delete a specific organization invite

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


909
910
911
912
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 909

def orgs_invites_delete(org, slug_perm, opts = {})
  orgs_invites_delete_with_http_info(org, slug_perm, opts)
  nil
end

#orgs_invites_delete_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a specific organization invite Delete a specific organization invite

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 920

def orgs_invites_delete_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_invites_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_invites_delete"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_invites_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/invites/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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: OrgsApi#orgs_invites_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_invites_extend(org, slug_perm, opts = {}) ⇒ OrganizationInviteExtend

Extend an organization invite. Extend an organization invite.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



968
969
970
971
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 968

def orgs_invites_extend(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_invites_extend_with_http_info(org, slug_perm, opts)
  data
end

#orgs_invites_extend_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationInviteExtend, Fixnum, Hash)>

Extend an organization invite. Extend an organization invite.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(OrganizationInviteExtend, Fixnum, Hash)>)

    OrganizationInviteExtend data, response status code and response headers



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 979

def orgs_invites_extend_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_invites_extend ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_invites_extend"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_invites_extend"
  end
  # resource path
  local_var_path = '/orgs/{org}/invites/{slug_perm}/extend/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'OrganizationInviteExtend')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_invites_extend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_invites_list(org, opts = {}) ⇒ Array<OrganizationInvite>

Get a list of all invites for an organization. Get a list of all invites for an organization.

Parameters:

  • org
  • 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.

Returns:



1029
1030
1031
1032
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1029

def orgs_invites_list(org, opts = {})
  data, _status_code, _headers = orgs_invites_list_with_http_info(org, opts)
  data
end

#orgs_invites_list_with_http_info(org, opts = {}) ⇒ Array<(Array<OrganizationInvite>, Fixnum, Hash)>

Get a list of all invites for an organization. Get a list of all invites for an organization.

Parameters:

  • org
  • 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.

Returns:

  • (Array<(Array<OrganizationInvite>, Fixnum, Hash)>)

    Array data, response status code and response headers



1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1041

def orgs_invites_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_invites_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_invites_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/invites/'.sub('{' + 'org' + '}', org.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?

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

#orgs_invites_partial_update(org, slug_perm, opts = {}) ⇒ OrganizationInvite

Update a specific organization invite. Update a specific organization invite.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



1089
1090
1091
1092
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1089

def orgs_invites_partial_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_invites_partial_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_invites_partial_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationInvite, Fixnum, Hash)>

Update a specific organization invite. Update a specific organization invite.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationInvite, Fixnum, Hash)>)

    OrganizationInvite data, response status code and response headers



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1101

def orgs_invites_partial_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_invites_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_invites_partial_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_invites_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/invites/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationInvite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_invites_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_invites_resend(org, slug_perm, opts = {}) ⇒ OrganizationInviteExtend

Resend an organization invite. Resend an organization invite.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1150
1151
1152
1153
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1150

def orgs_invites_resend(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_invites_resend_with_http_info(org, slug_perm, opts)
  data
end

#orgs_invites_resend_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationInviteExtend, Fixnum, Hash)>

Resend an organization invite. Resend an organization invite.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(OrganizationInviteExtend, Fixnum, Hash)>)

    OrganizationInviteExtend data, response status code and response headers



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1161

def orgs_invites_resend_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_invites_resend ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_invites_resend"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_invites_resend"
  end
  # resource path
  local_var_path = '/orgs/{org}/invites/{slug_perm}/resend/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'OrganizationInviteExtend')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_invites_resend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_license_policy_create(org, opts = {}) ⇒ OrganizationPackageLicensePolicy

Create a package license policy. Create a package license policy.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1210
1211
1212
1213
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1210

def orgs_license_policy_create(org, opts = {})
  data, _status_code, _headers = orgs_license_policy_create_with_http_info(org, opts)
  data
end

#orgs_license_policy_create_with_http_info(org, opts = {}) ⇒ Array<(OrganizationPackageLicensePolicy, Fixnum, Hash)>

Create a package license policy. Create a package license policy.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1221

def orgs_license_policy_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationPackageLicensePolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_license_policy_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_license_policy_delete(org, slug_perm, opts = {}) ⇒ nil

Delete a package license policy. Delete a package license policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


1266
1267
1268
1269
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1266

def orgs_license_policy_delete(org, slug_perm, opts = {})
  orgs_license_policy_delete_with_http_info(org, slug_perm, opts)
  nil
end

#orgs_license_policy_delete_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a package license policy. Delete a package license policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1277

def orgs_license_policy_delete_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_delete"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_license_policy_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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: OrgsApi#orgs_license_policy_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_license_policy_evaluation_create(org, policy_slug_perm, opts = {}) ⇒ PackageLicensePolicyEvaluationRequest

Create an evaluation request for this policy. Create an evaluation request for this policy.

Parameters:

  • org
  • policy_slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



1326
1327
1328
1329
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1326

def orgs_license_policy_evaluation_create(org, policy_slug_perm, opts = {})
  data, _status_code, _headers = orgs_license_policy_evaluation_create_with_http_info(org, policy_slug_perm, opts)
  data
end

#orgs_license_policy_evaluation_create_with_http_info(org, policy_slug_perm, opts = {}) ⇒ Array<(PackageLicensePolicyEvaluationRequest, Fixnum, Hash)>

Create an evaluation request for this policy. Create an evaluation request for this policy.

Parameters:

  • org
  • policy_slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1338

def orgs_license_policy_evaluation_create_with_http_info(org, policy_slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_evaluation_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_evaluation_create"
  end
  # verify the required parameter 'policy_slug_perm' is set
  if @api_client.config.client_side_validation && policy_slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'policy_slug_perm' when calling OrgsApi.orgs_license_policy_evaluation_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/{policy_slug_perm}/evaluation/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'policy_slug_perm' + '}', policy_slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'PackageLicensePolicyEvaluationRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_license_policy_evaluation_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_license_policy_evaluation_list(org, policy_slug_perm, opts = {}) ⇒ Array<PackageLicensePolicyEvaluationRequest>

List evaluation requests for this policy. List evaluation requests for this policy.

Parameters:

  • org
  • policy_slug_perm
  • 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.

Returns:



1389
1390
1391
1392
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1389

def orgs_license_policy_evaluation_list(org, policy_slug_perm, opts = {})
  data, _status_code, _headers = orgs_license_policy_evaluation_list_with_http_info(org, policy_slug_perm, opts)
  data
end

#orgs_license_policy_evaluation_list_with_http_info(org, policy_slug_perm, opts = {}) ⇒ Array<(Array<PackageLicensePolicyEvaluationRequest>, Fixnum, Hash)>

List evaluation requests for this policy. List evaluation requests for this policy.

Parameters:

  • org
  • policy_slug_perm
  • 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.

Returns:



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1402

def orgs_license_policy_evaluation_list_with_http_info(org, policy_slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_evaluation_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_evaluation_list"
  end
  # verify the required parameter 'policy_slug_perm' is set
  if @api_client.config.client_side_validation && policy_slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'policy_slug_perm' when calling OrgsApi.orgs_license_policy_evaluation_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/{policy_slug_perm}/evaluation/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'policy_slug_perm' + '}', policy_slug_perm.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?

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

#orgs_license_policy_evaluation_read(org, policy_slug_perm, slug_perm, opts = {}) ⇒ PackageLicensePolicyEvaluationRequest

Retrieve an evaluation request for this policy. Retrieve an evaluation request for this policy.

Parameters:

  • org
  • policy_slug_perm
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1454
1455
1456
1457
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1454

def orgs_license_policy_evaluation_read(org, policy_slug_perm, slug_perm, opts = {})
  data, _status_code, _headers = orgs_license_policy_evaluation_read_with_http_info(org, policy_slug_perm, slug_perm, opts)
  data
end

#orgs_license_policy_evaluation_read_with_http_info(org, policy_slug_perm, slug_perm, opts = {}) ⇒ Array<(PackageLicensePolicyEvaluationRequest, Fixnum, Hash)>

Retrieve an evaluation request for this policy. Retrieve an evaluation request for this policy.

Parameters:

  • org
  • policy_slug_perm
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1466

def orgs_license_policy_evaluation_read_with_http_info(org, policy_slug_perm, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_evaluation_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_evaluation_read"
  end
  # verify the required parameter 'policy_slug_perm' is set
  if @api_client.config.client_side_validation && policy_slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'policy_slug_perm' when calling OrgsApi.orgs_license_policy_evaluation_read"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_license_policy_evaluation_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/{policy_slug_perm}/evaluation/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'policy_slug_perm' + '}', policy_slug_perm.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'PackageLicensePolicyEvaluationRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_license_policy_evaluation_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_license_policy_list(org, opts = {}) ⇒ Array<OrganizationPackageLicensePolicy>

Get a list of all package license policies. Get a list of all package license policies.

Parameters:

  • org
  • 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.

Returns:



1520
1521
1522
1523
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1520

def orgs_license_policy_list(org, opts = {})
  data, _status_code, _headers = orgs_license_policy_list_with_http_info(org, opts)
  data
end

#orgs_license_policy_list_with_http_info(org, opts = {}) ⇒ Array<(Array<OrganizationPackageLicensePolicy>, Fixnum, Hash)>

Get a list of all package license policies. Get a list of all package license policies.

Parameters:

  • org
  • 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.

Returns:



1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1532

def orgs_license_policy_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/'.sub('{' + 'org' + '}', org.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?

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

#orgs_license_policy_partial_update(org, slug_perm, opts = {}) ⇒ OrganizationPackageLicensePolicy

Partially update a package license policy. Partially update a package license policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



1580
1581
1582
1583
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1580

def orgs_license_policy_partial_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_license_policy_partial_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_license_policy_partial_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationPackageLicensePolicy, Fixnum, Hash)>

Partially update a package license policy. Partially update a package license policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1592

def orgs_license_policy_partial_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_partial_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_license_policy_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationPackageLicensePolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_license_policy_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_license_policy_read(org, slug_perm, opts = {}) ⇒ OrganizationPackageLicensePolicy

Get a package license policy. Get a package license policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1641
1642
1643
1644
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1641

def orgs_license_policy_read(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_license_policy_read_with_http_info(org, slug_perm, opts)
  data
end

#orgs_license_policy_read_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationPackageLicensePolicy, Fixnum, Hash)>

Get a package license policy. Get a package license policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1652

def orgs_license_policy_read_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_read"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_license_policy_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'OrganizationPackageLicensePolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_license_policy_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_license_policy_update(org, slug_perm, opts = {}) ⇒ OrganizationPackageLicensePolicy

Update a package license policy. Update a package license policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



1702
1703
1704
1705
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1702

def orgs_license_policy_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_license_policy_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_license_policy_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationPackageLicensePolicy, Fixnum, Hash)>

Update a package license policy. Update a package license policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1714

def orgs_license_policy_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_license_policy_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OrganizationPackageLicensePolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_license_policy_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_license_policy_violation_list(org, opts = {}) ⇒ PackageLicensePolicyViolationLogCursorPage

List all current license policy violations for this Organization. List all current license policy violations for this Organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)

    The pagination cursor value.

  • :page_size (Integer)

    Number of results to return per page.

Returns:



1764
1765
1766
1767
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1764

def orgs_license_policy_violation_list(org, opts = {})
  data, _status_code, _headers = orgs_license_policy_violation_list_with_http_info(org, opts)
  data
end

#orgs_license_policy_violation_list_with_http_info(org, opts = {}) ⇒ Array<(PackageLicensePolicyViolationLogCursorPage, Fixnum, Hash)>

List all current license policy violations for this Organization. List all current license policy violations for this Organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)

    The pagination cursor value.

  • :page_size (Integer)

    Number of results to return per page.

Returns:



1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1776

def orgs_license_policy_violation_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_license_policy_violation_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_license_policy_violation_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/license-policy-violation/'.sub('{' + 'org' + '}', org.to_s)

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

#orgs_list(opts = {}) ⇒ Array<Organization>

Get a list of all the organizations you are associated with. Get a list of all the organizations you are associated with.

Parameters:

  • 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.

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name, created_at, slug. (default to name)

Returns:



1824
1825
1826
1827
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1824

def orgs_list(opts = {})
  data, _status_code, _headers = orgs_list_with_http_info(opts)
  data
end

#orgs_list_with_http_info(opts = {}) ⇒ Array<(Array<Organization>, Fixnum, Hash)>

Get a list of all the organizations you are associated with. Get a list of all the organizations you are associated with.

Parameters:

  • 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.

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name, created_at, slug.

Returns:

  • (Array<(Array<Organization>, Fixnum, Hash)>)

    Array data, response status code and response headers



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1836

def orgs_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_list ...'
  end
  # resource path
  local_var_path = '/orgs/'

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

#orgs_members_delete(org, member, opts = {}) ⇒ nil

Removes a member from the organization. Removes a member from the organization.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


1880
1881
1882
1883
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1880

def orgs_members_delete(org, member, opts = {})
  orgs_members_delete_with_http_info(org, member, opts)
  nil
end

#orgs_members_delete_with_http_info(org, member, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Removes a member from the organization. Removes a member from the organization.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1891

def orgs_members_delete_with_http_info(org, member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_members_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_members_delete"
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling OrgsApi.orgs_members_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/members/{member}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'member' + '}', member.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', 'basic']
  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: OrgsApi#orgs_members_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_members_list(org, opts = {}) ⇒ Array<OrganizationMembership>

Get the details for all organization members. Get the details for all organization members.

Parameters:

  • org
  • 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.

  • :is_active (BOOLEAN)

    Filter for active/inactive users. (default to false)

  • :query (String)

    A search term for querying of members within an Organization.Available options are: email, org, user, userslug, inactive, user_name, role (default to )

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-user_name`). Available options: user_name, role. (default to user_name)

Returns:



1943
1944
1945
1946
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1943

def orgs_members_list(org, opts = {})
  data, _status_code, _headers = orgs_members_list_with_http_info(org, opts)
  data
end

#orgs_members_list_with_http_info(org, opts = {}) ⇒ Array<(Array<OrganizationMembership>, Fixnum, Hash)>

Get the details for all organization members. Get the details for all organization members.

Parameters:

  • org
  • 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.

  • :is_active (BOOLEAN)

    Filter for active/inactive users.

  • :query (String)

    A search term for querying of members within an Organization.Available options are: email, org, user, userslug, inactive, user_name, role

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-user_name`). Available options: user_name, role.

Returns:

  • (Array<(Array<OrganizationMembership>, Fixnum, Hash)>)

    Array data, response status code and response headers



1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 1958

def orgs_members_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_members_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_members_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/members/'.sub('{' + 'org' + '}', org.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[:'is_active'] = opts[:'is_active'] if !opts[:'is_active'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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', 'basic']
  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<OrganizationMembership>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_members_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_members_partial_update(org, member, opts = {}) ⇒ OrganizationMembership

Views for working with organization members. Views for working with organization members.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



2009
2010
2011
2012
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2009

def orgs_members_partial_update(org, member, opts = {})
  data, _status_code, _headers = orgs_members_partial_update_with_http_info(org, member, opts)
  data
end

#orgs_members_partial_update_with_http_info(org, member, opts = {}) ⇒ Array<(OrganizationMembership, Fixnum, Hash)>

Views for working with organization members. Views for working with organization members.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationMembership, Fixnum, Hash)>)

    OrganizationMembership data, response status code and response headers



2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2021

def orgs_members_partial_update_with_http_info(org, member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_members_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_members_partial_update"
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling OrgsApi.orgs_members_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/members/{member}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'member' + '}', member.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationMembership')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_members_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_members_read(org, member, opts = {}) ⇒ OrganizationMembership

Get the details for a specific organization member. Get the details for a specific organization member.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2070
2071
2072
2073
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2070

def orgs_members_read(org, member, opts = {})
  data, _status_code, _headers = orgs_members_read_with_http_info(org, member, opts)
  data
end

#orgs_members_read_with_http_info(org, member, opts = {}) ⇒ Array<(OrganizationMembership, Fixnum, Hash)>

Get the details for a specific organization member. Get the details for a specific organization member.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(OrganizationMembership, Fixnum, Hash)>)

    OrganizationMembership data, response status code and response headers



2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2081

def orgs_members_read_with_http_info(org, member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_members_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_members_read"
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling OrgsApi.orgs_members_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/members/{member}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'member' + '}', member.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', 'basic']
  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 => 'OrganizationMembership')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_members_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_members_refresh(org, member, opts = {}) ⇒ nil

Refresh a member of the organization's API key. Refresh a member of the organization's API key.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


2130
2131
2132
2133
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2130

def orgs_members_refresh(org, member, opts = {})
  orgs_members_refresh_with_http_info(org, member, opts)
  nil
end

#orgs_members_refresh_with_http_info(org, member, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Refresh a member of the organization's API key. Refresh a member of the organization's API key.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2141

def orgs_members_refresh_with_http_info(org, member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_members_refresh ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_members_refresh"
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling OrgsApi.orgs_members_refresh"
  end
  # resource path
  local_var_path = '/orgs/{org}/members/{member}/refresh/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'member' + '}', member.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', 'basic']
  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: OrgsApi#orgs_members_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_members_remove(org, member, opts = {}) ⇒ nil

Removes a member from the organization (deprecated, use DELETE instead). Removes a member from the organization (deprecated, use DELETE instead).

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


2189
2190
2191
2192
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2189

def orgs_members_remove(org, member, opts = {})
  orgs_members_remove_with_http_info(org, member, opts)
  nil
end

#orgs_members_remove_with_http_info(org, member, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Removes a member from the organization (deprecated, use DELETE instead). Removes a member from the organization (deprecated, use DELETE instead).

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2200

def orgs_members_remove_with_http_info(org, member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_members_remove ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_members_remove"
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling OrgsApi.orgs_members_remove"
  end
  # resource path
  local_var_path = '/orgs/{org}/members/{member}/remove/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'member' + '}', member.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', 'basic']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_members_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_members_update_role(org, member, opts = {}) ⇒ OrganizationMembershipRoleUpdate

Update a member's role in the organization. Update a member's role in the organization.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



2249
2250
2251
2252
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2249

def orgs_members_update_role(org, member, opts = {})
  data, _status_code, _headers = orgs_members_update_role_with_http_info(org, member, opts)
  data
end

#orgs_members_update_role_with_http_info(org, member, opts = {}) ⇒ Array<(OrganizationMembershipRoleUpdate, Fixnum, Hash)>

Update a member's role in the organization. Update a member's role in the organization.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2261

def orgs_members_update_role_with_http_info(org, member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_members_update_role ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_members_update_role"
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling OrgsApi.orgs_members_update_role"
  end
  # resource path
  local_var_path = '/orgs/{org}/members/{member}/update-role/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'member' + '}', member.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationMembershipRoleUpdate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_members_update_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_members_update_visibility(org, member, opts = {}) ⇒ OrganizationMembershipVisibilityUpdate

Update a member's visibility in the organization. Update a member's visibility in the organization.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



2311
2312
2313
2314
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2311

def orgs_members_update_visibility(org, member, opts = {})
  data, _status_code, _headers = orgs_members_update_visibility_with_http_info(org, member, opts)
  data
end

#orgs_members_update_visibility_with_http_info(org, member, opts = {}) ⇒ Array<(OrganizationMembershipVisibilityUpdate, Fixnum, Hash)>

Update a member's visibility in the organization. Update a member's visibility in the organization.

Parameters:

  • org
  • member
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2323

def orgs_members_update_visibility_with_http_info(org, member, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_members_update_visibility ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_members_update_visibility"
  end
  # verify the required parameter 'member' is set
  if @api_client.config.client_side_validation && member.nil?
    fail ArgumentError, "Missing the required parameter 'member' when calling OrgsApi.orgs_members_update_visibility"
  end
  # resource path
  local_var_path = '/orgs/{org}/members/{member}/update-visibility/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'member' + '}', member.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationMembershipVisibilityUpdate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_members_update_visibility\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_openid_connect_create(org, opts = {}) ⇒ ProviderSettingsWrite

Create the OpenID Connect provider settings for the org. Create the OpenID Connect provider settings for the org.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2372
2373
2374
2375
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2372

def orgs_openid_connect_create(org, opts = {})
  data, _status_code, _headers = orgs_openid_connect_create_with_http_info(org, opts)
  data
end

#orgs_openid_connect_create_with_http_info(org, opts = {}) ⇒ Array<(ProviderSettingsWrite, Fixnum, Hash)>

Create the OpenID Connect provider settings for the org. Create the OpenID Connect provider settings for the org.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ProviderSettingsWrite, Fixnum, Hash)>)

    ProviderSettingsWrite data, response status code and response headers



2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2383

def orgs_openid_connect_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_openid_connect_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_openid_connect_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/openid-connect/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'ProviderSettingsWrite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_openid_connect_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_openid_connect_delete(org, slug_perm, opts = {}) ⇒ nil

Delete a specific OpenID Connect provider setting for the org. Delete a specific OpenID Connect provider setting for the org.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


2428
2429
2430
2431
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2428

def orgs_openid_connect_delete(org, slug_perm, opts = {})
  orgs_openid_connect_delete_with_http_info(org, slug_perm, opts)
  nil
end

#orgs_openid_connect_delete_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a specific OpenID Connect provider setting for the org. Delete a specific OpenID Connect provider setting for the org.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2439

def orgs_openid_connect_delete_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_openid_connect_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_openid_connect_delete"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_openid_connect_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/openid-connect/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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: OrgsApi#orgs_openid_connect_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_openid_connect_dynamic_mappings_list(org, provider_setting, opts = {}) ⇒ Array<DynamicMapping>

Retrieve the list of OpenID Connect dynamic mappings for the provider setting. Retrieve the list of OpenID Connect dynamic mappings for the provider setting.

Parameters:

  • org
  • provider_setting
  • 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.

Returns:



2489
2490
2491
2492
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2489

def orgs_openid_connect_dynamic_mappings_list(org, provider_setting, opts = {})
  data, _status_code, _headers = orgs_openid_connect_dynamic_mappings_list_with_http_info(org, provider_setting, opts)
  data
end

#orgs_openid_connect_dynamic_mappings_list_with_http_info(org, provider_setting, opts = {}) ⇒ Array<(Array<DynamicMapping>, Fixnum, Hash)>

Retrieve the list of OpenID Connect dynamic mappings for the provider setting. Retrieve the list of OpenID Connect dynamic mappings for the provider setting.

Parameters:

  • org
  • provider_setting
  • 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.

Returns:

  • (Array<(Array<DynamicMapping>, Fixnum, Hash)>)

    Array data, response status code and response headers



2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2502

def orgs_openid_connect_dynamic_mappings_list_with_http_info(org, provider_setting, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_openid_connect_dynamic_mappings_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_openid_connect_dynamic_mappings_list"
  end
  # verify the required parameter 'provider_setting' is set
  if @api_client.config.client_side_validation && provider_setting.nil?
    fail ArgumentError, "Missing the required parameter 'provider_setting' when calling OrgsApi.orgs_openid_connect_dynamic_mappings_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/openid-connect/{provider_setting}/dynamic-mappings/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'provider_setting' + '}', provider_setting.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?

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

#orgs_openid_connect_dynamic_mappings_read(org, provider_setting, claim_value, opts = {}) ⇒ DynamicMapping

Retrieve a specific OpenID Connect dynamic mapping for the provider setting. Retrieve a specific OpenID Connect dynamic mapping for the provider setting.

Parameters:

  • org
  • provider_setting
  • claim_value
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2554
2555
2556
2557
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2554

def orgs_openid_connect_dynamic_mappings_read(org, provider_setting, claim_value, opts = {})
  data, _status_code, _headers = orgs_openid_connect_dynamic_mappings_read_with_http_info(org, provider_setting, claim_value, opts)
  data
end

#orgs_openid_connect_dynamic_mappings_read_with_http_info(org, provider_setting, claim_value, opts = {}) ⇒ Array<(DynamicMapping, Fixnum, Hash)>

Retrieve a specific OpenID Connect dynamic mapping for the provider setting. Retrieve a specific OpenID Connect dynamic mapping for the provider setting.

Parameters:

  • org
  • provider_setting
  • claim_value
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(DynamicMapping, Fixnum, Hash)>)

    DynamicMapping data, response status code and response headers



2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2566

def orgs_openid_connect_dynamic_mappings_read_with_http_info(org, provider_setting, claim_value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_openid_connect_dynamic_mappings_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_openid_connect_dynamic_mappings_read"
  end
  # verify the required parameter 'provider_setting' is set
  if @api_client.config.client_side_validation && provider_setting.nil?
    fail ArgumentError, "Missing the required parameter 'provider_setting' when calling OrgsApi.orgs_openid_connect_dynamic_mappings_read"
  end
  # verify the required parameter 'claim_value' is set
  if @api_client.config.client_side_validation && claim_value.nil?
    fail ArgumentError, "Missing the required parameter 'claim_value' when calling OrgsApi.orgs_openid_connect_dynamic_mappings_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/openid-connect/{provider_setting}/dynamic-mappings/{claim_value}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'provider_setting' + '}', provider_setting.to_s).sub('{' + 'claim_value' + '}', claim_value.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', 'basic']
  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 => 'DynamicMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_openid_connect_dynamic_mappings_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_openid_connect_list(org, opts = {}) ⇒ Array<ProviderSettings>

Retrieve the list of OpenID Connect provider settings for the org. Retrieve the list of OpenID Connect provider settings for the org.

Parameters:

  • org
  • 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.

  • :query (String)

    A search term for querying of OpenID Connect (OIDC) provider settings.Available options are: name, provider_url, service_account (default to )

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name. (default to name)

Returns:



2622
2623
2624
2625
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2622

def orgs_openid_connect_list(org, opts = {})
  data, _status_code, _headers = orgs_openid_connect_list_with_http_info(org, opts)
  data
end

#orgs_openid_connect_list_with_http_info(org, opts = {}) ⇒ Array<(Array<ProviderSettings>, Fixnum, Hash)>

Retrieve the list of OpenID Connect provider settings for the org. Retrieve the list of OpenID Connect provider settings for the org.

Parameters:

  • org
  • 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.

  • :query (String)

    A search term for querying of OpenID Connect (OIDC) provider settings.Available options are: name, provider_url, service_account

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name.

Returns:

  • (Array<(Array<ProviderSettings>, Fixnum, Hash)>)

    Array data, response status code and response headers



2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2636

def orgs_openid_connect_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_openid_connect_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_openid_connect_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/openid-connect/'.sub('{' + 'org' + '}', org.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[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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', 'basic']
  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<ProviderSettings>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_openid_connect_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_openid_connect_partial_update(org, slug_perm, opts = {}) ⇒ ProviderSettingsWrite

Update a specific OpenID Connect provider setting for the org. Update a specific OpenID Connect provider setting for the org.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



2686
2687
2688
2689
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2686

def orgs_openid_connect_partial_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_openid_connect_partial_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_openid_connect_partial_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(ProviderSettingsWrite, Fixnum, Hash)>

Update a specific OpenID Connect provider setting for the org. Update a specific OpenID Connect provider setting for the org.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ProviderSettingsWrite, Fixnum, Hash)>)

    ProviderSettingsWrite data, response status code and response headers



2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2698

def orgs_openid_connect_partial_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_openid_connect_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_openid_connect_partial_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_openid_connect_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/openid-connect/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'ProviderSettingsWrite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_openid_connect_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_openid_connect_read(org, slug_perm, opts = {}) ⇒ ProviderSettings

Retrieve a specific OpenID Connect provider setting for the org. Retrieve a specific OpenID Connect provider setting for the org.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



2747
2748
2749
2750
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2747

def orgs_openid_connect_read(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_openid_connect_read_with_http_info(org, slug_perm, opts)
  data
end

#orgs_openid_connect_read_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(ProviderSettings, Fixnum, Hash)>

Retrieve a specific OpenID Connect provider setting for the org. Retrieve a specific OpenID Connect provider setting for the org.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(ProviderSettings, Fixnum, Hash)>)

    ProviderSettings data, response status code and response headers



2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2758

def orgs_openid_connect_read_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_openid_connect_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_openid_connect_read"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_openid_connect_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/openid-connect/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'ProviderSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_openid_connect_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_openid_connect_update(org, slug_perm, opts = {}) ⇒ ProviderSettingsWrite

Update a specific OpenID Connect provider setting for the org. Update a specific OpenID Connect provider setting for the org.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



2808
2809
2810
2811
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2808

def orgs_openid_connect_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_openid_connect_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_openid_connect_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(ProviderSettingsWrite, Fixnum, Hash)>

Update a specific OpenID Connect provider setting for the org. Update a specific OpenID Connect provider setting for the org.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ProviderSettingsWrite, Fixnum, Hash)>)

    ProviderSettingsWrite data, response status code and response headers



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2820

def orgs_openid_connect_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_openid_connect_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_openid_connect_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_openid_connect_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/openid-connect/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ProviderSettingsWrite')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_openid_connect_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_read(org, opts = {}) ⇒ Organization

Get the details for the specific organization. Get the details for the specific organization.

Parameters:

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

    the optional parameters

Returns:



2868
2869
2870
2871
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2868

def orgs_read(org, opts = {})
  data, _status_code, _headers = orgs_read_with_http_info(org, opts)
  data
end

#orgs_read_with_http_info(org, opts = {}) ⇒ Array<(Organization, Fixnum, Hash)>

Get the details for the specific organization. Get the details for the specific organization.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Organization, Fixnum, Hash)>)

    Organization data, response status code and response headers



2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2878

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

#orgs_retrieve_usage_limits(org, opts = {}) ⇒ InlineResponse200

Parameters:

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

    the optional parameters

Returns:



2921
2922
2923
2924
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2921

def orgs_retrieve_usage_limits(org, opts = {})
  data, _status_code, _headers = orgs_retrieve_usage_limits_with_http_info(org, opts)
  data
end

#orgs_retrieve_usage_limits_with_http_info(org, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Returns InlineResponse200 data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InlineResponse200, Fixnum, Hash)>)

    InlineResponse200 data, response status code and response headers



2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2930

def orgs_retrieve_usage_limits_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_retrieve_usage_limits ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_retrieve_usage_limits"
  end
  # resource path
  local_var_path = '/orgs/{org}/usage-limits/'.sub('{' + 'org' + '}', org.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', 'basic']
  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 => 'InlineResponse200')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_retrieve_usage_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_saml_authentication_partial_update(org, opts = {}) ⇒ OrganizationSAMLAuth

Update the SAML Authentication settings for this Organization. Update the SAML Authentication settings for this Organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2975
2976
2977
2978
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2975

def orgs_saml_authentication_partial_update(org, opts = {})
  data, _status_code, _headers = orgs_saml_authentication_partial_update_with_http_info(org, opts)
  data
end

#orgs_saml_authentication_partial_update_with_http_info(org, opts = {}) ⇒ Array<(OrganizationSAMLAuth, Fixnum, Hash)>

Update the SAML Authentication settings for this Organization. Update the SAML Authentication settings for this Organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationSAMLAuth, Fixnum, Hash)>)

    OrganizationSAMLAuth data, response status code and response headers



2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 2986

def orgs_saml_authentication_partial_update_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_saml_authentication_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_saml_authentication_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/saml-authentication'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationSAMLAuth')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_saml_authentication_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_saml_authentication_read(org, opts = {}) ⇒ OrganizationSAMLAuth

Retrieve the SAML Authentication settings for this Organization. Retrieve the SAML Authentication settings for this Organization.

Parameters:

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

    the optional parameters

Returns:



3030
3031
3032
3033
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3030

def orgs_saml_authentication_read(org, opts = {})
  data, _status_code, _headers = orgs_saml_authentication_read_with_http_info(org, opts)
  data
end

#orgs_saml_authentication_read_with_http_info(org, opts = {}) ⇒ Array<(OrganizationSAMLAuth, Fixnum, Hash)>

Retrieve the SAML Authentication settings for this Organization. Retrieve the SAML Authentication settings for this Organization.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(OrganizationSAMLAuth, Fixnum, Hash)>)

    OrganizationSAMLAuth data, response status code and response headers



3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3040

def orgs_saml_authentication_read_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_saml_authentication_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_saml_authentication_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/saml-authentication'.sub('{' + 'org' + '}', org.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', 'basic']
  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 => 'OrganizationSAMLAuth')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_saml_authentication_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_saml_group_sync_create(org, opts = {}) ⇒ OrganizationGroupSync

Create a new SAML Group Sync mapping within an organization. Create a new SAML Group Sync mapping within an organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3085
3086
3087
3088
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3085

def orgs_saml_group_sync_create(org, opts = {})
  data, _status_code, _headers = orgs_saml_group_sync_create_with_http_info(org, opts)
  data
end

#orgs_saml_group_sync_create_with_http_info(org, opts = {}) ⇒ Array<(OrganizationGroupSync, Fixnum, Hash)>

Create a new SAML Group Sync mapping within an organization. Create a new SAML Group Sync mapping within an organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationGroupSync, Fixnum, Hash)>)

    OrganizationGroupSync data, response status code and response headers



3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3096

def orgs_saml_group_sync_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_saml_group_sync_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_saml_group_sync_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/saml-group-sync/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationGroupSync')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_saml_group_sync_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_saml_group_sync_delete(org, slug_perm, opts = {}) ⇒ nil

Delete a SAML Group Sync mapping from an organization. Delete a SAML Group Sync mapping from an organization.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


3141
3142
3143
3144
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3141

def orgs_saml_group_sync_delete(org, slug_perm, opts = {})
  orgs_saml_group_sync_delete_with_http_info(org, slug_perm, opts)
  nil
end

#orgs_saml_group_sync_delete_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a SAML Group Sync mapping from an organization. Delete a SAML Group Sync mapping from an organization.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3152

def orgs_saml_group_sync_delete_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_saml_group_sync_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_saml_group_sync_delete"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_saml_group_sync_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/saml-group-sync/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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: OrgsApi#orgs_saml_group_sync_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_saml_group_sync_disable(org, opts = {}) ⇒ nil

Disable SAML Group Sync for this organization. Disable SAML Group Sync for this organization.

Parameters:

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

    the optional parameters

Returns:

  • (nil)


3199
3200
3201
3202
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3199

def orgs_saml_group_sync_disable(org, opts = {})
  orgs_saml_group_sync_disable_with_http_info(org, opts)
  nil
end

#orgs_saml_group_sync_disable_with_http_info(org, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Disable SAML Group Sync for this organization. Disable SAML Group Sync for this organization.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3209

def orgs_saml_group_sync_disable_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_saml_group_sync_disable ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_saml_group_sync_disable"
  end
  # resource path
  local_var_path = '/orgs/{org}/saml-group-sync/disable/'.sub('{' + 'org' + '}', org.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', 'basic']
  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: OrgsApi#orgs_saml_group_sync_disable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_saml_group_sync_enable(org, opts = {}) ⇒ nil

Enable SAML Group Sync for this organization. Enable SAML Group Sync for this organization.

Parameters:

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

    the optional parameters

Returns:

  • (nil)


3252
3253
3254
3255
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3252

def orgs_saml_group_sync_enable(org, opts = {})
  orgs_saml_group_sync_enable_with_http_info(org, opts)
  nil
end

#orgs_saml_group_sync_enable_with_http_info(org, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Enable SAML Group Sync for this organization. Enable SAML Group Sync for this organization.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3262

def orgs_saml_group_sync_enable_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_saml_group_sync_enable ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_saml_group_sync_enable"
  end
  # resource path
  local_var_path = '/orgs/{org}/saml-group-sync/enable/'.sub('{' + 'org' + '}', org.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', 'basic']
  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: OrgsApi#orgs_saml_group_sync_enable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_saml_group_sync_list(org, opts = {}) ⇒ Array<OrganizationGroupSync>

Get the details of all SAML Group Sync mapping within an organization. Get the details of all SAML Group Sync mapping within an organization.

Parameters:

  • org
  • 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.

Returns:



3307
3308
3309
3310
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3307

def orgs_saml_group_sync_list(org, opts = {})
  data, _status_code, _headers = orgs_saml_group_sync_list_with_http_info(org, opts)
  data
end

#orgs_saml_group_sync_list_with_http_info(org, opts = {}) ⇒ Array<(Array<OrganizationGroupSync>, Fixnum, Hash)>

Get the details of all SAML Group Sync mapping within an organization. Get the details of all SAML Group Sync mapping within an organization.

Parameters:

  • org
  • 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.

Returns:

  • (Array<(Array<OrganizationGroupSync>, Fixnum, Hash)>)

    Array data, response status code and response headers



3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3319

def orgs_saml_group_sync_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_saml_group_sync_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_saml_group_sync_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/saml-group-sync/'.sub('{' + 'org' + '}', org.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?

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

#orgs_saml_group_sync_status(org, opts = {}) ⇒ OrganizationGroupSyncStatus

Retrieve the SAML Group Sync status for this organization. Retrieve the SAML Group Sync status for this organization.

Parameters:

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

    the optional parameters

Returns:



3365
3366
3367
3368
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3365

def orgs_saml_group_sync_status(org, opts = {})
  data, _status_code, _headers = orgs_saml_group_sync_status_with_http_info(org, opts)
  data
end

#orgs_saml_group_sync_status_with_http_info(org, opts = {}) ⇒ Array<(OrganizationGroupSyncStatus, Fixnum, Hash)>

Retrieve the SAML Group Sync status for this organization. Retrieve the SAML Group Sync status for this organization.

Parameters:

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

    the optional parameters

Returns:



3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3375

def orgs_saml_group_sync_status_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_saml_group_sync_status ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_saml_group_sync_status"
  end
  # resource path
  local_var_path = '/orgs/{org}/saml-group-sync/status/'.sub('{' + 'org' + '}', org.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', 'basic']
  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 => 'OrganizationGroupSyncStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_saml_group_sync_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_services_create(org, opts = {}) ⇒ Service

Create a service within an organization. Create a service within an organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3420
3421
3422
3423
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3420

def orgs_services_create(org, opts = {})
  data, _status_code, _headers = orgs_services_create_with_http_info(org, opts)
  data
end

#orgs_services_create_with_http_info(org, opts = {}) ⇒ Array<(Service, Fixnum, Hash)>

Create a service within an organization. Create a service within an organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Service, Fixnum, Hash)>)

    Service data, response status code and response headers



3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3431

def orgs_services_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_services_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_services_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/services/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'Service')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_services_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_services_delete(org, service, opts = {}) ⇒ nil

Delete a specific service Delete a specific service

Parameters:

  • org
  • service
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


3476
3477
3478
3479
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3476

def orgs_services_delete(org, service, opts = {})
  orgs_services_delete_with_http_info(org, service, opts)
  nil
end

#orgs_services_delete_with_http_info(org, service, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a specific service Delete a specific service

Parameters:

  • org
  • service
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3487

def orgs_services_delete_with_http_info(org, service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_services_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_services_delete"
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling OrgsApi.orgs_services_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/services/{service}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'service' + '}', service.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', 'basic']
  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: OrgsApi#orgs_services_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_services_list(org, opts = {}) ⇒ Array<Service>

Get a list of all services within an organization. Get a list of all services within an organization.

Parameters:

  • org
  • 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.

  • :query (String)

    A search term for querying of services within an Organization.Available options are: name, role (default to )

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-created_at`). Available options: created_at, name, role. (default to created_at)

Returns:



3538
3539
3540
3541
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3538

def orgs_services_list(org, opts = {})
  data, _status_code, _headers = orgs_services_list_with_http_info(org, opts)
  data
end

#orgs_services_list_with_http_info(org, opts = {}) ⇒ Array<(Array<Service>, Fixnum, Hash)>

Get a list of all services within an organization. Get a list of all services within an organization.

Parameters:

  • org
  • 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.

  • :query (String)

    A search term for querying of services within an Organization.Available options are: name, role

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-created_at`). Available options: created_at, name, role.

Returns:

  • (Array<(Array<Service>, Fixnum, Hash)>)

    Array data, response status code and response headers



3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3552

def orgs_services_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_services_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_services_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/services/'.sub('{' + 'org' + '}', org.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[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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', 'basic']
  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<Service>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_services_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_services_partial_update(org, service, opts = {}) ⇒ Service

Update a service within an organization. Update a service within an organization.

Parameters:

  • org
  • service
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



3602
3603
3604
3605
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3602

def orgs_services_partial_update(org, service, opts = {})
  data, _status_code, _headers = orgs_services_partial_update_with_http_info(org, service, opts)
  data
end

#orgs_services_partial_update_with_http_info(org, service, opts = {}) ⇒ Array<(Service, Fixnum, Hash)>

Update a service within an organization. Update a service within an organization.

Parameters:

  • org
  • service
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Service, Fixnum, Hash)>)

    Service data, response status code and response headers



3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3614

def orgs_services_partial_update_with_http_info(org, service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_services_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_services_partial_update"
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling OrgsApi.orgs_services_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/services/{service}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'service' + '}', service.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'Service')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_services_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_services_read(org, service, opts = {}) ⇒ Service

Retrieve details of a single service within an organization. Retrieve details of a single service within an organization.

Parameters:

  • org
  • service
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



3663
3664
3665
3666
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3663

def orgs_services_read(org, service, opts = {})
  data, _status_code, _headers = orgs_services_read_with_http_info(org, service, opts)
  data
end

#orgs_services_read_with_http_info(org, service, opts = {}) ⇒ Array<(Service, Fixnum, Hash)>

Retrieve details of a single service within an organization. Retrieve details of a single service within an organization.

Parameters:

  • org
  • service
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Service, Fixnum, Hash)>)

    Service data, response status code and response headers



3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3674

def orgs_services_read_with_http_info(org, service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_services_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_services_read"
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling OrgsApi.orgs_services_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/services/{service}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'service' + '}', service.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', 'basic']
  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 => 'Service')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_services_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_services_refresh(org, service, opts = {}) ⇒ Service

Refresh service API token. Refresh service API token.

Parameters:

  • org
  • service
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



3723
3724
3725
3726
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3723

def orgs_services_refresh(org, service, opts = {})
  data, _status_code, _headers = orgs_services_refresh_with_http_info(org, service, opts)
  data
end

#orgs_services_refresh_with_http_info(org, service, opts = {}) ⇒ Array<(Service, Fixnum, Hash)>

Refresh service API token. Refresh service API token.

Parameters:

  • org
  • service
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Service, Fixnum, Hash)>)

    Service data, response status code and response headers



3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3734

def orgs_services_refresh_with_http_info(org, service, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_services_refresh ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_services_refresh"
  end
  # verify the required parameter 'service' is set
  if @api_client.config.client_side_validation && service.nil?
    fail ArgumentError, "Missing the required parameter 'service' when calling OrgsApi.orgs_services_refresh"
  end
  # resource path
  local_var_path = '/orgs/{org}/services/{service}/refresh/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'service' + '}', service.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', 'basic']
  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 => 'Service')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_services_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_teams_create(org, opts = {}) ⇒ OrganizationTeam

Create a team for this organization. Create a team for this organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3783
3784
3785
3786
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3783

def orgs_teams_create(org, opts = {})
  data, _status_code, _headers = orgs_teams_create_with_http_info(org, opts)
  data
end

#orgs_teams_create_with_http_info(org, opts = {}) ⇒ Array<(OrganizationTeam, Fixnum, Hash)>

Create a team for this organization. Create a team for this organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationTeam, Fixnum, Hash)>)

    OrganizationTeam data, response status code and response headers



3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3794

def orgs_teams_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_teams_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_teams_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/teams/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationTeam')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_teams_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_teams_delete(org, team, opts = {}) ⇒ nil

Delete a specific team in a organization. Delete a specific team in a organization.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


3839
3840
3841
3842
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3839

def orgs_teams_delete(org, team, opts = {})
  orgs_teams_delete_with_http_info(org, team, opts)
  nil
end

#orgs_teams_delete_with_http_info(org, team, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a specific team in a organization. Delete a specific team in a organization.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3850

def orgs_teams_delete_with_http_info(org, team, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_teams_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_teams_delete"
  end
  # verify the required parameter 'team' is set
  if @api_client.config.client_side_validation && team.nil?
    fail ArgumentError, "Missing the required parameter 'team' when calling OrgsApi.orgs_teams_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/teams/{team}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'team' + '}', team.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', 'basic']
  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: OrgsApi#orgs_teams_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_teams_list(org, opts = {}) ⇒ Array<OrganizationTeam>

Get the details of all teams within an organization. Get the details of all teams within an organization.

Parameters:

  • org
  • 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.

  • :for_user (BOOLEAN)

    Filter for teams that you are a member of. (default to false)

  • :query (String)

    A search term for querying of teams within an Organization.Available options are: name, slug, user, userslug (default to )

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name, members. (default to name)

Returns:



3902
3903
3904
3905
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3902

def orgs_teams_list(org, opts = {})
  data, _status_code, _headers = orgs_teams_list_with_http_info(org, opts)
  data
end

#orgs_teams_list_with_http_info(org, opts = {}) ⇒ Array<(Array<OrganizationTeam>, Fixnum, Hash)>

Get the details of all teams within an organization. Get the details of all teams within an organization.

Parameters:

  • org
  • 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.

  • :for_user (BOOLEAN)

    Filter for teams that you are a member of.

  • :query (String)

    A search term for querying of teams within an Organization.Available options are: name, slug, user, userslug

  • :sort (String)

    A field for sorting objects in ascending or descending order. Use `-` prefix for descending order (e.g., `-name`). Available options: name, members.

Returns:

  • (Array<(Array<OrganizationTeam>, Fixnum, Hash)>)

    Array data, response status code and response headers



3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3917

def orgs_teams_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_teams_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_teams_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/teams/'.sub('{' + 'org' + '}', org.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[:'for_user'] = opts[:'for_user'] if !opts[:'for_user'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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', 'basic']
  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<OrganizationTeam>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_teams_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_teams_members_create(org, team, opts = {}) ⇒ OrganizationTeamMembers

Add users to a team. Add users to a team.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



3968
3969
3970
3971
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3968

def orgs_teams_members_create(org, team, opts = {})
  data, _status_code, _headers = orgs_teams_members_create_with_http_info(org, team, opts)
  data
end

#orgs_teams_members_create_with_http_info(org, team, opts = {}) ⇒ Array<(OrganizationTeamMembers, Fixnum, Hash)>

Add users to a team. Add users to a team.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationTeamMembers, Fixnum, Hash)>)

    OrganizationTeamMembers data, response status code and response headers



3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 3980

def orgs_teams_members_create_with_http_info(org, team, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_teams_members_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_teams_members_create"
  end
  # verify the required parameter 'team' is set
  if @api_client.config.client_side_validation && team.nil?
    fail ArgumentError, "Missing the required parameter 'team' when calling OrgsApi.orgs_teams_members_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/teams/{team}/members'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'team' + '}', team.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationTeamMembers')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_teams_members_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_teams_members_list(org, team, opts = {}) ⇒ OrganizationTeamMembers

List all members for the team. List all members for the team.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :user_kind (String)

    Filter accounts by type. Possible values are 'user' and 'service'. If not provided, only users are returned. (default to )

Returns:



4030
4031
4032
4033
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4030

def orgs_teams_members_list(org, team, opts = {})
  data, _status_code, _headers = orgs_teams_members_list_with_http_info(org, team, opts)
  data
end

#orgs_teams_members_list_with_http_info(org, team, opts = {}) ⇒ Array<(OrganizationTeamMembers, Fixnum, Hash)>

List all members for the team. List all members for the team.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :user_kind (String)

    Filter accounts by type. Possible values are 'user' and 'service'. If not provided, only users are returned.

Returns:

  • (Array<(OrganizationTeamMembers, Fixnum, Hash)>)

    OrganizationTeamMembers data, response status code and response headers



4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4042

def orgs_teams_members_list_with_http_info(org, team, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_teams_members_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_teams_members_list"
  end
  # verify the required parameter 'team' is set
  if @api_client.config.client_side_validation && team.nil?
    fail ArgumentError, "Missing the required parameter 'team' when calling OrgsApi.orgs_teams_members_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/teams/{team}/members'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'team' + '}', team.to_s)

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

#orgs_teams_members_update(org, team, opts = {}) ⇒ OrganizationTeamMembers

Replace all team members. Replace all team members.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



4093
4094
4095
4096
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4093

def orgs_teams_members_update(org, team, opts = {})
  data, _status_code, _headers = orgs_teams_members_update_with_http_info(org, team, opts)
  data
end

#orgs_teams_members_update_with_http_info(org, team, opts = {}) ⇒ Array<(OrganizationTeamMembers, Fixnum, Hash)>

Replace all team members. Replace all team members.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationTeamMembers, Fixnum, Hash)>)

    OrganizationTeamMembers data, response status code and response headers



4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4105

def orgs_teams_members_update_with_http_info(org, team, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_teams_members_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_teams_members_update"
  end
  # verify the required parameter 'team' is set
  if @api_client.config.client_side_validation && team.nil?
    fail ArgumentError, "Missing the required parameter 'team' when calling OrgsApi.orgs_teams_members_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/teams/{team}/members'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'team' + '}', team.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OrganizationTeamMembers')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_teams_members_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_teams_partial_update(org, team, opts = {}) ⇒ OrganizationTeam

Update a specific team in a organization. Update a specific team in a organization.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



4155
4156
4157
4158
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4155

def orgs_teams_partial_update(org, team, opts = {})
  data, _status_code, _headers = orgs_teams_partial_update_with_http_info(org, team, opts)
  data
end

#orgs_teams_partial_update_with_http_info(org, team, opts = {}) ⇒ Array<(OrganizationTeam, Fixnum, Hash)>

Update a specific team in a organization. Update a specific team in a organization.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OrganizationTeam, Fixnum, Hash)>)

    OrganizationTeam data, response status code and response headers



4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4167

def orgs_teams_partial_update_with_http_info(org, team, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_teams_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_teams_partial_update"
  end
  # verify the required parameter 'team' is set
  if @api_client.config.client_side_validation && team.nil?
    fail ArgumentError, "Missing the required parameter 'team' when calling OrgsApi.orgs_teams_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/teams/{team}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'team' + '}', team.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationTeam')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_teams_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_teams_read(org, team, opts = {}) ⇒ OrganizationTeam

Get the details of a specific team within an organization. Get the details of a specific team within an organization.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



4216
4217
4218
4219
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4216

def orgs_teams_read(org, team, opts = {})
  data, _status_code, _headers = orgs_teams_read_with_http_info(org, team, opts)
  data
end

#orgs_teams_read_with_http_info(org, team, opts = {}) ⇒ Array<(OrganizationTeam, Fixnum, Hash)>

Get the details of a specific team within an organization. Get the details of a specific team within an organization.

Parameters:

  • org
  • team
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(OrganizationTeam, Fixnum, Hash)>)

    OrganizationTeam data, response status code and response headers



4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4227

def orgs_teams_read_with_http_info(org, team, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_teams_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_teams_read"
  end
  # verify the required parameter 'team' is set
  if @api_client.config.client_side_validation && team.nil?
    fail ArgumentError, "Missing the required parameter 'team' when calling OrgsApi.orgs_teams_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/teams/{team}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'team' + '}', team.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', 'basic']
  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 => 'OrganizationTeam')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_teams_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_update_usage_limits(org, opts = {}) ⇒ InlineResponse2001

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4275
4276
4277
4278
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4275

def orgs_update_usage_limits(org, opts = {})
  data, _status_code, _headers = orgs_update_usage_limits_with_http_info(org, opts)
  data
end

#orgs_update_usage_limits_with_http_info(org, opts = {}) ⇒ Array<(InlineResponse2001, Fixnum, Hash)>

Returns InlineResponse2001 data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(InlineResponse2001, Fixnum, Hash)>)

    InlineResponse2001 data, response status code and response headers



4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4285

def orgs_update_usage_limits_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_update_usage_limits ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_update_usage_limits"
  end
  # resource path
  local_var_path = '/orgs/{org}/usage-limits/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'InlineResponse2001')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_update_usage_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_vulnerability_policy_create(org, opts = {}) ⇒ OrganizationPackageVulnerabilityPolicy

Create a package vulnerability policy. Create a package vulnerability policy.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4330
4331
4332
4333
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4330

def orgs_vulnerability_policy_create(org, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_create_with_http_info(org, opts)
  data
end

#orgs_vulnerability_policy_create_with_http_info(org, opts = {}) ⇒ Array<(OrganizationPackageVulnerabilityPolicy, Fixnum, Hash)>

Create a package vulnerability policy. Create a package vulnerability policy.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4341

def orgs_vulnerability_policy_create_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/'.sub('{' + 'org' + '}', org.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationPackageVulnerabilityPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_vulnerability_policy_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_vulnerability_policy_delete(org, slug_perm, opts = {}) ⇒ nil

Delete a package vulnerability policy. Delete a package vulnerability policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


4386
4387
4388
4389
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4386

def orgs_vulnerability_policy_delete(org, slug_perm, opts = {})
  orgs_vulnerability_policy_delete_with_http_info(org, slug_perm, opts)
  nil
end

#orgs_vulnerability_policy_delete_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a package vulnerability policy. Delete a package vulnerability policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4397

def orgs_vulnerability_policy_delete_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_delete ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_delete"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_vulnerability_policy_delete"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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: OrgsApi#orgs_vulnerability_policy_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_vulnerability_policy_evaluation_create(org, policy_slug_perm, opts = {}) ⇒ PackageVulnerabilityPolicyEvaluationRequest

Create an evaluation request for this policy. Create an evaluation request for this policy.

Parameters:

  • org
  • policy_slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



4446
4447
4448
4449
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4446

def orgs_vulnerability_policy_evaluation_create(org, policy_slug_perm, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_evaluation_create_with_http_info(org, policy_slug_perm, opts)
  data
end

#orgs_vulnerability_policy_evaluation_create_with_http_info(org, policy_slug_perm, opts = {}) ⇒ Array<(PackageVulnerabilityPolicyEvaluationRequest, Fixnum, Hash)>

Create an evaluation request for this policy. Create an evaluation request for this policy.

Parameters:

  • org
  • policy_slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4458

def orgs_vulnerability_policy_evaluation_create_with_http_info(org, policy_slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_evaluation_create ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_evaluation_create"
  end
  # verify the required parameter 'policy_slug_perm' is set
  if @api_client.config.client_side_validation && policy_slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'policy_slug_perm' when calling OrgsApi.orgs_vulnerability_policy_evaluation_create"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'policy_slug_perm' + '}', policy_slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'PackageVulnerabilityPolicyEvaluationRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_vulnerability_policy_evaluation_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_vulnerability_policy_evaluation_list(org, policy_slug_perm, opts = {}) ⇒ Array<PackageVulnerabilityPolicyEvaluationRequest>

List evaluation requests for this policy. List evaluation requests for this policy.

Parameters:

  • org
  • policy_slug_perm
  • 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.

Returns:



4509
4510
4511
4512
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4509

def orgs_vulnerability_policy_evaluation_list(org, policy_slug_perm, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_evaluation_list_with_http_info(org, policy_slug_perm, opts)
  data
end

#orgs_vulnerability_policy_evaluation_list_with_http_info(org, policy_slug_perm, opts = {}) ⇒ Array<(Array<PackageVulnerabilityPolicyEvaluationRequest>, Fixnum, Hash)>

List evaluation requests for this policy. List evaluation requests for this policy.

Parameters:

  • org
  • policy_slug_perm
  • 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.

Returns:



4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4522

def orgs_vulnerability_policy_evaluation_list_with_http_info(org, policy_slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_evaluation_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_evaluation_list"
  end
  # verify the required parameter 'policy_slug_perm' is set
  if @api_client.config.client_side_validation && policy_slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'policy_slug_perm' when calling OrgsApi.orgs_vulnerability_policy_evaluation_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'policy_slug_perm' + '}', policy_slug_perm.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?

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

#orgs_vulnerability_policy_evaluation_read(org, policy_slug_perm, slug_perm, opts = {}) ⇒ PackageVulnerabilityPolicyEvaluationRequest

Retrieve an evaluation request for this policy. Retrieve an evaluation request for this policy.

Parameters:

  • org
  • policy_slug_perm
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



4574
4575
4576
4577
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4574

def orgs_vulnerability_policy_evaluation_read(org, policy_slug_perm, slug_perm, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_evaluation_read_with_http_info(org, policy_slug_perm, slug_perm, opts)
  data
end

#orgs_vulnerability_policy_evaluation_read_with_http_info(org, policy_slug_perm, slug_perm, opts = {}) ⇒ Array<(PackageVulnerabilityPolicyEvaluationRequest, Fixnum, Hash)>

Retrieve an evaluation request for this policy. Retrieve an evaluation request for this policy.

Parameters:

  • org
  • policy_slug_perm
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4586

def orgs_vulnerability_policy_evaluation_read_with_http_info(org, policy_slug_perm, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_evaluation_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_evaluation_read"
  end
  # verify the required parameter 'policy_slug_perm' is set
  if @api_client.config.client_side_validation && policy_slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'policy_slug_perm' when calling OrgsApi.orgs_vulnerability_policy_evaluation_read"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_vulnerability_policy_evaluation_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'policy_slug_perm' + '}', policy_slug_perm.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'PackageVulnerabilityPolicyEvaluationRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_vulnerability_policy_evaluation_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_vulnerability_policy_list(org, opts = {}) ⇒ Array<OrganizationPackageVulnerabilityPolicy>

Get a list of all package vulnerability policies. Get a list of all package vulnerability policies.

Parameters:

  • org
  • 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.

Returns:



4640
4641
4642
4643
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4640

def orgs_vulnerability_policy_list(org, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_list_with_http_info(org, opts)
  data
end

#orgs_vulnerability_policy_list_with_http_info(org, opts = {}) ⇒ Array<(Array<OrganizationPackageVulnerabilityPolicy>, Fixnum, Hash)>

Get a list of all package vulnerability policies. Get a list of all package vulnerability policies.

Parameters:

  • org
  • 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.

Returns:



4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4652

def orgs_vulnerability_policy_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/'.sub('{' + 'org' + '}', org.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?

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

#orgs_vulnerability_policy_partial_update(org, slug_perm, opts = {}) ⇒ OrganizationPackageVulnerabilityPolicy

Partially update a package vulnerability policy. Partially update a package vulnerability policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



4700
4701
4702
4703
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4700

def orgs_vulnerability_policy_partial_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_partial_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_vulnerability_policy_partial_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationPackageVulnerabilityPolicy, Fixnum, Hash)>

Partially update a package vulnerability policy. Partially update a package vulnerability policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4712

def orgs_vulnerability_policy_partial_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_partial_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_partial_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_vulnerability_policy_partial_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  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 => 'OrganizationPackageVulnerabilityPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_vulnerability_policy_partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_vulnerability_policy_read(org, slug_perm, opts = {}) ⇒ OrganizationPackageVulnerabilityPolicy

Get a package vulnerability policy. Get a package vulnerability policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



4761
4762
4763
4764
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4761

def orgs_vulnerability_policy_read(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_read_with_http_info(org, slug_perm, opts)
  data
end

#orgs_vulnerability_policy_read_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationPackageVulnerabilityPolicy, Fixnum, Hash)>

Get a package vulnerability policy. Get a package vulnerability policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4772

def orgs_vulnerability_policy_read_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_read ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_read"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_vulnerability_policy_read"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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', 'basic']
  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 => 'OrganizationPackageVulnerabilityPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_vulnerability_policy_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_vulnerability_policy_update(org, slug_perm, opts = {}) ⇒ OrganizationPackageVulnerabilityPolicy

Update a package vulnerability policy. Update a package vulnerability policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



4822
4823
4824
4825
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4822

def orgs_vulnerability_policy_update(org, slug_perm, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_update_with_http_info(org, slug_perm, opts)
  data
end

#orgs_vulnerability_policy_update_with_http_info(org, slug_perm, opts = {}) ⇒ Array<(OrganizationPackageVulnerabilityPolicy, Fixnum, Hash)>

Update a package vulnerability policy. Update a package vulnerability policy.

Parameters:

  • org
  • slug_perm
  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:



4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4834

def orgs_vulnerability_policy_update_with_http_info(org, slug_perm, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_update ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_update"
  end
  # verify the required parameter 'slug_perm' is set
  if @api_client.config.client_side_validation && slug_perm.nil?
    fail ArgumentError, "Missing the required parameter 'slug_perm' when calling OrgsApi.orgs_vulnerability_policy_update"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy/{slug_perm}/'.sub('{' + 'org' + '}', org.to_s).sub('{' + 'slug_perm' + '}', slug_perm.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(opts[:'data'])
  auth_names = ['apikey', 'basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OrganizationPackageVulnerabilityPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrgsApi#orgs_vulnerability_policy_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#orgs_vulnerability_policy_violation_list(org, opts = {}) ⇒ PackageVulnerabilityPolicyViolationLogCursorPage

List all current vulnerability policy violations for this Organization. List all current vulnerability policy violations for this Organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)

    The pagination cursor value.

  • :page_size (Integer)

    Number of results to return per page.

Returns:



4884
4885
4886
4887
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4884

def orgs_vulnerability_policy_violation_list(org, opts = {})
  data, _status_code, _headers = orgs_vulnerability_policy_violation_list_with_http_info(org, opts)
  data
end

#orgs_vulnerability_policy_violation_list_with_http_info(org, opts = {}) ⇒ Array<(PackageVulnerabilityPolicyViolationLogCursorPage, Fixnum, Hash)>

List all current vulnerability policy violations for this Organization. List all current vulnerability policy violations for this Organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)

    The pagination cursor value.

  • :page_size (Integer)

    Number of results to return per page.

Returns:



4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
# File 'lib/cloudsmith-api/api/orgs_api.rb', line 4896

def orgs_vulnerability_policy_violation_list_with_http_info(org, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrgsApi.orgs_vulnerability_policy_violation_list ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling OrgsApi.orgs_vulnerability_policy_violation_list"
  end
  # resource path
  local_var_path = '/orgs/{org}/vulnerability-policy-violation/'.sub('{' + 'org' + '}', org.to_s)

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