cloudsmith-api 2.0.1 → 2.0.3

data/docs/RepositoryTokenRequestPatch.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **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] 
 **limit_num_downloads** | **Integer** | The maximum number of downloads allowed for the token. 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_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] 
+**limit_path_query** | **String** | THIS WILL SOON BE DEPRECATED, please use limit_package_query instead. 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** |  | [optional] 
 **name** | **String** |  | [optional] 
 **scheduled_reset_at** | **DateTime** | The time at which the scheduled reset period has elapsed and the token limits were automatically reset to zero. | [optional] 

data/docs/RepositoryWebhook.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **disable_reason** | **Integer** |  | [optional] 
 **disable_reason_str** | **String** |  | [optional] 
 **events** | **Array<String>** |  | 
-**identifier** | **Integer** |  | [optional] 
+**identifier** | **Integer** | Deprecated (23-05-15): Please use 'slug_perm' instead. Previously: A monotonically increasing number that identified a webhook request within a repository. | [optional] 
 **is_active** | **BOOLEAN** | If enabled, the webhook will trigger on subscribed events and send payloads to the configured target URL. | [optional] 
 **is_last_response_bad** | **BOOLEAN** |  | [optional] 
 **last_response_status** | **Integer** |  | [optional] 

data/docs/{RespositoryGeoIPEnableDisable.md → RespositoryGeoIpEnableDisable.md}

@@ -1,4 +1,4 @@
-# CloudsmithApi::RespositoryGeoIPEnableDisable
+# CloudsmithApi::RespositoryGeoIpEnableDisable
 
 ## Properties
 Name | Type | Description | Notes

data/docs/{RespositoryGeoIPEnableDisableRequest.md → RespositoryGeoIpEnableDisableRequest.md}

@@ -1,4 +1,4 @@
-# CloudsmithApi::RespositoryGeoIPEnableDisableRequest
+# CloudsmithApi::RespositoryGeoIpEnableDisableRequest
 
 ## Properties
 Name | Type | Description | Notes

data/docs/ServiceTeams.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **role** | **String** | The team role associated with the service | [optional] [default to 'Manager']
-**slug** | **String** | The teams associated with the service | [optional] 
+**slug** | **String** | The teams associated with the service | 
 
 

data/docs/StatusBasic.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **detail** | **String** | The message describing the state of the API. | [optional] [default to 'Cloudsmith API is operational.']
-**version** | **String** | The current version for the Cloudsmith service. | [optional] [default to '1.190.1']
+**version** | **String** | The current version for the Cloudsmith service. | [optional] [default to '1.263.0']
 
 

data/docs/StorageAllocatedLimit.md

@@ -0,0 +1,12 @@
+# CloudsmithApi::StorageAllocatedLimit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**configured** | **String** |  | [optional] 
+**peak** | **String** |  | [optional] 
+**percentage_used** | **String** |  | [optional] 
+**plan_limit** | **String** |  | [optional] 
+**used** | **String** |  | [optional] 
+
+

data/docs/StorageAllocatedLimitRaw.md

@@ -0,0 +1,12 @@
+# CloudsmithApi::StorageAllocatedLimitRaw
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**configured** | **Integer** |  | [optional] 
+**peak** | **Integer** |  | [optional] 
+**percentage_used** | **String** |  | [optional] 
+**plan_limit** | **Integer** |  | [optional] 
+**used** | **Integer** |  | [optional] 
+
+

data/docs/StorageUsage.md

@@ -0,0 +1,11 @@
+# CloudsmithApi::StorageUsage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **String** |  | [optional] 
+**peak** | **String** |  | [optional] 
+**percentage** | **String** |  | [optional] 
+**used** | **String** |  | [optional] 
+
+

data/docs/StorageUsageRaw.md

@@ -0,0 +1,11 @@
+# CloudsmithApi::StorageUsageRaw
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **Integer** |  | [optional] 
+**peak** | **Integer** |  | [optional] 
+**percentage** | **String** |  | [optional] 
+**used** | **Integer** |  | [optional] 
+
+

data/docs/UsageFieldset.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **display** | [**UsageLimits**](UsageLimits.md) |  | 
-**raw** | [**UsageLimits**](UsageLimits.md) |  | 
+**raw** | [**UsageLimitsRaw**](UsageLimitsRaw.md) |  | 
 
 

