cloudsmith-api 0.52.92 → 0.53.79

data/docs/RepositoryTokenRefresh.md

@@ -3,14 +3,20 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**clients** | **Integer** |  | [optional] 
 **created_at** | **String** | The datetime the token was updated at. | [optional] 
 **created_by** | **String** |  | [optional] 
 **created_by_url** | **String** |  | [optional] 
 **default** | **BOOLEAN** | If selected this is the default token for this repository. | [optional] 
+**disable_url** | **String** |  | [optional] 
+**downloads** | **Integer** |  | [optional] 
+**enable_url** | **String** |  | [optional] 
 **has_limits** | **BOOLEAN** |  | [optional] 
 **identifier** | **Integer** |  | [optional] 
 **is_active** | **BOOLEAN** | If enabled, the token will allow downloads based on configured restrictions (if any). | [optional] 
 **is_limited** | **BOOLEAN** |  | [optional] 
+**limit_bandwidth** | **Integer** | The maximum download bandwidth allowed for the token. Values are expressed as the selected unit of bandwidth. Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.  | [optional] 
+**limit_bandwidth_unit** | **String** |  | [optional] 
 **limit_date_range_from** | **String** | The starting date/time the token is allowed to be used from. | [optional] 
 **limit_date_range_to** | **String** | The ending date/time the token is allowed to be used until. | [optional] 
 **limit_num_clients** | **Integer** | The maximum number of unique clients allowed for the token. Please note that since clients are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point. | [optional] 
@@ -20,6 +26,9 @@ Name | Type | Description | Notes
 **metadata** | **Object** |  | [optional] 
 **name** | **String** |  | [optional] 
 **refresh_url** | **String** |  | [optional] 
+**reset_url** | **String** |  | [optional] 
+**scheduled_reset_at** | **String** | The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero. | [optional] 
+**scheduled_reset_period** | **String** |  | [optional] 
 **self_url** | **String** |  | [optional] 
 **slug_perm** | **String** |  | [optional] 
 **token** | **String** |  | [optional] 

data/docs/RepositoryTokenSyncTokens.md

@@ -3,14 +3,20 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**clients** | **Integer** |  | [optional] 
 **created_at** | **String** | The datetime the token was updated at. | [optional] 
 **created_by** | **String** |  | [optional] 
 **created_by_url** | **String** |  | [optional] 
 **default** | **BOOLEAN** | If selected this is the default token for this repository. | [optional] 
+**disable_url** | **String** |  | [optional] 
+**downloads** | **Integer** |  | [optional] 
+**enable_url** | **String** |  | [optional] 
 **has_limits** | **BOOLEAN** |  | [optional] 
 **identifier** | **Integer** |  | [optional] 
 **is_active** | **BOOLEAN** | If enabled, the token will allow downloads based on configured restrictions (if any). | [optional] 
 **is_limited** | **BOOLEAN** |  | [optional] 
+**limit_bandwidth** | **Integer** | The maximum download bandwidth allowed for the token. Values are expressed as the selected unit of bandwidth. Please note that since downloads are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point.  | [optional] 
+**limit_bandwidth_unit** | **String** |  | [optional] 
 **limit_date_range_from** | **String** | The starting date/time the token is allowed to be used from. | [optional] 
 **limit_date_range_to** | **String** | The ending date/time the token is allowed to be used until. | [optional] 
 **limit_num_clients** | **Integer** | The maximum number of unique clients allowed for the token. Please note that since clients are calculated asynchronously (after the download happens), the limit may not be imposed immediately but at a later point. | [optional] 
@@ -20,6 +26,9 @@ Name | Type | Description | Notes
 **metadata** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **refresh_url** | **String** |  | [optional] 
+**reset_url** | **String** |  | [optional] 
+**scheduled_reset_at** | **String** | The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero. | [optional] 
+**scheduled_reset_period** | **String** |  | [optional] 
 **self_url** | **String** |  | [optional] 
 **slug_perm** | **String** |  | [optional] 
 **token** | **String** |  | [optional] 

data/docs/StorageregionsApi.md

