cloudsmith-api 2.0.26 → 2.0.27

data/docs/OrgsApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.cloudsmith.io*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**orgs_custom_domains_list**](OrgsApi.md#orgs_custom_domains_list) | **GET** /orgs/{org}/custom-domains/ | Get the details for all custom domains.
 [**orgs_delete**](OrgsApi.md#orgs_delete) | **DELETE** /orgs/{org}/ | Delete the specified organization.
 [**orgs_deny_policy_create**](OrgsApi.md#orgs_deny_policy_create) | **POST** /orgs/{org}/deny-policy/ | Create a package deny policy.
 [**orgs_deny_policy_delete**](OrgsApi.md#orgs_deny_policy_delete) | **DELETE** /orgs/{org}/deny-policy/{slug_perm}/ | Delete a package deny policy.
@@ -79,6 +80,70 @@ Method | HTTP request | Description
 [**orgs_vulnerability_policy_violation_list**](OrgsApi.md#orgs_vulnerability_policy_violation_list) | **GET** /orgs/{org}/vulnerability-policy-violation/ | List all current vulnerability policy violations for this Organization.
 
 
+# **orgs_custom_domains_list**
+> Array<OrganizationCustomDomains> orgs_custom_domains_list(org, opts)
+
+Get the details for all custom domains.
+
+Get the details for all custom domains.
+
+### 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::OrgsApi.new
+
+org = 'org_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
+  #Get the details for all custom domains.
+  result = api_instance.orgs_custom_domains_list(org, opts)
+  p result
+rescue CloudsmithApi::ApiError => e
+  puts "Exception when calling OrgsApi->orgs_custom_domains_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **org** | **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<OrganizationCustomDomains>**](OrganizationCustomDomains.md)
+
+### Authorization
+
+[apikey](../README.md#apikey), [basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **orgs_delete**
 > orgs_delete(org)
 

data/docs/P2PackageUpload.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/Package.md

@@ -32,6 +32,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] 
@@ -49,6 +50,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/PackageCopy.md

@@ -32,6 +32,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] 
@@ -49,6 +50,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/PackageMove.md

@@ -32,6 +32,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] 
@@ -49,6 +50,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/PackageQuarantine.md

@@ -32,6 +32,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] 
@@ -49,6 +50,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/PackageResync.md

@@ -32,6 +32,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] 
@@ -49,6 +50,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/PackageStatus.md

@@ -7,6 +7,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] 

data/docs/PackageTag.md

@@ -32,6 +32,7 @@ Name | Type | Description | Notes
 **is_copyable** | **BOOLEAN** |  | [optional] 
 **is_deleteable** | **BOOLEAN** |  | [optional] 
 **is_downloadable** | **BOOLEAN** |  | [optional] 
+**is_hidden** | **BOOLEAN** |  | [optional] 
 **is_immutable** | **BOOLEAN** | If true, created tags will be immutable. An immutable flag is a tag that cannot be removed from a package. | [optional] [default to false]
 **is_moveable** | **BOOLEAN** |  | [optional] 
 **is_quarantinable** | **BOOLEAN** |  | [optional] 
@@ -50,6 +51,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/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

@@ -4,16 +4,16 @@ 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_recycle_bin_action**](RecycleBinApi.md#recycle_bin_recycle_bin_action) | **POST** /recycle-bin/{owner}/action/ | 
 
 
-# **recycle_bin_list**
-> Array<RecycleBinPackage> recycle_bin_list(owner, opts)
+# **recycle_bin_action**
+> PackageBulkActionResponse recycle_bin_action(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.
+
+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
@@ -36,17 +36,14 @@ 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
+  data: CloudsmithApi::PackageRecycleBin.new # PackageRecycleBin | 
 }
 
 begin
-  #List soft-deleted packages in recycle bin
-  result = api_instance.recycle_bin_list(owner, opts)
+  result = api_instance.recycle_bin_action(owner, opts)
   p result
 rescue CloudsmithApi::ApiError => e
-  puts "Exception when calling RecycleBinApi->recycle_bin_list: #{e}"
+  puts "Exception when calling RecycleBinApi->recycle_bin_action: #{e}"
 end
 ```
 
@@ -55,13 +52,11 @@ end
 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] 
+ **data** | [**PackageRecycleBin**](PackageRecycleBin.md)|  | [optional] 
 
 ### Return type
 
-[**Array<RecycleBinPackage>**](RecycleBinPackage.md)
+[**PackageBulkActionResponse**](PackageBulkActionResponse.md)
 
 ### Authorization
 
@@ -74,12 +69,12 @@ Name | Type | Description  | Notes
 
 
 
-# **recycle_bin_recycle_bin_action**
-> PackageBulkActionResponse recycle_bin_recycle_bin_action(owner, opts)
-
+# **recycle_bin_list**
+> Array<RecycleBinPackage> recycle_bin_list(owner, opts)
 
+List soft-deleted packages in recycle bin
 
-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. 
+Retrieve all soft-deleted packages in the workspace. Optionally filter by repository using the 'repository' query parameter.
 
 ### Example
 ```ruby
@@ -102,14 +97,17 @@ api_instance = CloudsmithApi::RecycleBinApi.new
 owner = 'owner_example' # String | 
 
 opts = { 
-  data: CloudsmithApi::PackageRecycleBin.new # PackageRecycleBin | 
+  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
-  result = api_instance.recycle_bin_recycle_bin_action(owner, opts)
+  #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_recycle_bin_action: #{e}"
+  puts "Exception when calling RecycleBinApi->recycle_bin_list: #{e}"
 end
 ```
 
@@ -118,11 +116,13 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **owner** | **String**|  | 
- **data** | [**PackageRecycleBin**](PackageRecycleBin.md)|  | [optional] 
+ **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
 
-[**PackageBulkActionResponse**](PackageBulkActionResponse.md)
+[**Array<RecycleBinPackage>**](RecycleBinPackage.md)
 
 ### Authorization