docs/ReposApi.md in cloudsmith-api-2.0.1 vs docs/ReposApi.md in cloudsmith-api-2.0.2

- old
+ new

@@ -6,11 +6,14 @@ ------------- | ------------- | ------------- [**repos_create**](ReposApi.md#repos_create) | **POST** /repos/{owner}/ | Create a new repository in a given namespace. [**repos_delete**](ReposApi.md#repos_delete) | **DELETE** /repos/{owner}/{identifier}/ | Delete a repository in a given namespace. [**repos_geoip_disable**](ReposApi.md#repos_geoip_disable) | **POST** /repos/{owner}/{identifier}/geoip/disable/ | Disable GeoIP for this repository. [**repos_geoip_enable**](ReposApi.md#repos_geoip_enable) | **POST** /repos/{owner}/{identifier}/geoip/enable/ | Enable GeoIP for this repository. -[**repos_geoip_read**](ReposApi.md#repos_geoip_read) | **GET** /repos/{owner}/{identifier}/geoip | List all created GeoIP rules for the repository. +[**repos_geoip_partial_update**](ReposApi.md#repos_geoip_partial_update) | **PATCH** /repos/{owner}/{identifier}/geoip | Partially update repository geoip rules. +[**repos_geoip_read**](ReposApi.md#repos_geoip_read) | **GET** /repos/{owner}/{identifier}/geoip | List all repository geoip rules. +[**repos_geoip_test**](ReposApi.md#repos_geoip_test) | **POST** /repos/{owner}/{identifier}/geoip/test/ | Test a list of IP addresses against the repository's current GeoIP rules. +[**repos_geoip_update**](ReposApi.md#repos_geoip_update) | **PUT** /repos/{owner}/{identifier}/geoip | Replace repository geoip rules. [**repos_gpg_create**](ReposApi.md#repos_gpg_create) | **POST** /repos/{owner}/{identifier}/gpg/ | Set the active GPG key for the Repository. [**repos_gpg_list**](ReposApi.md#repos_gpg_list) | **GET** /repos/{owner}/{identifier}/gpg/ | Retrieve the active GPG key for the Repository. [**repos_gpg_regenerate**](ReposApi.md#repos_gpg_regenerate) | **POST** /repos/{owner}/{identifier}/gpg/regenerate/ | Regenerate GPG Key for the Repository. [**repos_namespace_list**](ReposApi.md#repos_namespace_list) | **GET** /repos/{owner}/ | Get a list of all repositories within a namespace. [**repos_partial_update**](ReposApi.md#repos_partial_update) | **PATCH** /repos/{owner}/{identifier}/ | Update details about a repository in a given namespace. @@ -162,11 +165,11 @@ owner = 'owner_example' # String | identifier = 'identifier_example' # String | opts = { - data: CloudsmithApi::RespositoryGeoIPEnableDisableRequest.new # RespositoryGeoIPEnableDisableRequest | + data: CloudsmithApi::RespositoryGeoIpEnableDisableRequest.new # RespositoryGeoIpEnableDisableRequest | } begin #Disable GeoIP for this repository. api_instance.repos_geoip_disable(owner, identifier, opts) @@ -179,11 +182,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| | **identifier** | **String**| | - **data** | [**RespositoryGeoIPEnableDisableRequest**](RespositoryGeoIPEnableDisableRequest.md)| | [optional] + **data** | [**RespositoryGeoIpEnableDisableRequest**](RespositoryGeoIpEnableDisableRequest.md)| | [optional] ### Return type nil (empty response body) @@ -222,11 +225,11 @@ owner = 'owner_example' # String | identifier = 'identifier_example' # String | opts = { - data: CloudsmithApi::RespositoryGeoIPEnableDisableRequest.new # RespositoryGeoIPEnableDisableRequest | + data: CloudsmithApi::RespositoryGeoIpEnableDisableRequest.new # RespositoryGeoIpEnableDisableRequest | } begin #Enable GeoIP for this repository. api_instance.repos_geoip_enable(owner, identifier, opts) @@ -239,11 +242,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| | **identifier** | **String**| | - **data** | [**RespositoryGeoIPEnableDisableRequest**](RespositoryGeoIPEnableDisableRequest.md)| | [optional] + **data** | [**RespositoryGeoIpEnableDisableRequest**](RespositoryGeoIpEnableDisableRequest.md)| | [optional] ### Return type nil (empty response body) @@ -256,16 +259,77 @@ - **Content-Type**: application/json - **Accept**: application/json +# **repos_geoip_partial_update** +> RepositoryGeoIpRules repos_geoip_partial_update(owner, identifier, opts) + +Partially update repository geoip rules. + +Partially update repository geoip rules. + +### 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::ReposApi.new + +owner = 'owner_example' # String | + +identifier = 'identifier_example' # String | + +opts = { + data: CloudsmithApi::RepositoryGeoIpRulesRequestPatch.new # RepositoryGeoIpRulesRequestPatch | +} + +begin + #Partially update repository geoip rules. + result = api_instance.repos_geoip_partial_update(owner, identifier, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling ReposApi->repos_geoip_partial_update: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **identifier** | **String**| | + **data** | [**RepositoryGeoIpRulesRequestPatch**](RepositoryGeoIpRulesRequestPatch.md)| | [optional] + +### Return type + +[**RepositoryGeoIpRules**](RepositoryGeoIpRules.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + # **repos_geoip_read** -> InlineResponse200 repos_geoip_read(owner, identifier) +> RepositoryGeoIpRules repos_geoip_read(owner, identifier) -List all created GeoIP rules for the repository. +List all repository geoip rules. -List all created GeoIP rules for the repository. +List all repository geoip rules. ### Example ```ruby # load the gem require 'cloudsmith-api' @@ -283,11 +347,11 @@ identifier = 'identifier_example' # String | begin - #List all created GeoIP rules for the repository. + #List all repository geoip rules. result = api_instance.repos_geoip_read(owner, identifier) p result rescue CloudsmithApi::ApiError => e puts "Exception when calling ReposApi->repos_geoip_read: #{e}" end @@ -300,10 +364,132 @@ **owner** | **String**| | **identifier** | **String**| | ### Return type -[**InlineResponse200**](InlineResponse200.md) +[**RepositoryGeoIpRules**](RepositoryGeoIpRules.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **repos_geoip_test** +> RepositoryGeoIpTestAddressResponse repos_geoip_test(owner, identifier, opts) + +Test a list of IP addresses against the repository's current GeoIP rules. + +Test a list of IP addresses against the repository's current GeoIP rules. + +### 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::ReposApi.new + +owner = 'owner_example' # String | + +identifier = 'identifier_example' # String | + +opts = { + data: CloudsmithApi::RepositoryGeoIpTestAddress.new # RepositoryGeoIpTestAddress | +} + +begin + #Test a list of IP addresses against the repository's current GeoIP rules. + result = api_instance.repos_geoip_test(owner, identifier, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling ReposApi->repos_geoip_test: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **identifier** | **String**| | + **data** | [**RepositoryGeoIpTestAddress**](RepositoryGeoIpTestAddress.md)| | [optional] + +### Return type + +[**RepositoryGeoIpTestAddressResponse**](RepositoryGeoIpTestAddressResponse.md) + +### Authorization + +[apikey](../README.md#apikey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **repos_geoip_update** +> RepositoryGeoIpRules repos_geoip_update(owner, identifier, opts) + +Replace repository geoip rules. + +Replace repository geoip rules. + +### 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::ReposApi.new + +owner = 'owner_example' # String | + +identifier = 'identifier_example' # String | + +opts = { + data: CloudsmithApi::RepositoryGeoIpRulesRequest.new # RepositoryGeoIpRulesRequest | +} + +begin + #Replace repository geoip rules. + result = api_instance.repos_geoip_update(owner, identifier, opts) + p result +rescue CloudsmithApi::ApiError => e + puts "Exception when calling ReposApi->repos_geoip_update: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| | + **identifier** | **String**| | + **data** | [**RepositoryGeoIpRulesRequest**](RepositoryGeoIpRulesRequest.md)| | [optional] + +### Return type + +[**RepositoryGeoIpRules**](RepositoryGeoIpRules.md) ### Authorization [apikey](../README.md#apikey)