RubyGems - cloudsmith-api - Versions diffs - 0.52.92 → 0.53.79 - Mend

cloudsmith-api 0.52.92 → 0.53.79

Files changed (279) hide show

data/docs/Quota.md ADDED

@@ -0,0 +1,8 @@
+# CloudsmithApi::Quota
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usage** | **Object** |  |

data/docs/QuotaApi.md ADDED

@@ -0,0 +1,228 @@
+# CloudsmithApi::QuotaApi
+All URIs are relative to *https://api.cloudsmith.io*
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**quota_history_read**](QuotaApi.md#quota_history_read) | **GET** /quota/history/{owner}/ | Quota history for a given namespace.
+[**quota_oss_history_read**](QuotaApi.md#quota_oss_history_read) | **GET** /quota/oss/history/{owner}/ | Open-source Quota history for a given namespace.
+[**quota_oss_read**](QuotaApi.md#quota_oss_read) | **GET** /quota/oss/{owner}/ | Open-source Quota usage for a given namespace.
+[**quota_read**](QuotaApi.md#quota_read) | **GET** /quota/{owner}/ | Quota usage for a given namespace.
+# **quota_history_read**
+> QuotaHistory quota_history_read(owner)
+Quota history for a given namespace.
+Quota history for a given 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::QuotaApi.new
+owner = "owner_example" # String |
+begin
+  #Quota history for a given namespace.
+  result = api_instance.quota_history_read(owner)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling QuotaApi->quota_history_read: #{e}"
+end
+```
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  |
+### Return type
+[**QuotaHistory**](QuotaHistory.md)
+### Authorization
+[apikey](../README.md#apikey)
+### HTTP request headers
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+# **quota_oss_history_read**
+> QuotaHistory quota_oss_history_read(owner)
+Open-source Quota history for a given namespace.
+Open-source Quota history for a given 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::QuotaApi.new
+owner = "owner_example" # String |
+begin
+  #Open-source Quota history for a given namespace.
+  result = api_instance.quota_oss_history_read(owner)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling QuotaApi->quota_oss_history_read: #{e}"
+end
+```
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  |
+### Return type
+[**QuotaHistory**](QuotaHistory.md)
+### Authorization
+[apikey](../README.md#apikey)
+### HTTP request headers
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+# **quota_oss_read**
+> Quota quota_oss_read(owner)
+Open-source Quota usage for a given namespace.
+Open-source Quota usage for a given 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::QuotaApi.new
+owner = "owner_example" # String |
+begin
+  #Open-source Quota usage for a given namespace.
+  result = api_instance.quota_oss_read(owner)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling QuotaApi->quota_oss_read: #{e}"
+end
+```
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  |
+### Return type
+[**Quota**](Quota.md)
+### Authorization
+[apikey](../README.md#apikey)
+### HTTP request headers
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+# **quota_read**
+> Quota quota_read(owner)
+Quota usage for a given namespace.
+Quota usage for a given 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::QuotaApi.new
+owner = "owner_example" # String |
+begin
+  #Quota usage for a given namespace.
+  result = api_instance.quota_read(owner)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling QuotaApi->quota_read: #{e}"
+end
+```
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  |
+### Return type
+[**Quota**](Quota.md)
+### Authorization
+[apikey](../README.md#apikey)
+### HTTP request headers
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined

data/docs/QuotaHistory.md ADDED

@@ -0,0 +1,8 @@
+# CloudsmithApi::QuotaHistory
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**history** | [**Array&lt;QuotaHistoryHistory&gt;**](QuotaHistoryHistory.md) |  |

data/docs/QuotaHistoryHistory.md ADDED

@@ -0,0 +1,13 @@
+# CloudsmithApi::QuotaHistoryHistory
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**days** | **Integer** |  | [optional]
+**display** | **Object** |  | [optional]
+**_end** | **String** |  | [optional]
+**plan** | **String** |  | [optional]
+**raw** | **Object** |  | [optional]
+**start** | **String** |  | [optional]

data/docs/RatesApi.md CHANGED

@@ -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::RatesApi.new
@@ -51,7 +46,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

data/docs/RawPackageUpload.md CHANGED

@@ -38,7 +38,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]
@@ -59,5 +59,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/ReposApi.md CHANGED

@@ -29,11 +29,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::ReposApi.new
@@ -65,7 +60,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -91,11 +86,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::ReposApi.new
@@ -128,7 +118,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -154,11 +144,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::ReposApi.new
@@ -189,7 +174,7 @@ nil (empty response body)
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -215,11 +200,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::ReposApi.new
@@ -254,7 +234,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -280,11 +260,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::ReposApi.new
@@ -320,7 +295,7 @@ Name | Type | Description  | Notes
 ### Authorization
-[apikey](../README.md#apikey), [csrf_token](../README.md#csrf_token)
+[apikey](../README.md#apikey)
 ### HTTP request headers
@@ -346,11 +321,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::ReposApi.new
@@ -382,7 +352,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/RepositoryToken.md CHANGED

@@ -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** |  |
 **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]