pulp_python_client 3.11.4 → 3.12.0

data/docs/PublicationsPypiApi.md

@@ -1,16 +1,75 @@
 # PulpPythonClient::PublicationsPypiApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](PublicationsPypiApi.md#add_role) | **POST** {python_python_publication_href}add_role/ | Add a role
 [**create**](PublicationsPypiApi.md#create) | **POST** /pulp/api/v3/publications/python/pypi/ | Create a python publication
 [**delete**](PublicationsPypiApi.md#delete) | **DELETE** {python_python_publication_href} | Delete a python publication
 [**list**](PublicationsPypiApi.md#list) | **GET** /pulp/api/v3/publications/python/pypi/ | List python publications
+[**list_roles**](PublicationsPypiApi.md#list_roles) | **GET** {python_python_publication_href}list_roles/ | List roles
+[**my_permissions**](PublicationsPypiApi.md#my_permissions) | **GET** {python_python_publication_href}my_permissions/ | List user permissions
 [**read**](PublicationsPypiApi.md#read) | **GET** {python_python_publication_href} | Inspect a python publication
+[**remove_role**](PublicationsPypiApi.md#remove_role) | **POST** {python_python_publication_href}remove_role/ | Remove a role
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(python_python_publication_href, nested_role)
+
+Add a role
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::PublicationsPypiApi.new
+python_python_publication_href = 'python_python_publication_href_example' # String | 
+nested_role = PulpPythonClient::NestedRole.new # NestedRole | 
+
+begin
+  #Add a role
+  result = api_instance.add_role(python_python_publication_href, nested_role)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PublicationsPypiApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_publication_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
 > AsyncOperationResponse create(python_python_publication)
@@ -205,6 +264,124 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(python_python_publication_href, opts)
+
+List roles
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::PublicationsPypiApi.new
+python_python_publication_href = 'python_python_publication_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List roles
+  result = api_instance.list_roles(python_python_publication_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PublicationsPypiApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_publication_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(python_python_publication_href, opts)
+
+List user permissions
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::PublicationsPypiApi.new
+python_python_publication_href = 'python_python_publication_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List user permissions
+  result = api_instance.my_permissions(python_python_publication_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PublicationsPypiApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_publication_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## read
 
 > PythonPythonPublicationResponse read(python_python_publication_href, opts)
@@ -263,3 +440,58 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## remove_role
+
+> NestedRoleResponse remove_role(python_python_publication_href, nested_role)
+
+Remove a role
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::PublicationsPypiApi.new
+python_python_publication_href = 'python_python_publication_href_example' # String | 
+nested_role = PulpPythonClient::NestedRole.new # NestedRole | 
+
+begin
+  #Remove a role
+  result = api_instance.remove_role(python_python_publication_href, nested_role)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PublicationsPypiApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_publication_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/PypiApi.md

@@ -1,6 +1,6 @@
 # PulpPythonClient::PypiApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -21,6 +21,12 @@ Gets package summary stats of index.
 ```ruby
 # load the gem
 require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpPythonClient::PypiApi.new
 path = 'path_example' # String | 
@@ -53,7 +59,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PypiLegacyApi.md

@@ -1,6 +1,6 @@
 # PulpPythonClient::PypiLegacyApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PypiMetadataApi.md

@@ -1,6 +1,6 @@
 # PulpPythonClient::PypiMetadataApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -21,6 +21,12 @@ Retrieves the package's core-metadata specified by https://packaging.python.org/
 ```ruby
 # load the gem
 require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpPythonClient::PypiMetadataApi.new
 meta = 'meta_example' # String | 
@@ -55,7 +61,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PypiSimpleApi.md

@@ -1,6 +1,6 @@
 # PulpPythonClient::PypiSimpleApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PythonPythonPackageContent.md

@@ -23,14 +23,14 @@ Name | Type | Description | Notes
 **license** | **String** | Text indicating the license covering the distribution | [optional] 
 **requires_python** | **String** | The Python version(s) that the distribution is guaranteed to be compatible with. | [optional] 
 **project_url** | **String** | A browsable URL for the project and a label for it, separated by a comma. | [optional] 
-**project_urls** | [**Object**](.md) | A dictionary of labels and URLs for the project. | [optional] 
+**project_urls** | [**AnyType**](.md) | A dictionary of labels and URLs for the project. | [optional] 
 **platform** | **String** | A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional] 
 **supported_platform** | **String** | Field to specify the OS and CPU for which the binary package was compiled.  | [optional] 
-**requires_dist** | [**Object**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional] 
-**provides_dist** | [**Object**](.md) | A JSON list containing names of a Distutils project which is contained within this distribution. | [optional] 
-**obsoletes_dist** | [**Object**](.md) | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional] 
-**requires_external** | [**Object**](.md) | A JSON list containing some dependency in the system that the distribution is to be used. | [optional] 
-**classifiers** | [**Object**](.md) | A JSON list containing classification values for a Python package. | [optional] 
+**requires_dist** | [**AnyType**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional] 
+**provides_dist** | [**AnyType**](.md) | A JSON list containing names of a Distutils project which is contained within this distribution. | [optional] 
+**obsoletes_dist** | [**AnyType**](.md) | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional] 
+**requires_external** | [**AnyType**](.md) | A JSON list containing some dependency in the system that the distribution is to be used. | [optional] 
+**classifiers** | [**AnyType**](.md) | A JSON list containing classification values for a Python package. | [optional] 
 
 ## Code Sample
 

data/docs/PythonPythonPackageContentResponse.md

@@ -27,14 +27,14 @@ Name | Type | Description | Notes
 **license** | **String** | Text indicating the license covering the distribution | [optional] 
 **requires_python** | **String** | The Python version(s) that the distribution is guaranteed to be compatible with. | [optional] 
 **project_url** | **String** | A browsable URL for the project and a label for it, separated by a comma. | [optional] 
-**project_urls** | [**Object**](.md) | A dictionary of labels and URLs for the project. | [optional] 
+**project_urls** | [**AnyType**](.md) | A dictionary of labels and URLs for the project. | [optional] 
 **platform** | **String** | A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional] 
 **supported_platform** | **String** | Field to specify the OS and CPU for which the binary package was compiled.  | [optional] 
-**requires_dist** | [**Object**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional] 
-**provides_dist** | [**Object**](.md) | A JSON list containing names of a Distutils project which is contained within this distribution. | [optional] 
-**obsoletes_dist** | [**Object**](.md) | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional] 
-**requires_external** | [**Object**](.md) | A JSON list containing some dependency in the system that the distribution is to be used. | [optional] 
-**classifiers** | [**Object**](.md) | A JSON list containing classification values for a Python package. | [optional] 
+**requires_dist** | [**AnyType**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional] 
+**provides_dist** | [**AnyType**](.md) | A JSON list containing names of a Distutils project which is contained within this distribution. | [optional] 
+**obsoletes_dist** | [**AnyType**](.md) | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional] 
+**requires_external** | [**AnyType**](.md) | A JSON list containing some dependency in the system that the distribution is to be used. | [optional] 
+**classifiers** | [**AnyType**](.md) | A JSON list containing classification values for a Python package. | [optional] 
 
 ## Code Sample
 

data/docs/RemotesPythonApi.md

@@ -1,21 +1,80 @@
 # PulpPythonClient::RemotesPythonApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](RemotesPythonApi.md#add_role) | **POST** {python_python_remote_href}add_role/ | Add a role
 [**create**](RemotesPythonApi.md#create) | **POST** /pulp/api/v3/remotes/python/python/ | Create a python remote
 [**delete**](RemotesPythonApi.md#delete) | **DELETE** {python_python_remote_href} | Delete a python remote
 [**from_bandersnatch**](RemotesPythonApi.md#from_bandersnatch) | **POST** /pulp/api/v3/remotes/python/python/from_bandersnatch/ | Create from Bandersnatch
 [**list**](RemotesPythonApi.md#list) | **GET** /pulp/api/v3/remotes/python/python/ | List python remotes
+[**list_roles**](RemotesPythonApi.md#list_roles) | **GET** {python_python_remote_href}list_roles/ | List roles
+[**my_permissions**](RemotesPythonApi.md#my_permissions) | **GET** {python_python_remote_href}my_permissions/ | List user permissions
 [**partial_update**](RemotesPythonApi.md#partial_update) | **PATCH** {python_python_remote_href} | Update a python remote
 [**read**](RemotesPythonApi.md#read) | **GET** {python_python_remote_href} | Inspect a python remote
+[**remove_role**](RemotesPythonApi.md#remove_role) | **POST** {python_python_remote_href}remove_role/ | Remove a role
 [**set_label**](RemotesPythonApi.md#set_label) | **POST** {python_python_remote_href}set_label/ | Set a label
 [**unset_label**](RemotesPythonApi.md#unset_label) | **POST** {python_python_remote_href}unset_label/ | Unset a label
 [**update**](RemotesPythonApi.md#update) | **PUT** {python_python_remote_href} | Update a python remote
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(python_python_remote_href, nested_role)
+
+Add a role
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RemotesPythonApi.new
+python_python_remote_href = 'python_python_remote_href_example' # String | 
+nested_role = PulpPythonClient::NestedRole.new # NestedRole | 
+
+begin
+  #Add a role
+  result = api_instance.add_role(python_python_remote_href, nested_role)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_remote_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
 > PythonPythonRemoteResponse create(python_python_remote)
@@ -282,6 +341,124 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(python_python_remote_href, opts)
+
+List roles
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RemotesPythonApi.new
+python_python_remote_href = 'python_python_remote_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List roles
+  result = api_instance.list_roles(python_python_remote_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_remote_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(python_python_remote_href, opts)
+
+List user permissions
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RemotesPythonApi.new
+python_python_remote_href = 'python_python_remote_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List user permissions
+  result = api_instance.my_permissions(python_python_remote_href, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_remote_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## partial_update
 
 > AsyncOperationResponse partial_update(python_python_remote_href, patchedpython_python_remote)
@@ -396,6 +573,61 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(python_python_remote_href, nested_role)
+
+Remove a role
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::RemotesPythonApi.new
+python_python_remote_href = 'python_python_remote_href_example' # String | 
+nested_role = PulpPythonClient::NestedRole.new # NestedRole | 
+
+begin
+  #Remove a role
+  result = api_instance.remove_role(python_python_remote_href, nested_role)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling RemotesPythonApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **python_python_remote_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## set_label
 
 > SetLabelResponse set_label(python_python_remote_href, set_label)