RubyGems - cloudsmith-api - Versions diffs - 0.52.121 → 0.54.15 - Mend

cloudsmith-api 0.52.121 → 0.54.15

Files changed (593) hide show

@@ -4,6 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **is_active** | **BOOLEAN** | If enabled, the token will allow downloads based on configured restrictions (if any). | [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** | None | [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]
@@ -12,6 +14,8 @@ Name | Type | Description | Notes
 **limit_path_query** | **String** | The path-based search query to apply to restrict downloads to. This supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. The path evaluated does not include the domain name, the namespace, the entitlement code used, the package format, etc. and it always starts with a forward slash. | [optional]
 **metadata** | **Object** | None | [optional]
 **name** | **String** | None |
+**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** | None | [optional]
 **token** | **String** | None | [optional]

data/docs/EntitlementsPartialUpdate.md CHANGED

@@ -4,6 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **is_active** | **BOOLEAN** | If enabled, the token will allow downloads based on configured restrictions (if any). | [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** | None | [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]
@@ -12,6 +14,8 @@ Name | Type | Description | Notes
 **limit_path_query** | **String** | The path-based search query to apply to restrict downloads to. This supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. The path evaluated does not include the domain name, the namespace, the entitlement code used, the package format, etc. and it always starts with a forward slash. | [optional]
 **metadata** | **Object** | None | [optional]
 **name** | **String** | None | [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** | None | [optional]
 **token** | **String** | None | [optional]

data/docs/EntitlementsRefresh.md CHANGED

@@ -4,6 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **is_active** | **BOOLEAN** | If enabled, the token will allow downloads based on configured restrictions (if any). | [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** | None | [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]
@@ -11,6 +13,8 @@ Name | Type | Description | Notes
 **limit_package_query** | **String** | The package-based search query to apply to restrict downloads to. This uses the same syntax as the standard search used for repositories, and also supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. This will still allow access to non-package files, such as metadata. | [optional]
 **limit_path_query** | **String** | The path-based search query to apply to restrict downloads to. This supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. The path evaluated does not include the domain name, the namespace, the entitlement code used, the package format, etc. and it always starts with a forward slash. | [optional]
 **metadata** | **Object** | None | [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** | None | [optional]
 **token** | **String** | None | [optional]

data/docs/FilesApi.md CHANGED

@@ -28,11 +28,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::FilesApi.new
@@ -70,7 +65,7 @@ nil (empty response body)
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -96,11 +91,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::FilesApi.new
@@ -139,7 +129,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -165,11 +155,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::FilesApi.new
@@ -205,7 +190,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -231,11 +216,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::FilesApi.new
@@ -270,7 +250,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -296,11 +276,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::FilesApi.new
@@ -335,7 +310,7 @@ nil (empty response body)
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers

data/docs/FormatsApi.md CHANGED

@@ -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::FormatsApi.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::FormatsApi.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/MavenPackageUpload.md CHANGED

@@ -38,10 +38,14 @@ Name | Type | Description | Notes
 **release** | **String** | The release of the package version (if any). | [optional]
 **repository** | **String** |  | [optional]
 **repository_url** | **String** |  | [optional]
+**security_scan_completed_at** | **String** | The datetime the security scanning was completed. | [optional]
+**security_scan_started_at** | **String** | The datetime the security scanning was started. | [optional]
+**security_scan_status** | **String** |  | [optional]
+**security_scan_status_updated_at** | **String** | The datetime the security scanning status was updated. | [optional]
 **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]
@@ -62,5 +66,6 @@ Name | Type | Description | Notes
 **uploader_url** | **String** |  | [optional]
 **version** | **String** | The raw version for this package. | [optional]
 **version_orig** | **String** |  | [optional]
+**vulnerability_scan_results_url** | **String** |  | [optional]

data/docs/MetricsApi.md CHANGED

@@ -4,12 +4,13 @@ All URIs are relative to *https://api.cloudsmith.io*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**metrics_entitlements_usage_list**](MetricsApi.md#metrics_entitlements_usage_list) | **GET** /metrics/{owner}/{repo}/entitlements/usage/ | View for listing entitlement token usage as a metric.
+[**metrics_entitlements_usage_list**](MetricsApi.md#metrics_entitlements_usage_list) | **GET** /metrics/{owner}/entitlements/usage/ | View for listing entitlement token usage as a metric.
+[**metrics_entitlements_usage_list0**](MetricsApi.md#metrics_entitlements_usage_list0) | **GET** /metrics/{owner}/{repo}/entitlements/usage/ | View for listing entitlement token usage as a metric.
 [**metrics_packages_usage_list**](MetricsApi.md#metrics_packages_usage_list) | **GET** /metrics/{owner}/{repo}/packages/usage/ | View for listing package usage metrics by user.
 # **metrics_entitlements_usage_list**
-> Array&lt;EntitlementTokenMetric&gt; metrics_entitlements_usage_list(owner, repo, opts)
+> Array&lt;EntitlementUsageMetric&gt; metrics_entitlements_usage_list(owner, opts)
 View for listing entitlement token usage as a metric.
@@ -25,11 +26,72 @@ 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'
+end
+api_instance = CloudsmithApi::MetricsApi.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.
+  finish: 56, # Integer | Filter token usage ending before this datetime (UTC by default unless otherwise specified). Defaults to now if not supplied.
+  start: 56, # Integer | Filter token usage starting from this datetime (UTC by default unless otherwise specified)).
+  tokens: "tokens_example" # String | A comma seperated list of tokens (slug perm) to include in the results.
+}
+begin
+  #View for listing entitlement token usage as a metric.
+  result = api_instance.metrics_entitlements_usage_list(owner, opts)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling MetricsApi->metrics_entitlements_usage_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]
+ **finish** | **Integer**| Filter token usage ending before this datetime (UTC by default unless otherwise specified). Defaults to now if not supplied. | [optional]
+ **start** | **Integer**| Filter token usage starting from this datetime (UTC by default unless otherwise specified)). | [optional]
+ **tokens** | **String**| A comma seperated list of tokens (slug perm) to include in the results. | [optional]
+### Return type
+[**Array&lt;EntitlementUsageMetric&gt;**](EntitlementUsageMetric.md)
+### Authorization
+[apikey](../README.md#apikey)
+### HTTP request headers
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
-  # Configure API key authorization: csrf_token
-  config.api_key['X-CSRFToken'] = 'YOUR API KEY'
+# **metrics_entitlements_usage_list0**
+> Array&lt;EntitlementUsageMetric&gt; metrics_entitlements_usage_list0(owner, repo, opts)
+View for listing entitlement token usage as a metric.
+View for listing entitlement token usage as a metric.
+### 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-CSRFToken'] = 'Bearer'
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
 end
 api_instance = CloudsmithApi::MetricsApi.new
@@ -48,10 +110,10 @@ opts = {
 begin
   #View for listing entitlement token usage as a metric.
-  result = api_instance.metrics_entitlements_usage_list(owner, repo, opts)
+  result = api_instance.metrics_entitlements_usage_list0(owner, repo, opts)
   p result
 rescue CloudsmithApi::ApiError => e
-  puts "Exception when calling MetricsApi->metrics_entitlements_usage_list: #{e}"
+  puts "Exception when calling MetricsApi->metrics_entitlements_usage_list0: #{e}"
 end
 ```
@@ -69,11 +131,11 @@ Name | Type | Description  | Notes
 ### Return type
-[**Array&lt;EntitlementTokenMetric&gt;**](EntitlementTokenMetric.md)
+[**Array&lt;EntitlementUsageMetric&gt;**](EntitlementUsageMetric.md)
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -99,11 +161,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::MetricsApi.new
@@ -147,7 +204,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/NamespacesApi.md CHANGED

@@ -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::NamespacesApi.new
@@ -61,7 +56,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -87,11 +82,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::NamespacesApi.new
@@ -120,7 +110,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/OrgsApi.md CHANGED

@@ -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::OrgsApi.new
@@ -61,7 +56,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -87,11 +82,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::OrgsApi.new
@@ -120,7 +110,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/Package.md CHANGED

@@ -35,10 +35,14 @@ Name | Type | Description | Notes
 **release** | **String** | The release of the package version (if any). | [optional]
 **repository** | **String** |  | [optional]
 **repository_url** | **String** |  | [optional]
+**security_scan_completed_at** | **String** | The datetime the security scanning was completed. | [optional]
+**security_scan_started_at** | **String** | The datetime the security scanning was started. | [optional]
+**security_scan_status** | **String** |  | [optional]
+**security_scan_status_updated_at** | **String** | The datetime the security scanning status was updated. | [optional]
 **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 +64,6 @@ Name | Type | Description | Notes
 **uploader_url** | **String** |  | [optional]
 **version** | **String** | The raw version for this package. | [optional]
 **version_orig** | **String** |  | [optional]
+**vulnerability_scan_results_url** | **String** |  | [optional]