cloudsmith-api 2.0.25 → 2.0.27

data/docs/PythonPackageUpload.md

@@ -31,6 +31,7 @@ Name | Type | Description | Notes
 **is_copyable** | **BOOLEAN** |  | [optional] 
 **is_deleteable** | **BOOLEAN** |  | [optional] 
 **is_downloadable** | **BOOLEAN** |  | [optional] 
+**is_hidden** | **BOOLEAN** |  | [optional] 
 **is_moveable** | **BOOLEAN** |  | [optional] 
 **is_quarantinable** | **BOOLEAN** |  | [optional] 
 **is_quarantined** | **BOOLEAN** |  | [optional] 
@@ -48,6 +49,7 @@ Name | Type | Description | Notes
 **num_files** | **Integer** |  | [optional] 
 **origin_repository** | **String** |  | [optional] 
 **origin_repository_url** | **String** |  | [optional] 
+**osi_approved** | **BOOLEAN** | Whether the package's SPDX license is OSI-approved. | [optional] 
 **package_type** | **Integer** | The type of package contents. | [optional] 
 **policy_violated** | **BOOLEAN** | Whether or not the package has violated any policy. | [optional] 
 **raw_license** | **String** | The raw license string. | [optional] 

data/docs/RawPackageUpload.md

@@ -31,6 +31,7 @@ Name | Type | Description | Notes
 **is_copyable** | **BOOLEAN** |  | [optional] 
 **is_deleteable** | **BOOLEAN** |  | [optional] 
 **is_downloadable** | **BOOLEAN** |  | [optional] 
+**is_hidden** | **BOOLEAN** |  | [optional] 
 **is_moveable** | **BOOLEAN** |  | [optional] 
 **is_quarantinable** | **BOOLEAN** |  | [optional] 
 **is_quarantined** | **BOOLEAN** |  | [optional] 
@@ -48,6 +49,7 @@ Name | Type | Description | Notes
 **num_files** | **Integer** |  | [optional] 
 **origin_repository** | **String** |  | [optional] 
 **origin_repository_url** | **String** |  | [optional] 
+**osi_approved** | **BOOLEAN** | Whether the package's SPDX license is OSI-approved. | [optional] 
 **package_type** | **Integer** | The type of package contents. | [optional] 
 **policy_violated** | **BOOLEAN** | Whether or not the package has violated any policy. | [optional] 
 **raw_license** | **String** | The raw license string. | [optional] 

data/docs/RecycleBinApi.md

@@ -0,0 +1,137 @@
+# CloudsmithApi::RecycleBinApi
+
+All URIs are relative to *https://api.cloudsmith.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**recycle_bin_action**](RecycleBinApi.md#recycle_bin_action) | **POST** /recycle-bin/{owner}/action/ | 
+[**recycle_bin_list**](RecycleBinApi.md#recycle_bin_list) | **GET** /recycle-bin/{owner}/ | List soft-deleted packages in recycle bin
+
+
+# **recycle_bin_action**
+> PackageBulkActionResponse recycle_bin_action(owner, opts)
+
+
+
+Perform actions on soft-deleted packages in the recycle bin. Supported actions: permanently delete (hard delete), restore. Returns a list of successfully actioned packages and any packages that failed with error details. 
+
+### 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'
+
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CloudsmithApi::RecycleBinApi.new
+
+owner = 'owner_example' # String | 
+
+opts = { 
+  data: CloudsmithApi::PackageRecycleBin.new # PackageRecycleBin | 
+}
+
+begin
+  result = api_instance.recycle_bin_action(owner, opts)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling RecycleBinApi->recycle_bin_action: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **owner** | **String**|  | 
+ **data** | [**PackageRecycleBin**](PackageRecycleBin.md)|  | [optional] 
+
+### Return type
+
+[**PackageBulkActionResponse**](PackageBulkActionResponse.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **recycle_bin_list**
+> Array<RecycleBinPackage> recycle_bin_list(owner, opts)
+
+List soft-deleted packages in recycle bin
+
+Retrieve all soft-deleted packages in the workspace. Optionally filter by repository using the 'repository' query parameter.
+
+### 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'
+
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = CloudsmithApi::RecycleBinApi.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.
+  repository: 'repository_example' # String | Filter packages by repository slug
+}
+
+begin
+  #List soft-deleted packages in recycle bin
+  result = api_instance.recycle_bin_list(owner, opts)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling RecycleBinApi->recycle_bin_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] 
+ **repository** | **String**| Filter packages by repository slug | [optional] 
+
+### Return type
+
+[**Array<RecycleBinPackage>**](RecycleBinPackage.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/RecycleBinPackage.md

@@ -0,0 +1,31 @@
+# CloudsmithApi::RecycleBinPackage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_by** | **String** | The name of the user who deleted the package. | [optional] 
+**downloads** | **Integer** |  | [optional] 
+**filename** | **String** |  | [optional] 
+**format** | **String** |  | [optional] 
+**fully_qualified_name** | **String** | The fully qualified name of the package. | [optional] 
+**identifiers** | **Hash<String, String>** |  | [optional] 
+**invoked_retention_rule** | **Hash<String, String>** | Information about the retention rule that triggered deletion (if any). | [optional] 
+**is_deleteable** | **BOOLEAN** |  | [optional] 
+**is_quarantined** | **BOOLEAN** |  | [optional] 
+**is_restorable** | **BOOLEAN** |  | [optional] 
+**name** | **String** | The name of this package. | [optional] 
+**policy_violated** | **BOOLEAN** | Whether or not the package has violated any policy. | [optional] 
+**repository** | **String** |  | [optional] 
+**security_scan_completed_at** | **DateTime** | The datetime the security scanning was completed. | [optional] 
+**security_scan_status** | **String** |  | [optional] [default to 'Awaiting Security Scan']
+**size** | **Integer** | The calculated size of the package. | [optional] 
+**slug_perm** | **String** |  | [optional] 
+**status** | **Integer** | The synchronisation status of the package. | [optional] 
+**status_updated_at** | **DateTime** | The datetime the package status was updated at. | [optional] 
+**tags** | [**Tags**](Tags.md) |  | [optional] 
+**type_display** | **String** |  | [optional] 
+**uploaded_at** | **DateTime** | The date this package was uploaded. | [optional] 
+**uploader** | **String** |  | [optional] 
+**version** | **String** | The raw version for this package. | [optional] 
+
+