docs/OrgsApi.md in cloudsmith-api-2.0.6 vs docs/OrgsApi.md in cloudsmith-api-2.0.7
- old
+ new
@@ -10,10 +10,13 @@
[**orgs_invites_list**](OrgsApi.md#orgs_invites_list) | **GET** /orgs/{org}/invites/ | Get a list of all invites for an organization.
[**orgs_invites_partial_update**](OrgsApi.md#orgs_invites_partial_update) | **PATCH** /orgs/{org}/invites/{slug_perm}/ | Update a specific organization invite.
[**orgs_invites_resend**](OrgsApi.md#orgs_invites_resend) | **POST** /orgs/{org}/invites/{slug_perm}/resend/ | Resend an organization invite.
[**orgs_license_policy_create**](OrgsApi.md#orgs_license_policy_create) | **POST** /orgs/{org}/license-policy/ | Create a package license policy.
[**orgs_license_policy_delete**](OrgsApi.md#orgs_license_policy_delete) | **DELETE** /orgs/{org}/license-policy/{slug_perm}/ | Delete a package license policy.
+[**orgs_license_policy_evaluation_create**](OrgsApi.md#orgs_license_policy_evaluation_create) | **POST** /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/ | Create an evaluation request for this policy.
+[**orgs_license_policy_evaluation_list**](OrgsApi.md#orgs_license_policy_evaluation_list) | **GET** /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/ | List evaluation requests for this policy.
+[**orgs_license_policy_evaluation_read**](OrgsApi.md#orgs_license_policy_evaluation_read) | **GET** /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/{slug_perm}/ | Retrieve an evaluation request for this policy.
[**orgs_license_policy_list**](OrgsApi.md#orgs_license_policy_list) | **GET** /orgs/{org}/license-policy/ | Get a list of all package license policies.
[**orgs_license_policy_partial_update**](OrgsApi.md#orgs_license_policy_partial_update) | **PATCH** /orgs/{org}/license-policy/{slug_perm}/ | Partially update a package license policy.
[**orgs_license_policy_read**](OrgsApi.md#orgs_license_policy_read) | **GET** /orgs/{org}/license-policy/{slug_perm}/ | Get a package license policy.
[**orgs_license_policy_update**](OrgsApi.md#orgs_license_policy_update) | **PUT** /orgs/{org}/license-policy/{slug_perm}/ | Update a package license policy.
[**orgs_license_policy_violation_list**](OrgsApi.md#orgs_license_policy_violation_list) | **GET** /orgs/{org}/license-policy-violation/ | List all current license policy violations for this Organization.
@@ -41,10 +44,13 @@
[**orgs_teams_members_update**](OrgsApi.md#orgs_teams_members_update) | **PUT** /orgs/{org}/teams/{team}/members | Replace all team members.
[**orgs_teams_partial_update**](OrgsApi.md#orgs_teams_partial_update) | **PATCH** /orgs/{org}/teams/{team}/ | Update a specific team in a organization.
[**orgs_teams_read**](OrgsApi.md#orgs_teams_read) | **GET** /orgs/{org}/teams/{team}/ | Get the details of a specific team within an organization.
[**orgs_vulnerability_policy_create**](OrgsApi.md#orgs_vulnerability_policy_create) | **POST** /orgs/{org}/vulnerability-policy/ | Create a package vulnerability policy.
[**orgs_vulnerability_policy_delete**](OrgsApi.md#orgs_vulnerability_policy_delete) | **DELETE** /orgs/{org}/vulnerability-policy/{slug_perm}/ | Delete a package vulnerability policy.
+[**orgs_vulnerability_policy_evaluation_create**](OrgsApi.md#orgs_vulnerability_policy_evaluation_create) | **POST** /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/ | Create an evaluation request for this policy.
+[**orgs_vulnerability_policy_evaluation_list**](OrgsApi.md#orgs_vulnerability_policy_evaluation_list) | **GET** /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/ | List evaluation requests for this policy.
+[**orgs_vulnerability_policy_evaluation_read**](OrgsApi.md#orgs_vulnerability_policy_evaluation_read) | **GET** /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/{slug_perm}/ | Retrieve an evaluation request for this policy.
[**orgs_vulnerability_policy_list**](OrgsApi.md#orgs_vulnerability_policy_list) | **GET** /orgs/{org}/vulnerability-policy/ | Get a list of all package vulnerability policies.
[**orgs_vulnerability_policy_partial_update**](OrgsApi.md#orgs_vulnerability_policy_partial_update) | **PATCH** /orgs/{org}/vulnerability-policy/{slug_perm}/ | Partially update a package vulnerability policy.
[**orgs_vulnerability_policy_read**](OrgsApi.md#orgs_vulnerability_policy_read) | **GET** /orgs/{org}/vulnerability-policy/{slug_perm}/ | Get a package vulnerability policy.
[**orgs_vulnerability_policy_update**](OrgsApi.md#orgs_vulnerability_policy_update) | **PUT** /orgs/{org}/vulnerability-policy/{slug_perm}/ | Update a package vulnerability policy.
[**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.
@@ -511,10 +517,194 @@
- **Content-Type**: application/json
- **Accept**: application/json
+# **orgs_license_policy_evaluation_create**
+> PackageLicensePolicyEvaluationRequest orgs_license_policy_evaluation_create(org, policy_slug_perm, opts)
+
+Create an evaluation request for this policy.
+
+Create an evaluation request for this policy.
+
+### 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::OrgsApi.new
+
+org = 'org_example' # String |
+
+policy_slug_perm = 'policy_slug_perm_example' # String |
+
+opts = {
+ data: CloudsmithApi::PackageLicensePolicyEvaluationRequestRequest.new # PackageLicensePolicyEvaluationRequestRequest |
+}
+
+begin
+ #Create an evaluation request for this policy.
+ result = api_instance.orgs_license_policy_evaluation_create(org, policy_slug_perm, opts)
+ p result
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling OrgsApi->orgs_license_policy_evaluation_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **org** | **String**| |
+ **policy_slug_perm** | **String**| |
+ **data** | [**PackageLicensePolicyEvaluationRequestRequest**](PackageLicensePolicyEvaluationRequestRequest.md)| | [optional]
+
+### Return type
+
+[**PackageLicensePolicyEvaluationRequest**](PackageLicensePolicyEvaluationRequest.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **orgs_license_policy_evaluation_list**
+> Array<PackageLicensePolicyEvaluationRequest> orgs_license_policy_evaluation_list(org, policy_slug_perm, opts)
+
+List evaluation requests for this policy.
+
+List evaluation requests for this policy.
+
+### 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::OrgsApi.new
+
+org = 'org_example' # String |
+
+policy_slug_perm = 'policy_slug_perm_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
+ #List evaluation requests for this policy.
+ result = api_instance.orgs_license_policy_evaluation_list(org, policy_slug_perm, opts)
+ p result
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling OrgsApi->orgs_license_policy_evaluation_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **org** | **String**| |
+ **policy_slug_perm** | **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<PackageLicensePolicyEvaluationRequest>**](PackageLicensePolicyEvaluationRequest.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **orgs_license_policy_evaluation_read**
+> PackageLicensePolicyEvaluationRequest orgs_license_policy_evaluation_read(org, policy_slug_perm, slug_perm)
+
+Retrieve an evaluation request for this policy.
+
+Retrieve an evaluation request for this policy.
+
+### 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::OrgsApi.new
+
+org = 'org_example' # String |
+
+policy_slug_perm = 'policy_slug_perm_example' # String |
+
+slug_perm = 'slug_perm_example' # String |
+
+
+begin
+ #Retrieve an evaluation request for this policy.
+ result = api_instance.orgs_license_policy_evaluation_read(org, policy_slug_perm, slug_perm)
+ p result
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling OrgsApi->orgs_license_policy_evaluation_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **org** | **String**| |
+ **policy_slug_perm** | **String**| |
+ **slug_perm** | **String**| |
+
+### Return type
+
+[**PackageLicensePolicyEvaluationRequest**](PackageLicensePolicyEvaluationRequest.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
# **orgs_license_policy_list**
> Array<OrganizationPackageLicensePolicy> orgs_license_policy_list(org, opts)
Get a list of all package license policies.
@@ -2298,9 +2488,193 @@
**slug_perm** | **String**| |
### Return type
nil (empty response body)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **orgs_vulnerability_policy_evaluation_create**
+> PackageVulnerabilityPolicyEvaluationRequest orgs_vulnerability_policy_evaluation_create(org, policy_slug_perm, opts)
+
+Create an evaluation request for this policy.
+
+Create an evaluation request for this policy.
+
+### 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::OrgsApi.new
+
+org = 'org_example' # String |
+
+policy_slug_perm = 'policy_slug_perm_example' # String |
+
+opts = {
+ data: CloudsmithApi::PackageVulnerabilityPolicyEvaluationRequestRequest.new # PackageVulnerabilityPolicyEvaluationRequestRequest |
+}
+
+begin
+ #Create an evaluation request for this policy.
+ result = api_instance.orgs_vulnerability_policy_evaluation_create(org, policy_slug_perm, opts)
+ p result
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling OrgsApi->orgs_vulnerability_policy_evaluation_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **org** | **String**| |
+ **policy_slug_perm** | **String**| |
+ **data** | [**PackageVulnerabilityPolicyEvaluationRequestRequest**](PackageVulnerabilityPolicyEvaluationRequestRequest.md)| | [optional]
+
+### Return type
+
+[**PackageVulnerabilityPolicyEvaluationRequest**](PackageVulnerabilityPolicyEvaluationRequest.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **orgs_vulnerability_policy_evaluation_list**
+> Array<PackageVulnerabilityPolicyEvaluationRequest> orgs_vulnerability_policy_evaluation_list(org, policy_slug_perm, opts)
+
+List evaluation requests for this policy.
+
+List evaluation requests for this policy.
+
+### 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::OrgsApi.new
+
+org = 'org_example' # String |
+
+policy_slug_perm = 'policy_slug_perm_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
+ #List evaluation requests for this policy.
+ result = api_instance.orgs_vulnerability_policy_evaluation_list(org, policy_slug_perm, opts)
+ p result
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling OrgsApi->orgs_vulnerability_policy_evaluation_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **org** | **String**| |
+ **policy_slug_perm** | **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<PackageVulnerabilityPolicyEvaluationRequest>**](PackageVulnerabilityPolicyEvaluationRequest.md)
+
+### Authorization
+
+[apikey](../README.md#apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **orgs_vulnerability_policy_evaluation_read**
+> PackageVulnerabilityPolicyEvaluationRequest orgs_vulnerability_policy_evaluation_read(org, policy_slug_perm, slug_perm)
+
+Retrieve an evaluation request for this policy.
+
+Retrieve an evaluation request for this policy.
+
+### 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::OrgsApi.new
+
+org = 'org_example' # String |
+
+policy_slug_perm = 'policy_slug_perm_example' # String |
+
+slug_perm = 'slug_perm_example' # String |
+
+
+begin
+ #Retrieve an evaluation request for this policy.
+ result = api_instance.orgs_vulnerability_policy_evaluation_read(org, policy_slug_perm, slug_perm)
+ p result
+rescue CloudsmithApi::ApiError => e
+ puts "Exception when calling OrgsApi->orgs_vulnerability_policy_evaluation_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **org** | **String**| |
+ **policy_slug_perm** | **String**| |
+ **slug_perm** | **String**| |
+
+### Return type
+
+[**PackageVulnerabilityPolicyEvaluationRequest**](PackageVulnerabilityPolicyEvaluationRequest.md)
### Authorization
[apikey](../README.md#apikey)