@@ -25,11 +25,6 @@ CloudsmithApi.configure do |config|
   config.api_key['X-Api-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['X-Api-Key'] = 'Bearer'
-
-  # Configure API key authorization: csrf_token
-  config.api_key['X-CSRFToken'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-CSRFToken'] = 'Bearer'
 end
 
 api_instance = CloudsmithApi::StorageregionsApi.new
@@ -52,7 +47,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 
 ### HTTP request headers
 
@@ -78,11 +73,6 @@ CloudsmithApi.configure do |config|
   config.api_key['X-Api-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['X-Api-Key'] = 'Bearer'
-
-  # Configure API key authorization: csrf_token
-  config.api_key['X-CSRFToken'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-CSRFToken'] = 'Bearer'
 end
 
 api_instance = CloudsmithApi::StorageregionsApi.new
@@ -111,7 +101,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 
 ### HTTP request headers
 

data/docs/UserApi.md

@@ -25,11 +25,6 @@ CloudsmithApi.configure do |config|
   config.api_key['X-Api-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['X-Api-Key'] = 'Bearer'
-
-  # Configure API key authorization: csrf_token
-  config.api_key['X-CSRFToken'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-CSRFToken'] = 'Bearer'
 end
 
 api_instance = CloudsmithApi::UserApi.new
@@ -52,7 +47,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 
 ### HTTP request headers
 
@@ -78,11 +73,6 @@ CloudsmithApi.configure do |config|
   config.api_key['X-Api-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['X-Api-Key'] = 'Bearer'
-
-  # Configure API key authorization: csrf_token
-  config.api_key['X-CSRFToken'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-CSRFToken'] = 'Bearer'
 end
 
 api_instance = CloudsmithApi::UserApi.new
@@ -112,7 +102,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 
 ### HTTP request headers
 

data/docs/UsersApi.md

@@ -24,11 +24,6 @@ CloudsmithApi.configure do |config|
   config.api_key['X-Api-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['X-Api-Key'] = 'Bearer'
-
-  # Configure API key authorization: csrf_token
-  config.api_key['X-CSRFToken'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-CSRFToken'] = 'Bearer'
 end
 
 api_instance = CloudsmithApi::UsersApi.new
@@ -57,7 +52,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 
 ### HTTP request headers
 

data/docs/VagrantPackageUpload.md

@@ -39,7 +39,7 @@ Name | Type | Description | Notes
 **self_html_url** | **String** |  | [optional] 
 **self_url** | **String** |  | [optional] 
 **size** | **Integer** | The calculated size of the package. | [optional] 
-**slug** | **String** |  | [optional] 
+**slug** | **String** | The public unique identifier for the package. | [optional] 
 **slug_perm** | **String** |  | [optional] 
 **stage** | **String** | The synchronisation (in progress) stage of the package. | [optional] 
 **stage_str** | **String** |  | [optional] 
@@ -60,5 +60,6 @@ Name | Type | Description | Notes
 **uploader_url** | **String** |  | [optional] 
 **version** | **String** | The raw version for this package. | 
 **version_orig** | **String** |  | [optional] 
+**vulnerability_scan_results_url** | **String** |  | [optional] 
 
 

data/docs/VulnerabilitiesApi.md

@@ -0,0 +1,264 @@
+# CloudsmithApi::VulnerabilitiesApi
+
+All URIs are relative to *https://api.cloudsmith.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**vulnerabilities_list**](VulnerabilitiesApi.md#vulnerabilities_list) | **GET** /vulnerabilities/{owner}/ | Read-only view to list vulnerabiltiy scan results within a Namespace.
+[**vulnerabilities_list0**](VulnerabilitiesApi.md#vulnerabilities_list0) | **GET** /vulnerabilities/{owner}/{repo}/ | Read-only views to list vulnerabiltiy scan results within a Repository.
+[**vulnerabilities_list1**](VulnerabilitiesApi.md#vulnerabilities_list1) | **GET** /vulnerabilities/{owner}/{repo}/{package}/ | Read-only views to list vulnerabiltiy scan results within a Repository
+[**vulnerabilities_read**](VulnerabilitiesApi.md#vulnerabilities_read) | **GET** /vulnerabilities/{owner}/{repo}/{package}/{scan_id}/ | Read-only view to retrieve vulnerability scans results using a
+
+
+# **vulnerabilities_list**
+> Array<VulnerabilityScanResultsList> vulnerabilities_list(owner, opts)
+
+Read-only view to list vulnerabiltiy scan results within a Namespace.
+
+Read-only view to list vulnerabiltiy scan results within a Namespace.
+
+### Example
+```ruby
+# load the gem
+require 'cloudsmith-api'
+# setup authorization
+CloudsmithApi.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = CloudsmithApi::VulnerabilitiesApi.new
+
+owner = "owner_example" # String | 
+
+opts = { 
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #Read-only view to list vulnerabiltiy scan results within a Namespace.
+  result = api_instance.vulnerabilities_list(owner, opts)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  | 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **page_size** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**Array<VulnerabilityScanResultsList>**](VulnerabilityScanResultsList.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **vulnerabilities_list0**
+> Array<VulnerabilityScanResultsList> vulnerabilities_list0(owner, repo, opts)
+
+Read-only views to list vulnerabiltiy scan results within a Repository.
+
+Read-only views to list vulnerabiltiy scan results within a Repository.
+
+### Example
+```ruby
+# load the gem
+require 'cloudsmith-api'
+# setup authorization
+CloudsmithApi.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = CloudsmithApi::VulnerabilitiesApi.new
+
+owner = "owner_example" # String | 
+
+repo = "repo_example" # String | 
+
+opts = { 
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #Read-only views to list vulnerabiltiy scan results within a Repository.
+  result = api_instance.vulnerabilities_list0(owner, repo, opts)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list0: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  | 
+ **repo** | **String**|  | 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **page_size** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**Array<VulnerabilityScanResultsList>**](VulnerabilityScanResultsList.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **vulnerabilities_list1**
+> Array<VulnerabilityScanResultsList> vulnerabilities_list1(owner, repo, package, opts)
+
+Read-only views to list vulnerabiltiy scan results within a Repository
+
+Read-only views to list vulnerabiltiy scan results within a Repository for a given Package identifier.
+
+### Example
+```ruby
+# load the gem
+require 'cloudsmith-api'
+# setup authorization
+CloudsmithApi.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = CloudsmithApi::VulnerabilitiesApi.new
+
+owner = "owner_example" # String | 
+
+repo = "repo_example" # String | 
+
+package = "package_example" # String | The package that the scan result relates to.
+
+opts = { 
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #Read-only views to list vulnerabiltiy scan results within a Repository
+  result = api_instance.vulnerabilities_list1(owner, repo, package, opts)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling VulnerabilitiesApi->vulnerabilities_list1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  | 
+ **repo** | **String**|  | 
+ **package** | **String**| The package that the scan result relates to. | 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **page_size** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**Array<VulnerabilityScanResultsList>**](VulnerabilityScanResultsList.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **vulnerabilities_read**
+> VulnerabilityScanResults vulnerabilities_read(owner, repo, package, scan_id)
+
+Read-only view to retrieve vulnerability scans results using a
+
+Read-only view to retrieve vulnerability scans results using a vulnerabiltiy scan results identifier (slug_perm).
+
+### Example
+```ruby
+# load the gem
+require 'cloudsmith-api'
+# setup authorization
+CloudsmithApi.configure do |config|
+  # Configure API key authorization: apikey
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = CloudsmithApi::VulnerabilitiesApi.new
+
+owner = "owner_example" # String | 
+
+repo = "repo_example" # String | 
+
+package = "package_example" # String | The package that the scan result relates to.
+
+scan_id = "scan_id_example" # String | A sequential identifier that increments by one for each new scan result within a package. These are always unique and can be used to reference the scan results elsewhere (e.g. via the CLI.)
+
+
+begin
+  #Read-only view to retrieve vulnerability scans results using a
+  result = api_instance.vulnerabilities_read(owner, repo, package, scan_id)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling VulnerabilitiesApi->vulnerabilities_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  | 
+ **repo** | **String**|  | 
+ **package** | **String**| The package that the scan result relates to. | 
+ **scan_id** | **String**| A sequential identifier that increments by one for each new scan result within a package. These are always unique and can be used to reference the scan results elsewhere (e.g. via the CLI.) | 
+
+### Return type
+
+[**VulnerabilityScanResults**](VulnerabilityScanResults.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/VulnerabilityScanResults.md

@@ -0,0 +1,15 @@
+# CloudsmithApi::VulnerabilityScanResults
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **String** | The time this scan result was stored. | [optional] 
+**has_vulnerabilities** | **BOOLEAN** | Do the results contain any known vulnerabilities? | [optional] 
+**identifier** | **String** |  | 
+**max_severity** | **String** |  | [optional] 
+**num_vulnerabilities** | **Integer** |  | [optional] 
+**package** | **Object** |  | 
+**scan** | **Object** |  | 
+**scan_id** | **Integer** |  | 
+
+