data/docs/UsageLimits.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bandwidth** | [**AllocatedLimit**](AllocatedLimit.md) |  | 
-**storage** | [**AllocatedLimit**](AllocatedLimit.md) |  | 
+**storage** | [**StorageAllocatedLimit**](StorageAllocatedLimit.md) |  | 
 
 

data/docs/UsageLimitsRaw.md

@@ -0,0 +1,9 @@
+# CloudsmithApi::UsageLimitsRaw
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bandwidth** | [**AllocatedLimitRaw**](AllocatedLimitRaw.md) |  | 
+**storage** | [**StorageAllocatedLimitRaw**](StorageAllocatedLimitRaw.md) |  | 
+
+

data/docs/UsageRaw.md

@@ -0,0 +1,10 @@
+# CloudsmithApi::UsageRaw
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **Integer** |  | [optional] 
+**percentage** | **String** |  | [optional] 
+**used** | **Integer** |  | [optional] 
+
+

data/docs/VulnerabilitiesApi.md

@@ -6,7 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**vulnerabilities_namespace_list**](VulnerabilitiesApi.md#vulnerabilities_namespace_list) | **GET** /vulnerabilities/{owner}/ | Lists scan results for a specific namespace.
 [**vulnerabilities_package_list**](VulnerabilitiesApi.md#vulnerabilities_package_list) | **GET** /vulnerabilities/{owner}/{repo}/{package}/ | Lists scan results for a specific package.
-[**vulnerabilities_read**](VulnerabilitiesApi.md#vulnerabilities_read) | **GET** /vulnerabilities/{owner}/{repo}/{package}/{scan_id}/ | Returns a Scan Result.
+[**vulnerabilities_read**](VulnerabilitiesApi.md#vulnerabilities_read) | **GET** /vulnerabilities/{owner}/{repo}/{package}/{identifier}/ | Get a scan result.
 [**vulnerabilities_repo_list**](VulnerabilitiesApi.md#vulnerabilities_repo_list) | **GET** /vulnerabilities/{owner}/{repo}/ | Lists scan results for a specific repository.
 
 
@@ -137,11 +137,11 @@ Name | Type | Description  | Notes
 
 
 # **vulnerabilities_read**
-> VulnerabilityScanResults vulnerabilities_read(owner, repo, package, scan_id)
+> VulnerabilityScanResults vulnerabilities_read(owner, repo, package, identifier)
 
-Returns a Scan Result.
+Get a scan result.
 
-Returns a Scan Result.
+Get a scan result.
 
 ### Example
 ```ruby
@@ -163,12 +163,12 @@ repo = 'repo_example' # String |
 
 package = 'package_example' # String | 
 
-scan_id = 'scan_id_example' # String | 
+identifier = 'identifier_example' # String | 
 
 
 begin
-  #Returns a Scan Result.
-  result = api_instance.vulnerabilities_read(owner, repo, package, scan_id)
+  #Get a scan result.
+  result = api_instance.vulnerabilities_read(owner, repo, package, identifier)
   p result
 rescue CloudsmithApi::ApiError => e
   puts "Exception when calling VulnerabilitiesApi->vulnerabilities_read: #{e}"
@@ -182,7 +182,7 @@ Name | Type | Description  | Notes
  **owner** | **String**|  | 
  **repo** | **String**|  | 
  **package** | **String**|  | 
- **scan_id** | **String**|  | 
+ **identifier** | **String**|  | 
 
 ### Return type
 

data/docs/VulnerabilityScanResults.md

@@ -10,6 +10,6 @@ Name | Type | Description | Notes
 **num_vulnerabilities** | **Integer** |  | [optional] 
 **package** | [**PackageVulnerability**](PackageVulnerability.md) |  | 
 **scan** | [**VulnerabilityScan**](VulnerabilityScan.md) |  | 
-**scan_id** | **Integer** |  | 
+**scan_id** | **Integer** | Deprecated (23-05-15): Please use 'identifier' instead. Previously: A monotonically increasing number that identified a scan within a repository. | 
 
 

data/docs/VulnerabilityScanResultsList.md

@@ -9,6 +9,6 @@ Name | Type | Description | Notes
 **max_severity** | **String** |  | [optional] [default to 'Unknown']
 **num_vulnerabilities** | **Integer** |  | [optional] 
 **package** | [**PackageVulnerability**](PackageVulnerability.md) |  | 
-**scan_id** | **Integer** |  | 
+**scan_id** | **Integer** | Deprecated (23-05-15): Please use 'identifier' instead. Previously: A monotonically increasing number that identified a scan within a repository. |