# AsyncOperationResponse
Serializer for asynchronous operations.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**task** | **str** | The href of the task. |
## Example
```python
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
# TODO update the JSON string below
json = "{}"
# create an instance of AsyncOperationResponse from a JSON string
async_operation_response_instance = AsyncOperationResponse.from_json(json)
# print the JSON string representation of the object
print(AsyncOperationResponse.to_json())
# convert the object into a dict
async_operation_response_dict = async_operation_response_instance.to_dict()
# create an instance of AsyncOperationResponse from a dict
async_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# pulpcore.client.pulp_npm.ContentPackagesApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](ContentPackagesApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/content/npm/packages/ | Create a package
[**list**](ContentPackagesApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/content/npm/packages/ | List packages
[**read**](ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package
[**set_label**](ContentPackagesApi.md#set_label) | **POST** {npm_package_href}set_label/ | Set a label
[**unset_label**](ContentPackagesApi.md#unset_label) | **POST** {npm_package_href}unset_label/ | Unset a label
# **create**
> NpmPackageResponse create(pulp_domain, relative_path, name, version, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url)
Create a package
Perform bookkeeping when saving Content. \"Artifacts\" need to be popped off and saved independently, as they are not actually part of the Content model.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
relative_path = 'relative_path_example' # str |
name = 'name_example' # str |
version = 'version_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
repository = 'repository_example' # str | A URI of a repository the new content unit should be associated with. (optional)
pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)
artifact = 'artifact_example' # str | Artifact file representing the physical content (optional)
file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)
upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)
file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)
try:
# Create a package
api_response = api_instance.create(pulp_domain, relative_path, name, version, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url)
print("The response of ContentPackagesApi->create:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentPackagesApi->create: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**relative_path** | **str**| |
**name** | **str**| |
**version** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**repository** | **str**| A URI of a repository the new content unit should be associated with. | [optional]
**pulp_labels** | [**Dict[str, Optional[str]]**](Dict.md)| A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional]
**artifact** | **str**| Artifact file representing the physical content | [optional]
**file** | **bytearray**| An uploaded file that may be turned into the content unit. | [optional]
**upload** | **str**| An uncommitted upload that may be turned into the content unit. | [optional]
**file_url** | **str**| A url that Pulp can download and turn into the content unit. | [optional]
### Return type
[**NpmPackageResponse**](NpmPackageResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list**
> PaginatednpmPackageResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__in=name__in, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
List packages
A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.paginatednpm_package_response_list import PaginatednpmPackageResponseList
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
limit = 56 # int | Number of results to return per page. (optional)
name = 'name_example' # str | Filter results where name matches value (optional)
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List packages
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__in=name__in, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
print("The response of ContentPackagesApi->list:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentPackagesApi->list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**limit** | **int**| Number of results to return per page. | [optional]
**name** | **str**| Filter results where name matches value | [optional]
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
**offset** | **int**| The initial index from which to return the results. | [optional]
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
**orphaned_for** | **float**| Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional]
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_label_select** | **str**| Filter labels by search string | [optional]
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
**repository_version** | **str**| Repository Version referenced by HREF/PRN | [optional]
**repository_version_added** | **str**| Repository Version referenced by HREF/PRN | [optional]
**repository_version_removed** | **str**| Repository Version referenced by HREF/PRN | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatednpmPackageResponseList**](PaginatednpmPackageResponseList.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **read**
> NpmPackageResponse read(npm_package_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
Inspect a package
A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
npm_package_href = 'npm_package_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# Inspect a package
api_response = api_instance.read(npm_package_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of ContentPackagesApi->read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentPackagesApi->read: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_package_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**NpmPackageResponse**](NpmPackageResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **set_label**
> SetLabelResponse set_label(npm_package_href, set_label, x_task_diagnostics=x_task_diagnostics)
Set a label
Set a single pulp_label on the object to a specific value or null.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.set_label import SetLabel
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
npm_package_href = 'npm_package_href_example' # str |
set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Set a label
api_response = api_instance.set_label(npm_package_href, set_label, x_task_diagnostics=x_task_diagnostics)
print("The response of ContentPackagesApi->set_label:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentPackagesApi->set_label: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_package_href** | **str**| |
**set_label** | [**SetLabel**](SetLabel.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**SetLabelResponse**](SetLabelResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **unset_label**
> UnsetLabelResponse unset_label(npm_package_href, unset_label, x_task_diagnostics=x_task_diagnostics)
Unset a label
Unset a single pulp_label on the object.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
npm_package_href = 'npm_package_href_example' # str |
unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Unset a label
api_response = api_instance.unset_label(npm_package_href, unset_label, x_task_diagnostics=x_task_diagnostics)
print("The response of ContentPackagesApi->unset_label:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ContentPackagesApi->unset_label: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_package_href** | **str**| |
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**UnsetLabelResponse**](UnsetLabelResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# ContentSummaryResponse
Serializer for the RepositoryVersion content summary
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**added** | **Dict[str, object]** | |
**removed** | **Dict[str, object]** | |
**present** | **Dict[str, object]** | |
## Example
```python
from pulpcore.client.pulp_npm.models.content_summary_response import ContentSummaryResponse
# TODO update the JSON string below
json = "{}"
# create an instance of ContentSummaryResponse from a JSON string
content_summary_response_instance = ContentSummaryResponse.from_json(json)
# print the JSON string representation of the object
print(ContentSummaryResponse.to_json())
# convert the object into a dict
content_summary_response_dict = content_summary_response_instance.to_dict()
# create an instance of ContentSummaryResponse from a dict
content_summary_response_from_dict = ContentSummaryResponse.from_dict(content_summary_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# pulpcore.client.pulp_npm.DistributionsNpmApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](DistributionsNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/distributions/npm/npm/ | Create a npm distribution
[**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution
[**list**](DistributionsNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/distributions/npm/npm/ | List npm distributions
[**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution
[**read**](DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution
[**set_label**](DistributionsNpmApi.md#set_label) | **POST** {npm_npm_distribution_href}set_label/ | Set a label
[**unset_label**](DistributionsNpmApi.md#unset_label) | **POST** {npm_npm_distribution_href}unset_label/ | Unset a label
[**update**](DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution
# **create**
> AsyncOperationResponse create(pulp_domain, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
Create a npm distribution
Trigger an asynchronous create task
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
npm_npm_distribution = pulpcore.client.pulp_npm.NpmNpmDistribution() # NpmNpmDistribution |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Create a npm distribution
api_response = api_instance.create(pulp_domain, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
print("The response of DistributionsNpmApi->create:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DistributionsNpmApi->create: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete**
> AsyncOperationResponse delete(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics)
Delete a npm distribution
Trigger an asynchronous delete task
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Delete a npm distribution
api_response = api_instance.delete(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics)
print("The response of DistributionsNpmApi->delete:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DistributionsNpmApi->delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_distribution_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list**
> PaginatednpmNpmDistributionResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
List npm distributions
ViewSet for NPM Distributions.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.paginatednpm_npm_distribution_response_list import PaginatednpmNpmDistributionResponseList
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
base_path = 'base_path_example' # str | Filter results where base_path matches value (optional)
base_path__contains = 'base_path__contains_example' # str | Filter results where base_path contains value (optional)
base_path__icontains = 'base_path__icontains_example' # str | Filter results where base_path contains value (optional)
base_path__in = ['base_path__in_example'] # List[str] | Filter results where base_path is in a comma-separated list of values (optional)
checkpoint = True # bool | Filter results where checkpoint matches value (optional)
limit = 56 # int | Number of results to return per page. (optional)
name = 'name_example' # str | Filter results where name matches value (optional)
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
repository = 'repository_example' # str | Filter results where repository matches value (optional)
repository__in = ['repository__in_example'] # List[str] | Filter results where repository is in a comma-separated list of values (optional)
with_content = 'with_content_example' # str | Filter distributions based on the content served by them (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List npm distributions
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
print("The response of DistributionsNpmApi->list:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DistributionsNpmApi->list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**base_path** | **str**| Filter results where base_path matches value | [optional]
**base_path__contains** | **str**| Filter results where base_path contains value | [optional]
**base_path__icontains** | **str**| Filter results where base_path contains value | [optional]
**base_path__in** | [**List[str]**](str.md)| Filter results where base_path is in a comma-separated list of values | [optional]
**checkpoint** | **bool**| Filter results where checkpoint matches value | [optional]
**limit** | **int**| Number of results to return per page. | [optional]
**name** | **str**| Filter results where name matches value | [optional]
**name__contains** | **str**| Filter results where name contains value | [optional]
**name__icontains** | **str**| Filter results where name contains value | [optional]
**name__iexact** | **str**| Filter results where name matches value | [optional]
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
**name__iregex** | **str**| Filter results where name matches regex value | [optional]
**name__istartswith** | **str**| Filter results where name starts with value | [optional]
**name__regex** | **str**| Filter results where name matches regex value | [optional]
**name__startswith** | **str**| Filter results where name starts with value | [optional]
**offset** | **int**| The initial index from which to return the results. | [optional]
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_label_select** | **str**| Filter labels by search string | [optional]
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
**repository** | **str**| Filter results where repository matches value | [optional]
**repository__in** | [**List[str]**](str.md)| Filter results where repository is in a comma-separated list of values | [optional]
**with_content** | **str**| Filter distributions based on the content served by them | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatednpmNpmDistributionResponseList**](PaginatednpmNpmDistributionResponseList.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **partial_update**
> NpmNpmDistributionResponse partial_update(npm_npm_distribution_href, patchednpm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
Update a npm distribution
Update the entity partially and trigger an asynchronous task if necessary
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse
from pulpcore.client.pulp_npm.models.patchednpm_npm_distribution import PatchednpmNpmDistribution
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
patchednpm_npm_distribution = pulpcore.client.pulp_npm.PatchednpmNpmDistribution() # PatchednpmNpmDistribution |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Update a npm distribution
api_response = api_instance.partial_update(npm_npm_distribution_href, patchednpm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
print("The response of DistributionsNpmApi->partial_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DistributionsNpmApi->partial_update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_distribution_href** | **str**| |
**patchednpm_npm_distribution** | [**PatchednpmNpmDistribution**](PatchednpmNpmDistribution.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **read**
> NpmNpmDistributionResponse read(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
Inspect a npm distribution
ViewSet for NPM Distributions.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# Inspect a npm distribution
api_response = api_instance.read(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of DistributionsNpmApi->read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DistributionsNpmApi->read: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_distribution_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **set_label**
> SetLabelResponse set_label(npm_npm_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
Set a label
Set a single pulp_label on the object to a specific value or null.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.set_label import SetLabel
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Set a label
api_response = api_instance.set_label(npm_npm_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
print("The response of DistributionsNpmApi->set_label:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DistributionsNpmApi->set_label: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_distribution_href** | **str**| |
**set_label** | [**SetLabel**](SetLabel.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**SetLabelResponse**](SetLabelResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **unset_label**
> UnsetLabelResponse unset_label(npm_npm_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
Unset a label
Unset a single pulp_label on the object.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Unset a label
api_response = api_instance.unset_label(npm_npm_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
print("The response of DistributionsNpmApi->unset_label:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DistributionsNpmApi->unset_label: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_distribution_href** | **str**| |
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**UnsetLabelResponse**](UnsetLabelResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update**
> NpmNpmDistributionResponse update(npm_npm_distribution_href, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
Update a npm distribution
Update the entity and trigger an asynchronous task if necessary
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution
from pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
npm_npm_distribution = pulpcore.client.pulp_npm.NpmNpmDistribution() # NpmNpmDistribution |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Update a npm distribution
api_response = api_instance.update(npm_npm_distribution_href, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
print("The response of DistributionsNpmApi->update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DistributionsNpmApi->update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_distribution_href** | **str**| |
**npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# NpmNpmDistribution
Serializer for NPM Distributions.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**base_path** | **str** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
**content_guard** | **str** | An optional content-guard. | [optional]
**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**name** | **str** | A unique name. Ex, `rawhide` and `stable`. |
**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional]
**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution
# TODO update the JSON string below
json = "{}"
# create an instance of NpmNpmDistribution from a JSON string
npm_npm_distribution_instance = NpmNpmDistribution.from_json(json)
# print the JSON string representation of the object
print(NpmNpmDistribution.to_json())
# convert the object into a dict
npm_npm_distribution_dict = npm_npm_distribution_instance.to_dict()
# create an instance of NpmNpmDistribution from a dict
npm_npm_distribution_from_dict = NpmNpmDistribution.from_dict(npm_npm_distribution_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# NpmNpmDistributionResponse
Serializer for NPM Distributions.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_href** | **str** | | [optional] [readonly]
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly]
**base_path** | **str** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
**base_url** | **str** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly]
**content_guard** | **str** | An optional content-guard. | [optional]
**no_content_change_since** | **str** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional] [readonly]
**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**name** | **str** | A unique name. Ex, `rawhide` and `stable`. |
**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional]
**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse
# TODO update the JSON string below
json = "{}"
# create an instance of NpmNpmDistributionResponse from a JSON string
npm_npm_distribution_response_instance = NpmNpmDistributionResponse.from_json(json)
# print the JSON string representation of the object
print(NpmNpmDistributionResponse.to_json())
# convert the object into a dict
npm_npm_distribution_response_dict = npm_npm_distribution_response_instance.to_dict()
# create an instance of NpmNpmDistributionResponse from a dict
npm_npm_distribution_response_from_dict = NpmNpmDistributionResponse.from_dict(npm_npm_distribution_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# NpmNpmRemote
A Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | A unique name for this remote. |
**url** | **str** | The URL of an external content source. |
**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional]
**client_key** | **str** | A PEM encoded private key used for authentication. | [optional]
**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional]
**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional]
**proxy_username** | **str** | The username to authenticte to the proxy. | [optional]
**proxy_password** | **str** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
**username** | **str** | The username to be used for authentication when syncing. | [optional]
**password** | **str** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional]
**total_timeout** | **float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**connect_timeout** | **float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**sock_connect_timeout** | **float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**sock_read_timeout** | **float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional]
**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote
# TODO update the JSON string below
json = "{}"
# create an instance of NpmNpmRemote from a JSON string
npm_npm_remote_instance = NpmNpmRemote.from_json(json)
# print the JSON string representation of the object
print(NpmNpmRemote.to_json())
# convert the object into a dict
npm_npm_remote_dict = npm_npm_remote_instance.to_dict()
# create an instance of NpmNpmRemote from a dict
npm_npm_remote_from_dict = NpmNpmRemote.from_dict(npm_npm_remote_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# NpmNpmRemoteResponseHiddenFieldsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | |
**is_set** | **bool** | |
## Example
```python
from pulpcore.client.pulp_npm.models.npm_npm_remote_response_hidden_fields_inner import NpmNpmRemoteResponseHiddenFieldsInner
# TODO update the JSON string below
json = "{}"
# create an instance of NpmNpmRemoteResponseHiddenFieldsInner from a JSON string
npm_npm_remote_response_hidden_fields_inner_instance = NpmNpmRemoteResponseHiddenFieldsInner.from_json(json)
# print the JSON string representation of the object
print(NpmNpmRemoteResponseHiddenFieldsInner.to_json())
# convert the object into a dict
npm_npm_remote_response_hidden_fields_inner_dict = npm_npm_remote_response_hidden_fields_inner_instance.to_dict()
# create an instance of NpmNpmRemoteResponseHiddenFieldsInner from a dict
npm_npm_remote_response_hidden_fields_inner_from_dict = NpmNpmRemoteResponseHiddenFieldsInner.from_dict(npm_npm_remote_response_hidden_fields_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# NpmNpmRemoteResponse
A Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_href** | **str** | | [optional] [readonly]
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
**pulp_last_updated** | **datetime** | Timestamp of the most recent update of the remote. | [optional] [readonly]
**name** | **str** | A unique name for this remote. |
**url** | **str** | The URL of an external content source. |
**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional]
**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional]
**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional]
**total_timeout** | **float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**connect_timeout** | **float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**sock_connect_timeout** | **float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**sock_read_timeout** | **float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional]
**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional]
**hidden_fields** | [**List[NpmNpmRemoteResponseHiddenFieldsInner]**](NpmNpmRemoteResponseHiddenFieldsInner.md) | List of hidden (write only) fields | [optional] [readonly]
## Example
```python
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
# TODO update the JSON string below
json = "{}"
# create an instance of NpmNpmRemoteResponse from a JSON string
npm_npm_remote_response_instance = NpmNpmRemoteResponse.from_json(json)
# print the JSON string representation of the object
print(NpmNpmRemoteResponse.to_json())
# convert the object into a dict
npm_npm_remote_response_dict = npm_npm_remote_response_instance.to_dict()
# create an instance of NpmNpmRemoteResponse from a dict
npm_npm_remote_response_from_dict = NpmNpmRemoteResponse.from_dict(npm_npm_remote_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# NpmNpmRepository
A Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**name** | **str** | A unique name for this repository. |
**description** | **str** | An optional description. | [optional]
**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
**remote** | **str** | An optional remote to use by default when syncing. | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository
# TODO update the JSON string below
json = "{}"
# create an instance of NpmNpmRepository from a JSON string
npm_npm_repository_instance = NpmNpmRepository.from_json(json)
# print the JSON string representation of the object
print(NpmNpmRepository.to_json())
# convert the object into a dict
npm_npm_repository_dict = npm_npm_repository_instance.to_dict()
# create an instance of NpmNpmRepository from a dict
npm_npm_repository_from_dict = NpmNpmRepository.from_dict(npm_npm_repository_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# NpmNpmRepositoryResponse
A Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_href** | **str** | | [optional] [readonly]
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly]
**versions_href** | **str** | | [optional] [readonly]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**latest_version_href** | **str** | | [optional] [readonly]
**name** | **str** | A unique name for this repository. |
**description** | **str** | An optional description. | [optional]
**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
**remote** | **str** | An optional remote to use by default when syncing. | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
# TODO update the JSON string below
json = "{}"
# create an instance of NpmNpmRepositoryResponse from a JSON string
npm_npm_repository_response_instance = NpmNpmRepositoryResponse.from_json(json)
# print the JSON string representation of the object
print(NpmNpmRepositoryResponse.to_json())
# convert the object into a dict
npm_npm_repository_response_dict = npm_npm_repository_response_instance.to_dict()
# create an instance of NpmNpmRepositoryResponse from a dict
npm_npm_repository_response_from_dict = NpmNpmRepositoryResponse.from_dict(npm_npm_repository_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# NpmPackageResponse
A Serializer for Package. Add serializers for the new fields defined in Package and add those fields to the Meta class keeping fields from the parent class as well. For example:: field1 = serializers.TextField() field2 = serializers.IntegerField() field3 = serializers.CharField() class Meta: fields = core_serializers.SingleArtifactContentSerializer.Meta.fields + ( 'field1', 'field2', 'field3' ) model = models.Package
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_href** | **str** | | [optional] [readonly]
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly]
**pulp_labels** | **Dict[str, Optional[str]]** | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional]
**vuln_report** | **str** | | [optional] [readonly]
**artifact** | **str** | Artifact file representing the physical content | [optional]
**relative_path** | **str** | |
**name** | **str** | |
**version** | **str** | |
## Example
```python
from pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse
# TODO update the JSON string below
json = "{}"
# create an instance of NpmPackageResponse from a JSON string
npm_package_response_instance = NpmPackageResponse.from_json(json)
# print the JSON string representation of the object
print(NpmPackageResponse.to_json())
# convert the object into a dict
npm_package_response_dict = npm_package_response_instance.to_dict()
# create an instance of NpmPackageResponse from a dict
npm_package_response_from_dict = NpmPackageResponse.from_dict(npm_package_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PaginatednpmNpmDistributionResponseList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**next** | **str** | | [optional]
**previous** | **str** | | [optional]
**results** | [**List[NpmNpmDistributionResponse]**](NpmNpmDistributionResponse.md) | |
## Example
```python
from pulpcore.client.pulp_npm.models.paginatednpm_npm_distribution_response_list import PaginatednpmNpmDistributionResponseList
# TODO update the JSON string below
json = "{}"
# create an instance of PaginatednpmNpmDistributionResponseList from a JSON string
paginatednpm_npm_distribution_response_list_instance = PaginatednpmNpmDistributionResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatednpmNpmDistributionResponseList.to_json())
# convert the object into a dict
paginatednpm_npm_distribution_response_list_dict = paginatednpm_npm_distribution_response_list_instance.to_dict()
# create an instance of PaginatednpmNpmDistributionResponseList from a dict
paginatednpm_npm_distribution_response_list_from_dict = PaginatednpmNpmDistributionResponseList.from_dict(paginatednpm_npm_distribution_response_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PaginatednpmNpmRemoteResponseList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**next** | **str** | | [optional]
**previous** | **str** | | [optional]
**results** | [**List[NpmNpmRemoteResponse]**](NpmNpmRemoteResponse.md) | |
## Example
```python
from pulpcore.client.pulp_npm.models.paginatednpm_npm_remote_response_list import PaginatednpmNpmRemoteResponseList
# TODO update the JSON string below
json = "{}"
# create an instance of PaginatednpmNpmRemoteResponseList from a JSON string
paginatednpm_npm_remote_response_list_instance = PaginatednpmNpmRemoteResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatednpmNpmRemoteResponseList.to_json())
# convert the object into a dict
paginatednpm_npm_remote_response_list_dict = paginatednpm_npm_remote_response_list_instance.to_dict()
# create an instance of PaginatednpmNpmRemoteResponseList from a dict
paginatednpm_npm_remote_response_list_from_dict = PaginatednpmNpmRemoteResponseList.from_dict(paginatednpm_npm_remote_response_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PaginatednpmNpmRepositoryResponseList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**next** | **str** | | [optional]
**previous** | **str** | | [optional]
**results** | [**List[NpmNpmRepositoryResponse]**](NpmNpmRepositoryResponse.md) | |
## Example
```python
from pulpcore.client.pulp_npm.models.paginatednpm_npm_repository_response_list import PaginatednpmNpmRepositoryResponseList
# TODO update the JSON string below
json = "{}"
# create an instance of PaginatednpmNpmRepositoryResponseList from a JSON string
paginatednpm_npm_repository_response_list_instance = PaginatednpmNpmRepositoryResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatednpmNpmRepositoryResponseList.to_json())
# convert the object into a dict
paginatednpm_npm_repository_response_list_dict = paginatednpm_npm_repository_response_list_instance.to_dict()
# create an instance of PaginatednpmNpmRepositoryResponseList from a dict
paginatednpm_npm_repository_response_list_from_dict = PaginatednpmNpmRepositoryResponseList.from_dict(paginatednpm_npm_repository_response_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PaginatednpmPackageResponseList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**next** | **str** | | [optional]
**previous** | **str** | | [optional]
**results** | [**List[NpmPackageResponse]**](NpmPackageResponse.md) | |
## Example
```python
from pulpcore.client.pulp_npm.models.paginatednpm_package_response_list import PaginatednpmPackageResponseList
# TODO update the JSON string below
json = "{}"
# create an instance of PaginatednpmPackageResponseList from a JSON string
paginatednpm_package_response_list_instance = PaginatednpmPackageResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatednpmPackageResponseList.to_json())
# convert the object into a dict
paginatednpm_package_response_list_dict = paginatednpm_package_response_list_instance.to_dict()
# create an instance of PaginatednpmPackageResponseList from a dict
paginatednpm_package_response_list_from_dict = PaginatednpmPackageResponseList.from_dict(paginatednpm_package_response_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PaginatedRepositoryVersionResponseList
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**next** | **str** | | [optional]
**previous** | **str** | | [optional]
**results** | [**List[RepositoryVersionResponse]**](RepositoryVersionResponse.md) | |
## Example
```python
from pulpcore.client.pulp_npm.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedRepositoryVersionResponseList from a JSON string
paginated_repository_version_response_list_instance = PaginatedRepositoryVersionResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedRepositoryVersionResponseList.to_json())
# convert the object into a dict
paginated_repository_version_response_list_dict = paginated_repository_version_response_list_instance.to_dict()
# create an instance of PaginatedRepositoryVersionResponseList from a dict
paginated_repository_version_response_list_from_dict = PaginatedRepositoryVersionResponseList.from_dict(paginated_repository_version_response_list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PatchednpmNpmDistribution
Serializer for NPM Distributions.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**base_path** | **str** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | [optional]
**content_guard** | **str** | An optional content-guard. | [optional]
**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**name** | **str** | A unique name. Ex, `rawhide` and `stable`. | [optional]
**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional]
**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.patchednpm_npm_distribution import PatchednpmNpmDistribution
# TODO update the JSON string below
json = "{}"
# create an instance of PatchednpmNpmDistribution from a JSON string
patchednpm_npm_distribution_instance = PatchednpmNpmDistribution.from_json(json)
# print the JSON string representation of the object
print(PatchednpmNpmDistribution.to_json())
# convert the object into a dict
patchednpm_npm_distribution_dict = patchednpm_npm_distribution_instance.to_dict()
# create an instance of PatchednpmNpmDistribution from a dict
patchednpm_npm_distribution_from_dict = PatchednpmNpmDistribution.from_dict(patchednpm_npm_distribution_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PatchednpmNpmRemote
A Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | A unique name for this remote. | [optional]
**url** | **str** | The URL of an external content source. | [optional]
**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional]
**client_key** | **str** | A PEM encoded private key used for authentication. | [optional]
**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional]
**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional]
**proxy_username** | **str** | The username to authenticte to the proxy. | [optional]
**proxy_password** | **str** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
**username** | **str** | The username to be used for authentication when syncing. | [optional]
**password** | **str** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional]
**total_timeout** | **float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**connect_timeout** | **float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**sock_connect_timeout** | **float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**sock_read_timeout** | **float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional]
**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional]
**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.patchednpm_npm_remote import PatchednpmNpmRemote
# TODO update the JSON string below
json = "{}"
# create an instance of PatchednpmNpmRemote from a JSON string
patchednpm_npm_remote_instance = PatchednpmNpmRemote.from_json(json)
# print the JSON string representation of the object
print(PatchednpmNpmRemote.to_json())
# convert the object into a dict
patchednpm_npm_remote_dict = patchednpm_npm_remote_instance.to_dict()
# create an instance of PatchednpmNpmRemote from a dict
patchednpm_npm_remote_from_dict = PatchednpmNpmRemote.from_dict(patchednpm_npm_remote_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PatchednpmNpmRepository
A Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
**name** | **str** | A unique name for this repository. | [optional]
**description** | **str** | An optional description. | [optional]
**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
**remote** | **str** | An optional remote to use by default when syncing. | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.patchednpm_npm_repository import PatchednpmNpmRepository
# TODO update the JSON string below
json = "{}"
# create an instance of PatchednpmNpmRepository from a JSON string
patchednpm_npm_repository_instance = PatchednpmNpmRepository.from_json(json)
# print the JSON string representation of the object
print(PatchednpmNpmRepository.to_json())
# convert the object into a dict
patchednpm_npm_repository_dict = patchednpm_npm_repository_instance.to_dict()
# create an instance of PatchednpmNpmRepository from a dict
patchednpm_npm_repository_from_dict = PatchednpmNpmRepository.from_dict(patchednpm_npm_repository_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# PolicyEnum
* `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.
## Enum
* `IMMEDIATE` (value: `'immediate'`)
* `ON_DEMAND` (value: `'on_demand'`)
* `STREAMED` (value: `'streamed'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# pulpcore.client.pulp_npm.RemotesNpmApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](RemotesNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/remotes/npm/npm/ | Create a npm remote
[**delete**](RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
[**list**](RemotesNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/remotes/npm/npm/ | List npm remotes
[**partial_update**](RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
[**read**](RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
[**set_label**](RemotesNpmApi.md#set_label) | **POST** {npm_npm_remote_href}set_label/ | Set a label
[**unset_label**](RemotesNpmApi.md#unset_label) | **POST** {npm_npm_remote_href}unset_label/ | Unset a label
[**update**](RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
# **create**
> NpmNpmRemoteResponse create(pulp_domain, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)
Create a npm remote
A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
npm_npm_remote = pulpcore.client.pulp_npm.NpmNpmRemote() # NpmNpmRemote |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Create a npm remote
api_response = api_instance.create(pulp_domain, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)
print("The response of RemotesNpmApi->create:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RemotesNpmApi->create: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete**
> AsyncOperationResponse delete(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics)
Delete a npm remote
Trigger an asynchronous delete task
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Delete a npm remote
api_response = api_instance.delete(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics)
print("The response of RemotesNpmApi->delete:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RemotesNpmApi->delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_remote_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list**
> PaginatednpmNpmRemoteResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)
List npm remotes
A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.paginatednpm_npm_remote_response_list import PaginatednpmNpmRemoteResponseList
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
limit = 56 # int | Number of results to return per page. (optional)
name = 'name_example' # str | Filter results where name matches value (optional)
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
pulp_last_updated = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated matches value (optional)
pulp_last_updated__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than value (optional)
pulp_last_updated__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than or equal to value (optional)
pulp_last_updated__isnull = True # bool | Filter results where pulp_last_updated has a null value (optional)
pulp_last_updated__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than value (optional)
pulp_last_updated__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than or equal to value (optional)
pulp_last_updated__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_last_updated is between two comma separated values (optional)
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List npm remotes
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)
print("The response of RemotesNpmApi->list:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RemotesNpmApi->list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**limit** | **int**| Number of results to return per page. | [optional]
**name** | **str**| Filter results where name matches value | [optional]
**name__contains** | **str**| Filter results where name contains value | [optional]
**name__icontains** | **str**| Filter results where name contains value | [optional]
**name__iexact** | **str**| Filter results where name matches value | [optional]
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
**name__iregex** | **str**| Filter results where name matches regex value | [optional]
**name__istartswith** | **str**| Filter results where name starts with value | [optional]
**name__regex** | **str**| Filter results where name matches regex value | [optional]
**name__startswith** | **str**| Filter results where name starts with value | [optional]
**offset** | **int**| The initial index from which to return the results. | [optional]
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_label_select** | **str**| Filter labels by search string | [optional]
**pulp_last_updated** | **datetime**| Filter results where pulp_last_updated matches value | [optional]
**pulp_last_updated__gt** | **datetime**| Filter results where pulp_last_updated is greater than value | [optional]
**pulp_last_updated__gte** | **datetime**| Filter results where pulp_last_updated is greater than or equal to value | [optional]
**pulp_last_updated__isnull** | **bool**| Filter results where pulp_last_updated has a null value | [optional]
**pulp_last_updated__lt** | **datetime**| Filter results where pulp_last_updated is less than value | [optional]
**pulp_last_updated__lte** | **datetime**| Filter results where pulp_last_updated is less than or equal to value | [optional]
**pulp_last_updated__range** | [**List[datetime]**](datetime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional]
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatednpmNpmRemoteResponseList**](PaginatednpmNpmRemoteResponseList.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **partial_update**
> NpmNpmRemoteResponse partial_update(npm_npm_remote_href, patchednpm_npm_remote, x_task_diagnostics=x_task_diagnostics)
Update a npm remote
Update the entity partially and trigger an asynchronous task if necessary
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
from pulpcore.client.pulp_npm.models.patchednpm_npm_remote import PatchednpmNpmRemote
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
patchednpm_npm_remote = pulpcore.client.pulp_npm.PatchednpmNpmRemote() # PatchednpmNpmRemote |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Update a npm remote
api_response = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote, x_task_diagnostics=x_task_diagnostics)
print("The response of RemotesNpmApi->partial_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RemotesNpmApi->partial_update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_remote_href** | **str**| |
**patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **read**
> NpmNpmRemoteResponse read(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
Inspect a npm remote
A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# Inspect a npm remote
api_response = api_instance.read(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of RemotesNpmApi->read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RemotesNpmApi->read: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_remote_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **set_label**
> SetLabelResponse set_label(npm_npm_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)
Set a label
Set a single pulp_label on the object to a specific value or null.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.set_label import SetLabel
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Set a label
api_response = api_instance.set_label(npm_npm_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)
print("The response of RemotesNpmApi->set_label:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RemotesNpmApi->set_label: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_remote_href** | **str**| |
**set_label** | [**SetLabel**](SetLabel.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**SetLabelResponse**](SetLabelResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **unset_label**
> UnsetLabelResponse unset_label(npm_npm_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)
Unset a label
Unset a single pulp_label on the object.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Unset a label
api_response = api_instance.unset_label(npm_npm_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)
print("The response of RemotesNpmApi->unset_label:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RemotesNpmApi->unset_label: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_remote_href** | **str**| |
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**UnsetLabelResponse**](UnsetLabelResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update**
> NpmNpmRemoteResponse update(npm_npm_remote_href, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)
Update a npm remote
Update the entity and trigger an asynchronous task if necessary
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
npm_npm_remote = pulpcore.client.pulp_npm.NpmNpmRemote() # NpmNpmRemote |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Update a npm remote
api_response = api_instance.update(npm_npm_remote_href, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)
print("The response of RemotesNpmApi->update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RemotesNpmApi->update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_remote_href** | **str**| |
**npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# Repair
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**verify_checksums** | **bool** | Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default | [optional] [default to True]
## Example
```python
from pulpcore.client.pulp_npm.models.repair import Repair
# TODO update the JSON string below
json = "{}"
# create an instance of Repair from a JSON string
repair_instance = Repair.from_json(json)
# print the JSON string representation of the object
print(Repair.to_json())
# convert the object into a dict
repair_dict = repair_instance.to_dict()
# create an instance of Repair from a dict
repair_from_dict = Repair.from_dict(repair_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# pulpcore.client.pulp_npm.RepositoriesNpmApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](RepositoriesNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/repositories/npm/npm/ | Create a npm repository
[**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
[**list**](RepositoriesNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/repositories/npm/npm/ | List npm repositorys
[**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
[**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
[**read**](RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
[**set_label**](RepositoriesNpmApi.md#set_label) | **POST** {npm_npm_repository_href}set_label/ | Set a label
[**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
[**unset_label**](RepositoriesNpmApi.md#unset_label) | **POST** {npm_npm_repository_href}unset_label/ | Unset a label
[**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository
# **create**
> NpmNpmRepositoryResponse create(pulp_domain, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)
Create a npm repository
A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
npm_npm_repository = pulpcore.client.pulp_npm.NpmNpmRepository() # NpmNpmRepository |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Create a npm repository
api_response = api_instance.create(pulp_domain, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmApi->create:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->create: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete**
> AsyncOperationResponse delete(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics)
Delete a npm repository
Trigger an asynchronous delete task
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Delete a npm repository
api_response = api_instance.delete(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmApi->delete:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list**
> PaginatednpmNpmRepositoryResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
List npm repositorys
A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.paginatednpm_npm_repository_response_list import PaginatednpmNpmRepositoryResponseList
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
pulp_domain = 'pulp_domain_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
latest_with_content = 'latest_with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
limit = 56 # int | Number of results to return per page. (optional)
name = 'name_example' # str | Filter results where name matches value (optional)
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
remote = 'remote_example' # str | Foreign Key referenced by HREF (optional)
retain_repo_versions = 56 # int | Filter results where retain_repo_versions matches value (optional)
retain_repo_versions__gt = 56 # int | Filter results where retain_repo_versions is greater than value (optional)
retain_repo_versions__gte = 56 # int | Filter results where retain_repo_versions is greater than or equal to value (optional)
retain_repo_versions__isnull = True # bool | Filter results where retain_repo_versions has a null value (optional)
retain_repo_versions__lt = 56 # int | Filter results where retain_repo_versions is less than value (optional)
retain_repo_versions__lte = 56 # int | Filter results where retain_repo_versions is less than or equal to value (optional)
retain_repo_versions__ne = 56 # int | Filter results where retain_repo_versions not equal to value (optional)
retain_repo_versions__range = [56] # List[int] | Filter results where retain_repo_versions is between two comma separated values (optional)
with_content = 'with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List npm repositorys
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
print("The response of RepositoriesNpmApi->list:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pulp_domain** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**latest_with_content** | **str**| Content Unit referenced by HREF/PRN | [optional]
**limit** | **int**| Number of results to return per page. | [optional]
**name** | **str**| Filter results where name matches value | [optional]
**name__contains** | **str**| Filter results where name contains value | [optional]
**name__icontains** | **str**| Filter results where name contains value | [optional]
**name__iexact** | **str**| Filter results where name matches value | [optional]
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
**name__iregex** | **str**| Filter results where name matches regex value | [optional]
**name__istartswith** | **str**| Filter results where name starts with value | [optional]
**name__regex** | **str**| Filter results where name matches regex value | [optional]
**name__startswith** | **str**| Filter results where name starts with value | [optional]
**offset** | **int**| The initial index from which to return the results. | [optional]
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_label_select** | **str**| Filter labels by search string | [optional]
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
**remote** | **str**| Foreign Key referenced by HREF | [optional]
**retain_repo_versions** | **int**| Filter results where retain_repo_versions matches value | [optional]
**retain_repo_versions__gt** | **int**| Filter results where retain_repo_versions is greater than value | [optional]
**retain_repo_versions__gte** | **int**| Filter results where retain_repo_versions is greater than or equal to value | [optional]
**retain_repo_versions__isnull** | **bool**| Filter results where retain_repo_versions has a null value | [optional]
**retain_repo_versions__lt** | **int**| Filter results where retain_repo_versions is less than value | [optional]
**retain_repo_versions__lte** | **int**| Filter results where retain_repo_versions is less than or equal to value | [optional]
**retain_repo_versions__ne** | **int**| Filter results where retain_repo_versions not equal to value | [optional]
**retain_repo_versions__range** | [**List[int]**](int.md)| Filter results where retain_repo_versions is between two comma separated values | [optional]
**with_content** | **str**| Content Unit referenced by HREF/PRN | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatednpmNpmRepositoryResponseList**](PaginatednpmNpmRepositoryResponseList.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **modify**
> AsyncOperationResponse modify(npm_npm_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)
Modify Repository Content
Trigger an asynchronous task to create a new repository version.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_npm.models.repository_add_remove_content import RepositoryAddRemoveContent
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
repository_add_remove_content = pulpcore.client.pulp_npm.RepositoryAddRemoveContent() # RepositoryAddRemoveContent |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Modify Repository Content
api_response = api_instance.modify(npm_npm_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmApi->modify:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->modify: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **partial_update**
> NpmNpmRepositoryResponse partial_update(npm_npm_repository_href, patchednpm_npm_repository, x_task_diagnostics=x_task_diagnostics)
Update a npm repository
Update the entity partially and trigger an asynchronous task if necessary
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
from pulpcore.client.pulp_npm.models.patchednpm_npm_repository import PatchednpmNpmRepository
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
patchednpm_npm_repository = pulpcore.client.pulp_npm.PatchednpmNpmRepository() # PatchednpmNpmRepository |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Update a npm repository
api_response = api_instance.partial_update(npm_npm_repository_href, patchednpm_npm_repository, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmApi->partial_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->partial_update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**patchednpm_npm_repository** | [**PatchednpmNpmRepository**](PatchednpmNpmRepository.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **read**
> NpmNpmRepositoryResponse read(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
Inspect a npm repository
A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# Inspect a npm repository
api_response = api_instance.read(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of RepositoriesNpmApi->read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->read: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **set_label**
> SetLabelResponse set_label(npm_npm_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)
Set a label
Set a single pulp_label on the object to a specific value or null.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.set_label import SetLabel
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Set a label
api_response = api_instance.set_label(npm_npm_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmApi->set_label:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->set_label: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**set_label** | [**SetLabel**](SetLabel.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**SetLabelResponse**](SetLabelResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **sync**
> AsyncOperationResponse sync(npm_npm_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)
Sync from remote
Trigger an asynchronous task to sync content.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_npm.models.repository_sync_url import RepositorySyncURL
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
repository_sync_url = pulpcore.client.pulp_npm.RepositorySyncURL() # RepositorySyncURL |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Sync from remote
api_response = api_instance.sync(npm_npm_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmApi->sync:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->sync: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **unset_label**
> UnsetLabelResponse unset_label(npm_npm_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)
Unset a label
Unset a single pulp_label on the object.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Unset a label
api_response = api_instance.unset_label(npm_npm_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmApi->unset_label:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->unset_label: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**UnsetLabelResponse**](UnsetLabelResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update**
> NpmNpmRepositoryResponse update(npm_npm_repository_href, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)
Update a npm repository
Update the entity and trigger an asynchronous task if necessary
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
npm_npm_repository = pulpcore.client.pulp_npm.NpmNpmRepository() # NpmNpmRepository |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Update a npm repository
api_response = api_instance.update(npm_npm_repository_href, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmApi->update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmApi->update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi
All URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete**](RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version
[**list**](RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions
[**read**](RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version
[**repair**](RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ |
# **delete**
> AsyncOperationResponse delete(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics)
Delete a repository version
Trigger an asynchronous task to delete a repository version.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)
npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
# Delete a repository version
api_response = api_instance.delete(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmVersionsApi->delete:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmVersionsApi->delete: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_version_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **list**
> PaginatedRepositoryVersionResponseList list(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)
List repository versions
A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)
content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
limit = 56 # int | Number of results to return per page. (optional)
number = 56 # int | Filter results where number matches value (optional)
number__gt = 56 # int | Filter results where number is greater than value (optional)
number__gte = 56 # int | Filter results where number is greater than or equal to value (optional)
number__lt = 56 # int | Filter results where number is less than value (optional)
number__lte = 56 # int | Filter results where number is less than or equal to value (optional)
number__range = [56] # List[int] | Filter results where number is between two comma separated values (optional)
offset = 56 # int | The initial index from which to return the results. (optional)
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# List repository versions
api_response = api_instance.list(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)
print("The response of RepositoriesNpmVersionsApi->list:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmVersionsApi->list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**content** | **str**| Content Unit referenced by HREF/PRN | [optional]
**content__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**limit** | **int**| Number of results to return per page. | [optional]
**number** | **int**| Filter results where number matches value | [optional]
**number__gt** | **int**| Filter results where number is greater than value | [optional]
**number__gte** | **int**| Filter results where number is greater than or equal to value | [optional]
**number__lt** | **int**| Filter results where number is less than value | [optional]
**number__lte** | **int**| Filter results where number is less than or equal to value | [optional]
**number__range** | [**List[int]**](int.md)| Filter results where number is between two comma separated values | [optional]
**offset** | **int**| The initial index from which to return the results. | [optional]
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**pulp_created** | **datetime**| Filter results where pulp_created matches value | [optional]
**pulp_created__gt** | **datetime**| Filter results where pulp_created is greater than value | [optional]
**pulp_created__gte** | **datetime**| Filter results where pulp_created is greater than or equal to value | [optional]
**pulp_created__isnull** | **bool**| Filter results where pulp_created has a null value | [optional]
**pulp_created__lt** | **datetime**| Filter results where pulp_created is less than value | [optional]
**pulp_created__lte** | **datetime**| Filter results where pulp_created is less than or equal to value | [optional]
**pulp_created__range** | [**List[datetime]**](datetime.md)| Filter results where pulp_created is between two comma separated values | [optional]
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**PaginatedRepositoryVersionResponseList**](PaginatedRepositoryVersionResponseList.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **read**
> RepositoryVersionResponse read(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
Inspect a repository version
A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.repository_version_response import RepositoryVersionResponse
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)
npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
try:
# Inspect a repository version
api_response = api_instance.read(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
print("The response of RepositoriesNpmVersionsApi->read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmVersionsApi->read: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_version_href** | **str**| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**RepositoryVersionResponse**](RepositoryVersionResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **repair**
> AsyncOperationResponse repair(npm_npm_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)
Trigger an asynchronous task to repair a repository version.
### Example
* OAuth Authentication (json_header_remote_authentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
```python
import pulpcore.client.pulp_npm
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_npm.models.repair import Repair
from pulpcore.client.pulp_npm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_npm.Configuration(
host = "https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_npm.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)
npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str |
repair = pulpcore.client.pulp_npm.Repair() # Repair |
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
try:
api_response = api_instance.repair(npm_npm_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)
print("The response of RepositoriesNpmVersionsApi->repair:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling RepositoriesNpmVersionsApi->repair: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**npm_npm_repository_version_href** | **str**| |
**repair** | [**Repair**](Repair.md)| |
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
### Return type
[**AsyncOperationResponse**](AsyncOperationResponse.md)
### Authorization
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# RepositoryAddRemoveContent
Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**add_content_units** | **List[str]** | A list of content units to add to a new repository version. This content is added after remove_content_units are removed. | [optional]
**remove_content_units** | **List[str]** | A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added. | [optional]
**base_version** | **str** | A repository version whose content will be used as the initial set of content for the new repository version | [optional]
## Example
```python
from pulpcore.client.pulp_npm.models.repository_add_remove_content import RepositoryAddRemoveContent
# TODO update the JSON string below
json = "{}"
# create an instance of RepositoryAddRemoveContent from a JSON string
repository_add_remove_content_instance = RepositoryAddRemoveContent.from_json(json)
# print the JSON string representation of the object
print(RepositoryAddRemoveContent.to_json())
# convert the object into a dict
repository_add_remove_content_dict = repository_add_remove_content_instance.to_dict()
# create an instance of RepositoryAddRemoveContent from a dict
repository_add_remove_content_from_dict = RepositoryAddRemoveContent.from_dict(repository_add_remove_content_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# RepositorySyncURL
A mixin for validating unknown serializers' fields.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**remote** | **str** | A remote to sync from. This will override a remote set on repository. | [optional]
**mirror** | **bool** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional] [default to False]
## Example
```python
from pulpcore.client.pulp_npm.models.repository_sync_url import RepositorySyncURL
# TODO update the JSON string below
json = "{}"
# create an instance of RepositorySyncURL from a JSON string
repository_sync_url_instance = RepositorySyncURL.from_json(json)
# print the JSON string representation of the object
print(RepositorySyncURL.to_json())
# convert the object into a dict
repository_sync_url_dict = repository_sync_url_instance.to_dict()
# create an instance of RepositorySyncURL from a dict
repository_sync_url_from_dict = RepositorySyncURL.from_dict(repository_sync_url_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# RepositoryVersionResponse
Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pulp_href** | **str** | | [optional] [readonly]
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly]
**number** | **int** | | [optional] [readonly]
**repository** | **str** | | [optional] [readonly]
**base_version** | **str** | A repository version whose content was used as the initial set of content for this repository version | [optional]
**content_summary** | [**ContentSummaryResponse**](ContentSummaryResponse.md) | Various count summaries of the content in the version and the HREF to view them. | [optional] [readonly]
**vuln_report** | **str** | | [optional] [readonly]
## Example
```python
from pulpcore.client.pulp_npm.models.repository_version_response import RepositoryVersionResponse
# TODO update the JSON string below
json = "{}"
# create an instance of RepositoryVersionResponse from a JSON string
repository_version_response_instance = RepositoryVersionResponse.from_json(json)
# print the JSON string representation of the object
print(RepositoryVersionResponse.to_json())
# convert the object into a dict
repository_version_response_dict = repository_version_response_instance.to_dict()
# create an instance of RepositoryVersionResponse from a dict
repository_version_response_from_dict = RepositoryVersionResponse.from_dict(repository_version_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# SetLabel
Serializer for synchronously setting a label.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | |
**value** | **str** | |
## Example
```python
from pulpcore.client.pulp_npm.models.set_label import SetLabel
# TODO update the JSON string below
json = "{}"
# create an instance of SetLabel from a JSON string
set_label_instance = SetLabel.from_json(json)
# print the JSON string representation of the object
print(SetLabel.to_json())
# convert the object into a dict
set_label_dict = set_label_instance.to_dict()
# create an instance of SetLabel from a dict
set_label_from_dict = SetLabel.from_dict(set_label_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# SetLabelResponse
Serializer for synchronously setting a label.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | |
**value** | **str** | |
## Example
```python
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
# TODO update the JSON string below
json = "{}"
# create an instance of SetLabelResponse from a JSON string
set_label_response_instance = SetLabelResponse.from_json(json)
# print the JSON string representation of the object
print(SetLabelResponse.to_json())
# convert the object into a dict
set_label_response_dict = set_label_response_instance.to_dict()
# create an instance of SetLabelResponse from a dict
set_label_response_from_dict = SetLabelResponse.from_dict(set_label_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# UnsetLabel
Serializer for synchronously UNsetting a label.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | |
## Example
```python
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
# TODO update the JSON string below
json = "{}"
# create an instance of UnsetLabel from a JSON string
unset_label_instance = UnsetLabel.from_json(json)
# print the JSON string representation of the object
print(UnsetLabel.to_json())
# convert the object into a dict
unset_label_dict = unset_label_instance.to_dict()
# create an instance of UnsetLabel from a dict
unset_label_from_dict = UnsetLabel.from_dict(unset_label_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# UnsetLabelResponse
Serializer for synchronously UNsetting a label.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | |
**value** | **str** | | [optional] [readonly]
## Example
```python
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
# TODO update the JSON string below
json = "{}"
# create an instance of UnsetLabelResponse from a JSON string
unset_label_response_instance = UnsetLabelResponse.from_json(json)
# print the JSON string representation of the object
print(UnsetLabelResponse.to_json())
# convert the object into a dict
unset_label_response_dict = unset_label_response_instance.to_dict()
# create an instance of UnsetLabelResponse from a dict
unset_label_response_from_dict = UnsetLabelResponse.from_dict(unset_label_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "crc-pulp-npm-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pulp, pulpcore, client, Pulp 3 API",
"author": "Pulp Team",
"author_email": "pulp-list@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/e8/8d/a5f6fa1a37129cc41dd814e55fa744447de13852add944e3b413f6f71307/crc_pulp_npm_client-20251030.1.tar.gz",
"platform": null,
"description": "# AsyncOperationResponse\n\nSerializer for asynchronous operations.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**task** | **str** | The href of the task. | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of AsyncOperationResponse from a JSON string\nasync_operation_response_instance = AsyncOperationResponse.from_json(json)\n# print the JSON string representation of the object\nprint(AsyncOperationResponse.to_json())\n\n# convert the object into a dict\nasync_operation_response_dict = async_operation_response_instance.to_dict()\n# create an instance of AsyncOperationResponse from a dict\nasync_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# pulpcore.client.pulp_npm.ContentPackagesApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**create**](ContentPackagesApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/content/npm/packages/ | Create a package\n[**list**](ContentPackagesApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/content/npm/packages/ | List packages\n[**read**](ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package\n[**set_label**](ContentPackagesApi.md#set_label) | **POST** {npm_package_href}set_label/ | Set a label\n[**unset_label**](ContentPackagesApi.md#unset_label) | **POST** {npm_package_href}unset_label/ | Unset a label\n\n\n# **create**\n> NpmPackageResponse create(pulp_domain, relative_path, name, version, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url)\n\nCreate a package\n\nPerform bookkeeping when saving Content. \\\"Artifacts\\\" need to be popped off and saved independently, as they are not actually part of the Content model.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n relative_path = 'relative_path_example' # str | \n name = 'name_example' # str | \n version = 'version_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n repository = 'repository_example' # str | A URI of a repository the new content unit should be associated with. (optional)\n pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)\n artifact = 'artifact_example' # str | Artifact file representing the physical content (optional)\n file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)\n upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)\n file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)\n\n try:\n # Create a package\n api_response = api_instance.create(pulp_domain, relative_path, name, version, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url)\n print(\"The response of ContentPackagesApi->create:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentPackagesApi->create: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **relative_path** | **str**| | \n **name** | **str**| | \n **version** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **repository** | **str**| A URI of a repository the new content unit should be associated with. | [optional] \n **pulp_labels** | [**Dict[str, Optional[str]]**](Dict.md)| A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] \n **artifact** | **str**| Artifact file representing the physical content | [optional] \n **file** | **bytearray**| An uploaded file that may be turned into the content unit. | [optional] \n **upload** | **str**| An uncommitted upload that may be turned into the content unit. | [optional] \n **file_url** | **str**| A url that Pulp can download and turn into the content unit. | [optional] \n\n### Return type\n\n[**NpmPackageResponse**](NpmPackageResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **list**\n> PaginatednpmPackageResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__in=name__in, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)\n\nList packages\n\nA ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.paginatednpm_package_response_list import PaginatednpmPackageResponseList\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n limit = 56 # int | Number of results to return per page. (optional)\n name = 'name_example' # str | Filter results where name matches value (optional)\n name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)\n offset = 56 # int | The initial index from which to return the results. (optional)\n ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)\n orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)\n prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)\n q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)\n repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)\n repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)\n repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List packages\n api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__in=name__in, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of ContentPackagesApi->list:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentPackagesApi->list: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **limit** | **int**| Number of results to return per page. | [optional] \n **name** | **str**| Filter results where name matches value | [optional] \n **name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional] \n **offset** | **int**| The initial index from which to return the results. | [optional] \n **ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] \n **orphaned_for** | **float**| Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] \n **prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_label_select** | **str**| Filter labels by search string | [optional] \n **q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional] \n **repository_version** | **str**| Repository Version referenced by HREF/PRN | [optional] \n **repository_version_added** | **str**| Repository Version referenced by HREF/PRN | [optional] \n **repository_version_removed** | **str**| Repository Version referenced by HREF/PRN | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**PaginatednpmPackageResponseList**](PaginatednpmPackageResponseList.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **read**\n> NpmPackageResponse read(npm_package_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nInspect a package\n\nA ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)\n npm_package_href = 'npm_package_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # Inspect a package\n api_response = api_instance.read(npm_package_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of ContentPackagesApi->read:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentPackagesApi->read: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_package_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**NpmPackageResponse**](NpmPackageResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **set_label**\n> SetLabelResponse set_label(npm_package_href, set_label, x_task_diagnostics=x_task_diagnostics)\n\nSet a label\n\nSet a single pulp_label on the object to a specific value or null.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.set_label import SetLabel\nfrom pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)\n npm_package_href = 'npm_package_href_example' # str | \n set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Set a label\n api_response = api_instance.set_label(npm_package_href, set_label, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of ContentPackagesApi->set_label:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentPackagesApi->set_label: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_package_href** | **str**| | \n **set_label** | [**SetLabel**](SetLabel.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**SetLabelResponse**](SetLabelResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **unset_label**\n> UnsetLabelResponse unset_label(npm_package_href, unset_label, x_task_diagnostics=x_task_diagnostics)\n\nUnset a label\n\nUnset a single pulp_label on the object.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.unset_label import UnsetLabel\nfrom pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)\n npm_package_href = 'npm_package_href_example' # str | \n unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Unset a label\n api_response = api_instance.unset_label(npm_package_href, unset_label, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of ContentPackagesApi->unset_label:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling ContentPackagesApi->unset_label: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_package_href** | **str**| | \n **unset_label** | [**UnsetLabel**](UnsetLabel.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**UnsetLabelResponse**](UnsetLabelResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# ContentSummaryResponse\n\nSerializer for the RepositoryVersion content summary\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**added** | **Dict[str, object]** | | \n**removed** | **Dict[str, object]** | | \n**present** | **Dict[str, object]** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.content_summary_response import ContentSummaryResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of ContentSummaryResponse from a JSON string\ncontent_summary_response_instance = ContentSummaryResponse.from_json(json)\n# print the JSON string representation of the object\nprint(ContentSummaryResponse.to_json())\n\n# convert the object into a dict\ncontent_summary_response_dict = content_summary_response_instance.to_dict()\n# create an instance of ContentSummaryResponse from a dict\ncontent_summary_response_from_dict = ContentSummaryResponse.from_dict(content_summary_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# pulpcore.client.pulp_npm.DistributionsNpmApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**create**](DistributionsNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/distributions/npm/npm/ | Create a npm distribution\n[**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution\n[**list**](DistributionsNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/distributions/npm/npm/ | List npm distributions\n[**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution\n[**read**](DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution\n[**set_label**](DistributionsNpmApi.md#set_label) | **POST** {npm_npm_distribution_href}set_label/ | Set a label\n[**unset_label**](DistributionsNpmApi.md#unset_label) | **POST** {npm_npm_distribution_href}unset_label/ | Unset a label\n[**update**](DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution\n\n\n# **create**\n> AsyncOperationResponse create(pulp_domain, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)\n\nCreate a npm distribution\n\nTrigger an asynchronous create task\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n npm_npm_distribution = pulpcore.client.pulp_npm.NpmNpmDistribution() # NpmNpmDistribution | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Create a npm distribution\n api_response = api_instance.create(pulp_domain, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of DistributionsNpmApi->create:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling DistributionsNpmApi->create: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **delete**\n> AsyncOperationResponse delete(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics)\n\nDelete a npm distribution\n\nTrigger an asynchronous delete task\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)\n npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Delete a npm distribution\n api_response = api_instance.delete(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of DistributionsNpmApi->delete:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling DistributionsNpmApi->delete: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_distribution_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **list**\n> PaginatednpmNpmDistributionResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)\n\nList npm distributions\n\nViewSet for NPM Distributions.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.paginatednpm_npm_distribution_response_list import PaginatednpmNpmDistributionResponseList\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n base_path = 'base_path_example' # str | Filter results where base_path matches value (optional)\n base_path__contains = 'base_path__contains_example' # str | Filter results where base_path contains value (optional)\n base_path__icontains = 'base_path__icontains_example' # str | Filter results where base_path contains value (optional)\n base_path__in = ['base_path__in_example'] # List[str] | Filter results where base_path is in a comma-separated list of values (optional)\n checkpoint = True # bool | Filter results where checkpoint matches value (optional)\n limit = 56 # int | Number of results to return per page. (optional)\n name = 'name_example' # str | Filter results where name matches value (optional)\n name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)\n name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)\n name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)\n name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)\n name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)\n name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)\n name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)\n name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)\n offset = 56 # int | The initial index from which to return the results. (optional)\n ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)\n prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)\n q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)\n repository = 'repository_example' # str | Filter results where repository matches value (optional)\n repository__in = ['repository__in_example'] # List[str] | Filter results where repository is in a comma-separated list of values (optional)\n with_content = 'with_content_example' # str | Filter distributions based on the content served by them (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List npm distributions\n api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of DistributionsNpmApi->list:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling DistributionsNpmApi->list: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **base_path** | **str**| Filter results where base_path matches value | [optional] \n **base_path__contains** | **str**| Filter results where base_path contains value | [optional] \n **base_path__icontains** | **str**| Filter results where base_path contains value | [optional] \n **base_path__in** | [**List[str]**](str.md)| Filter results where base_path is in a comma-separated list of values | [optional] \n **checkpoint** | **bool**| Filter results where checkpoint matches value | [optional] \n **limit** | **int**| Number of results to return per page. | [optional] \n **name** | **str**| Filter results where name matches value | [optional] \n **name__contains** | **str**| Filter results where name contains value | [optional] \n **name__icontains** | **str**| Filter results where name contains value | [optional] \n **name__iexact** | **str**| Filter results where name matches value | [optional] \n **name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional] \n **name__iregex** | **str**| Filter results where name matches regex value | [optional] \n **name__istartswith** | **str**| Filter results where name starts with value | [optional] \n **name__regex** | **str**| Filter results where name matches regex value | [optional] \n **name__startswith** | **str**| Filter results where name starts with value | [optional] \n **offset** | **int**| The initial index from which to return the results. | [optional] \n **ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] \n **prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_label_select** | **str**| Filter labels by search string | [optional] \n **q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional] \n **repository** | **str**| Filter results where repository matches value | [optional] \n **repository__in** | [**List[str]**](str.md)| Filter results where repository is in a comma-separated list of values | [optional] \n **with_content** | **str**| Filter distributions based on the content served by them | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**PaginatednpmNpmDistributionResponseList**](PaginatednpmNpmDistributionResponseList.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **partial_update**\n> NpmNpmDistributionResponse partial_update(npm_npm_distribution_href, patchednpm_npm_distribution, x_task_diagnostics=x_task_diagnostics)\n\nUpdate a npm distribution\n\nUpdate the entity partially and trigger an asynchronous task if necessary\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse\nfrom pulpcore.client.pulp_npm.models.patchednpm_npm_distribution import PatchednpmNpmDistribution\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)\n npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str | \n patchednpm_npm_distribution = pulpcore.client.pulp_npm.PatchednpmNpmDistribution() # PatchednpmNpmDistribution | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Update a npm distribution\n api_response = api_instance.partial_update(npm_npm_distribution_href, patchednpm_npm_distribution, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of DistributionsNpmApi->partial_update:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling DistributionsNpmApi->partial_update: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_distribution_href** | **str**| | \n **patchednpm_npm_distribution** | [**PatchednpmNpmDistribution**](PatchednpmNpmDistribution.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **read**\n> NpmNpmDistributionResponse read(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nInspect a npm distribution\n\nViewSet for NPM Distributions.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)\n npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # Inspect a npm distribution\n api_response = api_instance.read(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of DistributionsNpmApi->read:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling DistributionsNpmApi->read: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_distribution_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **set_label**\n> SetLabelResponse set_label(npm_npm_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)\n\nSet a label\n\nSet a single pulp_label on the object to a specific value or null.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.set_label import SetLabel\nfrom pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)\n npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str | \n set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Set a label\n api_response = api_instance.set_label(npm_npm_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of DistributionsNpmApi->set_label:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling DistributionsNpmApi->set_label: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_distribution_href** | **str**| | \n **set_label** | [**SetLabel**](SetLabel.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**SetLabelResponse**](SetLabelResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **unset_label**\n> UnsetLabelResponse unset_label(npm_npm_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)\n\nUnset a label\n\nUnset a single pulp_label on the object.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.unset_label import UnsetLabel\nfrom pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)\n npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str | \n unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Unset a label\n api_response = api_instance.unset_label(npm_npm_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of DistributionsNpmApi->unset_label:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling DistributionsNpmApi->unset_label: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_distribution_href** | **str**| | \n **unset_label** | [**UnsetLabel**](UnsetLabel.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**UnsetLabelResponse**](UnsetLabelResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **update**\n> NpmNpmDistributionResponse update(npm_npm_distribution_href, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)\n\nUpdate a npm distribution\n\nUpdate the entity and trigger an asynchronous task if necessary\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution\nfrom pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)\n npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str | \n npm_npm_distribution = pulpcore.client.pulp_npm.NpmNpmDistribution() # NpmNpmDistribution | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Update a npm distribution\n api_response = api_instance.update(npm_npm_distribution_href, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of DistributionsNpmApi->update:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling DistributionsNpmApi->update: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_distribution_href** | **str**| | \n **npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# NpmNpmDistribution\n\nSerializer for NPM Distributions.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**base_path** | **str** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \\"foo\\" and \\"foo/bar\\") | \n**content_guard** | **str** | An optional content-guard. | [optional] \n**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]\n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**name** | **str** | A unique name. Ex, `rawhide` and `stable`. | \n**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional] \n**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NpmNpmDistribution from a JSON string\nnpm_npm_distribution_instance = NpmNpmDistribution.from_json(json)\n# print the JSON string representation of the object\nprint(NpmNpmDistribution.to_json())\n\n# convert the object into a dict\nnpm_npm_distribution_dict = npm_npm_distribution_instance.to_dict()\n# create an instance of NpmNpmDistribution from a dict\nnpm_npm_distribution_from_dict = NpmNpmDistribution.from_dict(npm_npm_distribution_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NpmNpmDistributionResponse\n\nSerializer for NPM Distributions.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] \n**base_path** | **str** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \\"foo\\" and \\"foo/bar\\") | \n**base_url** | **str** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly] \n**content_guard** | **str** | An optional content-guard. | [optional] \n**no_content_change_since** | **str** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional] [readonly] \n**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]\n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**name** | **str** | A unique name. Ex, `rawhide` and `stable`. | \n**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional] \n**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NpmNpmDistributionResponse from a JSON string\nnpm_npm_distribution_response_instance = NpmNpmDistributionResponse.from_json(json)\n# print the JSON string representation of the object\nprint(NpmNpmDistributionResponse.to_json())\n\n# convert the object into a dict\nnpm_npm_distribution_response_dict = npm_npm_distribution_response_instance.to_dict()\n# create an instance of NpmNpmDistributionResponse from a dict\nnpm_npm_distribution_response_from_dict = NpmNpmDistributionResponse.from_dict(npm_npm_distribution_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NpmNpmRemote\n\nA Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**name** | **str** | A unique name for this remote. | \n**url** | **str** | The URL of an external content source. | \n**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] \n**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional] \n**client_key** | **str** | A PEM encoded private key used for authentication. | [optional] \n**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional] \n**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional] \n**proxy_username** | **str** | The username to authenticte to the proxy. | [optional] \n**proxy_password** | **str** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] \n**username** | **str** | The username to be used for authentication when syncing. | [optional] \n**password** | **str** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] \n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] \n**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] \n**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] \n**total_timeout** | **float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**connect_timeout** | **float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**sock_connect_timeout** | **float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**sock_read_timeout** | **float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional] \n**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NpmNpmRemote from a JSON string\nnpm_npm_remote_instance = NpmNpmRemote.from_json(json)\n# print the JSON string representation of the object\nprint(NpmNpmRemote.to_json())\n\n# convert the object into a dict\nnpm_npm_remote_dict = npm_npm_remote_instance.to_dict()\n# create an instance of NpmNpmRemote from a dict\nnpm_npm_remote_from_dict = NpmNpmRemote.from_dict(npm_npm_remote_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NpmNpmRemoteResponseHiddenFieldsInner\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**name** | **str** | | \n**is_set** | **bool** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote_response_hidden_fields_inner import NpmNpmRemoteResponseHiddenFieldsInner\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NpmNpmRemoteResponseHiddenFieldsInner from a JSON string\nnpm_npm_remote_response_hidden_fields_inner_instance = NpmNpmRemoteResponseHiddenFieldsInner.from_json(json)\n# print the JSON string representation of the object\nprint(NpmNpmRemoteResponseHiddenFieldsInner.to_json())\n\n# convert the object into a dict\nnpm_npm_remote_response_hidden_fields_inner_dict = npm_npm_remote_response_hidden_fields_inner_instance.to_dict()\n# create an instance of NpmNpmRemoteResponseHiddenFieldsInner from a dict\nnpm_npm_remote_response_hidden_fields_inner_from_dict = NpmNpmRemoteResponseHiddenFieldsInner.from_dict(npm_npm_remote_response_hidden_fields_inner_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NpmNpmRemoteResponse\n\nA Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**pulp_last_updated** | **datetime** | Timestamp of the most recent update of the remote. | [optional] [readonly] \n**name** | **str** | A unique name for this remote. | \n**url** | **str** | The URL of an external content source. | \n**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] \n**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional] \n**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional] \n**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional] \n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] \n**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] \n**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] \n**total_timeout** | **float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**connect_timeout** | **float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**sock_connect_timeout** | **float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**sock_read_timeout** | **float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional] \n**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional] \n**hidden_fields** | [**List[NpmNpmRemoteResponseHiddenFieldsInner]**](NpmNpmRemoteResponseHiddenFieldsInner.md) | List of hidden (write only) fields | [optional] [readonly] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NpmNpmRemoteResponse from a JSON string\nnpm_npm_remote_response_instance = NpmNpmRemoteResponse.from_json(json)\n# print the JSON string representation of the object\nprint(NpmNpmRemoteResponse.to_json())\n\n# convert the object into a dict\nnpm_npm_remote_response_dict = npm_npm_remote_response_instance.to_dict()\n# create an instance of NpmNpmRemoteResponse from a dict\nnpm_npm_remote_response_from_dict = NpmNpmRemoteResponse.from_dict(npm_npm_remote_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NpmNpmRepository\n\nA Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**name** | **str** | A unique name for this repository. | \n**description** | **str** | An optional description. | [optional] \n**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional] \n**remote** | **str** | An optional remote to use by default when syncing. | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NpmNpmRepository from a JSON string\nnpm_npm_repository_instance = NpmNpmRepository.from_json(json)\n# print the JSON string representation of the object\nprint(NpmNpmRepository.to_json())\n\n# convert the object into a dict\nnpm_npm_repository_dict = npm_npm_repository_instance.to_dict()\n# create an instance of NpmNpmRepository from a dict\nnpm_npm_repository_from_dict = NpmNpmRepository.from_dict(npm_npm_repository_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NpmNpmRepositoryResponse\n\nA Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] \n**versions_href** | **str** | | [optional] [readonly] \n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**latest_version_href** | **str** | | [optional] [readonly] \n**name** | **str** | A unique name for this repository. | \n**description** | **str** | An optional description. | [optional] \n**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional] \n**remote** | **str** | An optional remote to use by default when syncing. | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NpmNpmRepositoryResponse from a JSON string\nnpm_npm_repository_response_instance = NpmNpmRepositoryResponse.from_json(json)\n# print the JSON string representation of the object\nprint(NpmNpmRepositoryResponse.to_json())\n\n# convert the object into a dict\nnpm_npm_repository_response_dict = npm_npm_repository_response_instance.to_dict()\n# create an instance of NpmNpmRepositoryResponse from a dict\nnpm_npm_repository_response_from_dict = NpmNpmRepositoryResponse.from_dict(npm_npm_repository_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# NpmPackageResponse\n\nA Serializer for Package. Add serializers for the new fields defined in Package and add those fields to the Meta class keeping fields from the parent class as well. For example:: field1 = serializers.TextField() field2 = serializers.IntegerField() field3 = serializers.CharField() class Meta: fields = core_serializers.SingleArtifactContentSerializer.Meta.fields + ( 'field1', 'field2', 'field3' ) model = models.Package\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] \n**pulp_labels** | **Dict[str, Optional[str]]** | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] \n**vuln_report** | **str** | | [optional] [readonly] \n**artifact** | **str** | Artifact file representing the physical content | [optional] \n**relative_path** | **str** | | \n**name** | **str** | | \n**version** | **str** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of NpmPackageResponse from a JSON string\nnpm_package_response_instance = NpmPackageResponse.from_json(json)\n# print the JSON string representation of the object\nprint(NpmPackageResponse.to_json())\n\n# convert the object into a dict\nnpm_package_response_dict = npm_package_response_instance.to_dict()\n# create an instance of NpmPackageResponse from a dict\nnpm_package_response_from_dict = NpmPackageResponse.from_dict(npm_package_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PaginatednpmNpmDistributionResponseList\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**count** | **int** | | \n**next** | **str** | | [optional] \n**previous** | **str** | | [optional] \n**results** | [**List[NpmNpmDistributionResponse]**](NpmNpmDistributionResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.paginatednpm_npm_distribution_response_list import PaginatednpmNpmDistributionResponseList\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PaginatednpmNpmDistributionResponseList from a JSON string\npaginatednpm_npm_distribution_response_list_instance = PaginatednpmNpmDistributionResponseList.from_json(json)\n# print the JSON string representation of the object\nprint(PaginatednpmNpmDistributionResponseList.to_json())\n\n# convert the object into a dict\npaginatednpm_npm_distribution_response_list_dict = paginatednpm_npm_distribution_response_list_instance.to_dict()\n# create an instance of PaginatednpmNpmDistributionResponseList from a dict\npaginatednpm_npm_distribution_response_list_from_dict = PaginatednpmNpmDistributionResponseList.from_dict(paginatednpm_npm_distribution_response_list_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PaginatednpmNpmRemoteResponseList\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**count** | **int** | | \n**next** | **str** | | [optional] \n**previous** | **str** | | [optional] \n**results** | [**List[NpmNpmRemoteResponse]**](NpmNpmRemoteResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.paginatednpm_npm_remote_response_list import PaginatednpmNpmRemoteResponseList\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PaginatednpmNpmRemoteResponseList from a JSON string\npaginatednpm_npm_remote_response_list_instance = PaginatednpmNpmRemoteResponseList.from_json(json)\n# print the JSON string representation of the object\nprint(PaginatednpmNpmRemoteResponseList.to_json())\n\n# convert the object into a dict\npaginatednpm_npm_remote_response_list_dict = paginatednpm_npm_remote_response_list_instance.to_dict()\n# create an instance of PaginatednpmNpmRemoteResponseList from a dict\npaginatednpm_npm_remote_response_list_from_dict = PaginatednpmNpmRemoteResponseList.from_dict(paginatednpm_npm_remote_response_list_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PaginatednpmNpmRepositoryResponseList\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**count** | **int** | | \n**next** | **str** | | [optional] \n**previous** | **str** | | [optional] \n**results** | [**List[NpmNpmRepositoryResponse]**](NpmNpmRepositoryResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.paginatednpm_npm_repository_response_list import PaginatednpmNpmRepositoryResponseList\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PaginatednpmNpmRepositoryResponseList from a JSON string\npaginatednpm_npm_repository_response_list_instance = PaginatednpmNpmRepositoryResponseList.from_json(json)\n# print the JSON string representation of the object\nprint(PaginatednpmNpmRepositoryResponseList.to_json())\n\n# convert the object into a dict\npaginatednpm_npm_repository_response_list_dict = paginatednpm_npm_repository_response_list_instance.to_dict()\n# create an instance of PaginatednpmNpmRepositoryResponseList from a dict\npaginatednpm_npm_repository_response_list_from_dict = PaginatednpmNpmRepositoryResponseList.from_dict(paginatednpm_npm_repository_response_list_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PaginatednpmPackageResponseList\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**count** | **int** | | \n**next** | **str** | | [optional] \n**previous** | **str** | | [optional] \n**results** | [**List[NpmPackageResponse]**](NpmPackageResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.paginatednpm_package_response_list import PaginatednpmPackageResponseList\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PaginatednpmPackageResponseList from a JSON string\npaginatednpm_package_response_list_instance = PaginatednpmPackageResponseList.from_json(json)\n# print the JSON string representation of the object\nprint(PaginatednpmPackageResponseList.to_json())\n\n# convert the object into a dict\npaginatednpm_package_response_list_dict = paginatednpm_package_response_list_instance.to_dict()\n# create an instance of PaginatednpmPackageResponseList from a dict\npaginatednpm_package_response_list_from_dict = PaginatednpmPackageResponseList.from_dict(paginatednpm_package_response_list_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PaginatedRepositoryVersionResponseList\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**count** | **int** | | \n**next** | **str** | | [optional] \n**previous** | **str** | | [optional] \n**results** | [**List[RepositoryVersionResponse]**](RepositoryVersionResponse.md) | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PaginatedRepositoryVersionResponseList from a JSON string\npaginated_repository_version_response_list_instance = PaginatedRepositoryVersionResponseList.from_json(json)\n# print the JSON string representation of the object\nprint(PaginatedRepositoryVersionResponseList.to_json())\n\n# convert the object into a dict\npaginated_repository_version_response_list_dict = paginated_repository_version_response_list_instance.to_dict()\n# create an instance of PaginatedRepositoryVersionResponseList from a dict\npaginated_repository_version_response_list_from_dict = PaginatedRepositoryVersionResponseList.from_dict(paginated_repository_version_response_list_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PatchednpmNpmDistribution\n\nSerializer for NPM Distributions.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**base_path** | **str** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \\"foo\\" and \\"foo/bar\\") | [optional] \n**content_guard** | **str** | An optional content-guard. | [optional] \n**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]\n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**name** | **str** | A unique name. Ex, `rawhide` and `stable`. | [optional] \n**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional] \n**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.patchednpm_npm_distribution import PatchednpmNpmDistribution\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PatchednpmNpmDistribution from a JSON string\npatchednpm_npm_distribution_instance = PatchednpmNpmDistribution.from_json(json)\n# print the JSON string representation of the object\nprint(PatchednpmNpmDistribution.to_json())\n\n# convert the object into a dict\npatchednpm_npm_distribution_dict = patchednpm_npm_distribution_instance.to_dict()\n# create an instance of PatchednpmNpmDistribution from a dict\npatchednpm_npm_distribution_from_dict = PatchednpmNpmDistribution.from_dict(patchednpm_npm_distribution_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PatchednpmNpmRemote\n\nA Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**name** | **str** | A unique name for this remote. | [optional] \n**url** | **str** | The URL of an external content source. | [optional] \n**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] \n**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional] \n**client_key** | **str** | A PEM encoded private key used for authentication. | [optional] \n**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional] \n**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional] \n**proxy_username** | **str** | The username to authenticte to the proxy. | [optional] \n**proxy_password** | **str** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] \n**username** | **str** | The username to be used for authentication when syncing. | [optional] \n**password** | **str** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] \n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] \n**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] \n**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] \n**total_timeout** | **float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**connect_timeout** | **float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**sock_connect_timeout** | **float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**sock_read_timeout** | **float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] \n**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional] \n**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.patchednpm_npm_remote import PatchednpmNpmRemote\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PatchednpmNpmRemote from a JSON string\npatchednpm_npm_remote_instance = PatchednpmNpmRemote.from_json(json)\n# print the JSON string representation of the object\nprint(PatchednpmNpmRemote.to_json())\n\n# convert the object into a dict\npatchednpm_npm_remote_dict = patchednpm_npm_remote_instance.to_dict()\n# create an instance of PatchednpmNpmRemote from a dict\npatchednpm_npm_remote_from_dict = PatchednpmNpmRemote.from_dict(patchednpm_npm_remote_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PatchednpmNpmRepository\n\nA Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_labels** | **Dict[str, Optional[str]]** | | [optional] \n**name** | **str** | A unique name for this repository. | [optional] \n**description** | **str** | An optional description. | [optional] \n**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional] \n**remote** | **str** | An optional remote to use by default when syncing. | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.patchednpm_npm_repository import PatchednpmNpmRepository\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of PatchednpmNpmRepository from a JSON string\npatchednpm_npm_repository_instance = PatchednpmNpmRepository.from_json(json)\n# print the JSON string representation of the object\nprint(PatchednpmNpmRepository.to_json())\n\n# convert the object into a dict\npatchednpm_npm_repository_dict = patchednpm_npm_repository_instance.to_dict()\n# create an instance of PatchednpmNpmRepository from a dict\npatchednpm_npm_repository_from_dict = PatchednpmNpmRepository.from_dict(patchednpm_npm_repository_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# PolicyEnum\n\n* `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.\n\n## Enum\n\n* `IMMEDIATE` (value: `'immediate'`)\n\n* `ON_DEMAND` (value: `'on_demand'`)\n\n* `STREAMED` (value: `'streamed'`)\n\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# pulpcore.client.pulp_npm.RemotesNpmApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**create**](RemotesNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/remotes/npm/npm/ | Create a npm remote\n[**delete**](RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote\n[**list**](RemotesNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/remotes/npm/npm/ | List npm remotes\n[**partial_update**](RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote\n[**read**](RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote\n[**set_label**](RemotesNpmApi.md#set_label) | **POST** {npm_npm_remote_href}set_label/ | Set a label\n[**unset_label**](RemotesNpmApi.md#unset_label) | **POST** {npm_npm_remote_href}unset_label/ | Unset a label\n[**update**](RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote\n\n\n# **create**\n> NpmNpmRemoteResponse create(pulp_domain, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)\n\nCreate a npm remote\n\nA ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n npm_npm_remote = pulpcore.client.pulp_npm.NpmNpmRemote() # NpmNpmRemote | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Create a npm remote\n api_response = api_instance.create(pulp_domain, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RemotesNpmApi->create:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RemotesNpmApi->create: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **delete**\n> AsyncOperationResponse delete(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics)\n\nDelete a npm remote\n\nTrigger an asynchronous delete task\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)\n npm_npm_remote_href = 'npm_npm_remote_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Delete a npm remote\n api_response = api_instance.delete(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RemotesNpmApi->delete:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RemotesNpmApi->delete: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_remote_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **list**\n> PaginatednpmNpmRemoteResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)\n\nList npm remotes\n\nA ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.paginatednpm_npm_remote_response_list import PaginatednpmNpmRemoteResponseList\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n limit = 56 # int | Number of results to return per page. (optional)\n name = 'name_example' # str | Filter results where name matches value (optional)\n name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)\n name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)\n name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)\n name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)\n name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)\n name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)\n name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)\n name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)\n offset = 56 # int | The initial index from which to return the results. (optional)\n ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)\n prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)\n pulp_last_updated = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated matches value (optional)\n pulp_last_updated__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than value (optional)\n pulp_last_updated__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than or equal to value (optional)\n pulp_last_updated__isnull = True # bool | Filter results where pulp_last_updated has a null value (optional)\n pulp_last_updated__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than value (optional)\n pulp_last_updated__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than or equal to value (optional)\n pulp_last_updated__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_last_updated is between two comma separated values (optional)\n q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List npm remotes\n api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of RemotesNpmApi->list:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RemotesNpmApi->list: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **limit** | **int**| Number of results to return per page. | [optional] \n **name** | **str**| Filter results where name matches value | [optional] \n **name__contains** | **str**| Filter results where name contains value | [optional] \n **name__icontains** | **str**| Filter results where name contains value | [optional] \n **name__iexact** | **str**| Filter results where name matches value | [optional] \n **name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional] \n **name__iregex** | **str**| Filter results where name matches regex value | [optional] \n **name__istartswith** | **str**| Filter results where name starts with value | [optional] \n **name__regex** | **str**| Filter results where name matches regex value | [optional] \n **name__startswith** | **str**| Filter results where name starts with value | [optional] \n **offset** | **int**| The initial index from which to return the results. | [optional] \n **ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] \n **prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_label_select** | **str**| Filter labels by search string | [optional] \n **pulp_last_updated** | **datetime**| Filter results where pulp_last_updated matches value | [optional] \n **pulp_last_updated__gt** | **datetime**| Filter results where pulp_last_updated is greater than value | [optional] \n **pulp_last_updated__gte** | **datetime**| Filter results where pulp_last_updated is greater than or equal to value | [optional] \n **pulp_last_updated__isnull** | **bool**| Filter results where pulp_last_updated has a null value | [optional] \n **pulp_last_updated__lt** | **datetime**| Filter results where pulp_last_updated is less than value | [optional] \n **pulp_last_updated__lte** | **datetime**| Filter results where pulp_last_updated is less than or equal to value | [optional] \n **pulp_last_updated__range** | [**List[datetime]**](datetime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional] \n **q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**PaginatednpmNpmRemoteResponseList**](PaginatednpmNpmRemoteResponseList.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **partial_update**\n> NpmNpmRemoteResponse partial_update(npm_npm_remote_href, patchednpm_npm_remote, x_task_diagnostics=x_task_diagnostics)\n\nUpdate a npm remote\n\nUpdate the entity partially and trigger an asynchronous task if necessary\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse\nfrom pulpcore.client.pulp_npm.models.patchednpm_npm_remote import PatchednpmNpmRemote\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)\n npm_npm_remote_href = 'npm_npm_remote_href_example' # str | \n patchednpm_npm_remote = pulpcore.client.pulp_npm.PatchednpmNpmRemote() # PatchednpmNpmRemote | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Update a npm remote\n api_response = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RemotesNpmApi->partial_update:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RemotesNpmApi->partial_update: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_remote_href** | **str**| | \n **patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **read**\n> NpmNpmRemoteResponse read(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nInspect a npm remote\n\nA ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)\n npm_npm_remote_href = 'npm_npm_remote_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # Inspect a npm remote\n api_response = api_instance.read(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of RemotesNpmApi->read:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RemotesNpmApi->read: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_remote_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **set_label**\n> SetLabelResponse set_label(npm_npm_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)\n\nSet a label\n\nSet a single pulp_label on the object to a specific value or null.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.set_label import SetLabel\nfrom pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)\n npm_npm_remote_href = 'npm_npm_remote_href_example' # str | \n set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Set a label\n api_response = api_instance.set_label(npm_npm_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RemotesNpmApi->set_label:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RemotesNpmApi->set_label: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_remote_href** | **str**| | \n **set_label** | [**SetLabel**](SetLabel.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**SetLabelResponse**](SetLabelResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **unset_label**\n> UnsetLabelResponse unset_label(npm_npm_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)\n\nUnset a label\n\nUnset a single pulp_label on the object.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.unset_label import UnsetLabel\nfrom pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)\n npm_npm_remote_href = 'npm_npm_remote_href_example' # str | \n unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Unset a label\n api_response = api_instance.unset_label(npm_npm_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RemotesNpmApi->unset_label:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RemotesNpmApi->unset_label: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_remote_href** | **str**| | \n **unset_label** | [**UnsetLabel**](UnsetLabel.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**UnsetLabelResponse**](UnsetLabelResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **update**\n> NpmNpmRemoteResponse update(npm_npm_remote_href, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)\n\nUpdate a npm remote\n\nUpdate the entity and trigger an asynchronous task if necessary\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote\nfrom pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)\n npm_npm_remote_href = 'npm_npm_remote_href_example' # str | \n npm_npm_remote = pulpcore.client.pulp_npm.NpmNpmRemote() # NpmNpmRemote | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Update a npm remote\n api_response = api_instance.update(npm_npm_remote_href, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RemotesNpmApi->update:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RemotesNpmApi->update: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_remote_href** | **str**| | \n **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# Repair\n\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**verify_checksums** | **bool** | Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default | [optional] [default to True]\n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.repair import Repair\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of Repair from a JSON string\nrepair_instance = Repair.from_json(json)\n# print the JSON string representation of the object\nprint(Repair.to_json())\n\n# convert the object into a dict\nrepair_dict = repair_instance.to_dict()\n# create an instance of Repair from a dict\nrepair_from_dict = Repair.from_dict(repair_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# pulpcore.client.pulp_npm.RepositoriesNpmApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**create**](RepositoriesNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/repositories/npm/npm/ | Create a npm repository\n[**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository\n[**list**](RepositoriesNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/repositories/npm/npm/ | List npm repositorys\n[**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content\n[**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository\n[**read**](RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository\n[**set_label**](RepositoriesNpmApi.md#set_label) | **POST** {npm_npm_repository_href}set_label/ | Set a label\n[**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote\n[**unset_label**](RepositoriesNpmApi.md#unset_label) | **POST** {npm_npm_repository_href}unset_label/ | Unset a label\n[**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository\n\n\n# **create**\n> NpmNpmRepositoryResponse create(pulp_domain, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)\n\nCreate a npm repository\n\nA ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository\nfrom pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n npm_npm_repository = pulpcore.client.pulp_npm.NpmNpmRepository() # NpmNpmRepository | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Create a npm repository\n api_response = api_instance.create(pulp_domain, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmApi->create:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->create: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **delete**\n> AsyncOperationResponse delete(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics)\n\nDelete a npm repository\n\nTrigger an asynchronous delete task\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Delete a npm repository\n api_response = api_instance.delete(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmApi->delete:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->delete: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **list**\n> PaginatednpmNpmRepositoryResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)\n\nList npm repositorys\n\nA ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.paginatednpm_npm_repository_response_list import PaginatednpmNpmRepositoryResponseList\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n pulp_domain = 'pulp_domain_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n latest_with_content = 'latest_with_content_example' # str | Content Unit referenced by HREF/PRN (optional)\n limit = 56 # int | Number of results to return per page. (optional)\n name = 'name_example' # str | Filter results where name matches value (optional)\n name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)\n name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)\n name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)\n name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)\n name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)\n name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)\n name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)\n name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)\n offset = 56 # int | The initial index from which to return the results. (optional)\n ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)\n prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)\n q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)\n remote = 'remote_example' # str | Foreign Key referenced by HREF (optional)\n retain_repo_versions = 56 # int | Filter results where retain_repo_versions matches value (optional)\n retain_repo_versions__gt = 56 # int | Filter results where retain_repo_versions is greater than value (optional)\n retain_repo_versions__gte = 56 # int | Filter results where retain_repo_versions is greater than or equal to value (optional)\n retain_repo_versions__isnull = True # bool | Filter results where retain_repo_versions has a null value (optional)\n retain_repo_versions__lt = 56 # int | Filter results where retain_repo_versions is less than value (optional)\n retain_repo_versions__lte = 56 # int | Filter results where retain_repo_versions is less than or equal to value (optional)\n retain_repo_versions__ne = 56 # int | Filter results where retain_repo_versions not equal to value (optional)\n retain_repo_versions__range = [56] # List[int] | Filter results where retain_repo_versions is between two comma separated values (optional)\n with_content = 'with_content_example' # str | Content Unit referenced by HREF/PRN (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List npm repositorys\n api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of RepositoriesNpmApi->list:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->list: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **pulp_domain** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **latest_with_content** | **str**| Content Unit referenced by HREF/PRN | [optional] \n **limit** | **int**| Number of results to return per page. | [optional] \n **name** | **str**| Filter results where name matches value | [optional] \n **name__contains** | **str**| Filter results where name contains value | [optional] \n **name__icontains** | **str**| Filter results where name contains value | [optional] \n **name__iexact** | **str**| Filter results where name matches value | [optional] \n **name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional] \n **name__iregex** | **str**| Filter results where name matches regex value | [optional] \n **name__istartswith** | **str**| Filter results where name starts with value | [optional] \n **name__regex** | **str**| Filter results where name matches regex value | [optional] \n **name__startswith** | **str**| Filter results where name starts with value | [optional] \n **offset** | **int**| The initial index from which to return the results. | [optional] \n **ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] \n **prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_label_select** | **str**| Filter labels by search string | [optional] \n **q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional] \n **remote** | **str**| Foreign Key referenced by HREF | [optional] \n **retain_repo_versions** | **int**| Filter results where retain_repo_versions matches value | [optional] \n **retain_repo_versions__gt** | **int**| Filter results where retain_repo_versions is greater than value | [optional] \n **retain_repo_versions__gte** | **int**| Filter results where retain_repo_versions is greater than or equal to value | [optional] \n **retain_repo_versions__isnull** | **bool**| Filter results where retain_repo_versions has a null value | [optional] \n **retain_repo_versions__lt** | **int**| Filter results where retain_repo_versions is less than value | [optional] \n **retain_repo_versions__lte** | **int**| Filter results where retain_repo_versions is less than or equal to value | [optional] \n **retain_repo_versions__ne** | **int**| Filter results where retain_repo_versions not equal to value | [optional] \n **retain_repo_versions__range** | [**List[int]**](int.md)| Filter results where retain_repo_versions is between two comma separated values | [optional] \n **with_content** | **str**| Content Unit referenced by HREF/PRN | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**PaginatednpmNpmRepositoryResponseList**](PaginatednpmNpmRepositoryResponseList.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **modify**\n> AsyncOperationResponse modify(npm_npm_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)\n\nModify Repository Content\n\nTrigger an asynchronous task to create a new repository version.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_npm.models.repository_add_remove_content import RepositoryAddRemoveContent\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n repository_add_remove_content = pulpcore.client.pulp_npm.RepositoryAddRemoveContent() # RepositoryAddRemoveContent | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Modify Repository Content\n api_response = api_instance.modify(npm_npm_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmApi->modify:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->modify: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **partial_update**\n> NpmNpmRepositoryResponse partial_update(npm_npm_repository_href, patchednpm_npm_repository, x_task_diagnostics=x_task_diagnostics)\n\nUpdate a npm repository\n\nUpdate the entity partially and trigger an asynchronous task if necessary\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse\nfrom pulpcore.client.pulp_npm.models.patchednpm_npm_repository import PatchednpmNpmRepository\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n patchednpm_npm_repository = pulpcore.client.pulp_npm.PatchednpmNpmRepository() # PatchednpmNpmRepository | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Update a npm repository\n api_response = api_instance.partial_update(npm_npm_repository_href, patchednpm_npm_repository, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmApi->partial_update:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->partial_update: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **patchednpm_npm_repository** | [**PatchednpmNpmRepository**](PatchednpmNpmRepository.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **read**\n> NpmNpmRepositoryResponse read(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nInspect a npm repository\n\nA ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # Inspect a npm repository\n api_response = api_instance.read(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of RepositoriesNpmApi->read:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->read: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **set_label**\n> SetLabelResponse set_label(npm_npm_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)\n\nSet a label\n\nSet a single pulp_label on the object to a specific value or null.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.set_label import SetLabel\nfrom pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Set a label\n api_response = api_instance.set_label(npm_npm_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmApi->set_label:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->set_label: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **set_label** | [**SetLabel**](SetLabel.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**SetLabelResponse**](SetLabelResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **sync**\n> AsyncOperationResponse sync(npm_npm_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)\n\nSync from remote\n\nTrigger an asynchronous task to sync content.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_npm.models.repository_sync_url import RepositorySyncURL\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n repository_sync_url = pulpcore.client.pulp_npm.RepositorySyncURL() # RepositorySyncURL | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Sync from remote\n api_response = api_instance.sync(npm_npm_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmApi->sync:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->sync: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **unset_label**\n> UnsetLabelResponse unset_label(npm_npm_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)\n\nUnset a label\n\nUnset a single pulp_label on the object.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.unset_label import UnsetLabel\nfrom pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Unset a label\n api_response = api_instance.unset_label(npm_npm_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmApi->unset_label:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->unset_label: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **unset_label** | [**UnsetLabel**](UnsetLabel.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**UnsetLabelResponse**](UnsetLabelResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**201** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **update**\n> NpmNpmRepositoryResponse update(npm_npm_repository_href, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)\n\nUpdate a npm repository\n\nUpdate the entity and trigger an asynchronous task if necessary\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository\nfrom pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n npm_npm_repository = pulpcore.client.pulp_npm.NpmNpmRepository() # NpmNpmRepository | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Update a npm repository\n api_response = api_instance.update(npm_npm_repository_href, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmApi->update:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmApi->update: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi\n\nAll URIs are relative to *https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n[**delete**](RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version\n[**list**](RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions\n[**read**](RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version\n[**repair**](RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ | \n\n\n# **delete**\n> AsyncOperationResponse delete(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics)\n\nDelete a repository version\n\nTrigger an asynchronous task to delete a repository version.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)\n npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n # Delete a repository version\n api_response = api_instance.delete(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmVersionsApi->delete:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmVersionsApi->delete: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_version_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **list**\n> PaginatedRepositoryVersionResponseList list(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)\n\nList repository versions\n\nA ViewSet for a NpmRepositoryVersion represents a single Npm repository version.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)\n npm_npm_repository_href = 'npm_npm_repository_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)\n content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n limit = 56 # int | Number of results to return per page. (optional)\n number = 56 # int | Filter results where number matches value (optional)\n number__gt = 56 # int | Filter results where number is greater than value (optional)\n number__gte = 56 # int | Filter results where number is greater than or equal to value (optional)\n number__lt = 56 # int | Filter results where number is less than value (optional)\n number__lte = 56 # int | Filter results where number is less than or equal to value (optional)\n number__range = [56] # List[int] | Filter results where number is between two comma separated values (optional)\n offset = 56 # int | The initial index from which to return the results. (optional)\n ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)\n prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)\n pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)\n pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)\n pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)\n pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)\n pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)\n pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)\n pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)\n q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # List repository versions\n api_response = api_instance.list(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of RepositoriesNpmVersionsApi->list:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmVersionsApi->list: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **content** | **str**| Content Unit referenced by HREF/PRN | [optional] \n **content__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **limit** | **int**| Number of results to return per page. | [optional] \n **number** | **int**| Filter results where number matches value | [optional] \n **number__gt** | **int**| Filter results where number is greater than value | [optional] \n **number__gte** | **int**| Filter results where number is greater than or equal to value | [optional] \n **number__lt** | **int**| Filter results where number is less than value | [optional] \n **number__lte** | **int**| Filter results where number is less than or equal to value | [optional] \n **number__range** | [**List[int]**](int.md)| Filter results where number is between two comma separated values | [optional] \n **offset** | **int**| The initial index from which to return the results. | [optional] \n **ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] \n **prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **pulp_created** | **datetime**| Filter results where pulp_created matches value | [optional] \n **pulp_created__gt** | **datetime**| Filter results where pulp_created is greater than value | [optional] \n **pulp_created__gte** | **datetime**| Filter results where pulp_created is greater than or equal to value | [optional] \n **pulp_created__isnull** | **bool**| Filter results where pulp_created has a null value | [optional] \n **pulp_created__lt** | **datetime**| Filter results where pulp_created is less than value | [optional] \n **pulp_created__lte** | **datetime**| Filter results where pulp_created is less than or equal to value | [optional] \n **pulp_created__range** | [**List[datetime]**](datetime.md)| Filter results where pulp_created is between two comma separated values | [optional] \n **pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional] \n **q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**PaginatedRepositoryVersionResponseList**](PaginatedRepositoryVersionResponseList.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **read**\n> RepositoryVersionResponse read(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n\nInspect a repository version\n\nA ViewSet for a NpmRepositoryVersion represents a single Npm repository version.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.repository_version_response import RepositoryVersionResponse\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)\n npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)\n exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)\n\n try:\n # Inspect a repository version\n api_response = api_instance.read(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)\n print(\"The response of RepositoriesNpmVersionsApi->read:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmVersionsApi->read: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_version_href** | **str**| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n **fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional] \n **exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional] \n\n### Return type\n\n[**RepositoryVersionResponse**](RepositoryVersionResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: Not defined\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**200** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# **repair**\n> AsyncOperationResponse repair(npm_npm_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)\n\n\n\nTrigger an asynchronous task to repair a repository version.\n\n### Example\n\n* OAuth Authentication (json_header_remote_authentication):\n* Basic Authentication (basicAuth):\n* Api Key Authentication (cookieAuth):\n\n```python\nimport pulpcore.client.pulp_npm\nfrom pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse\nfrom pulpcore.client.pulp_npm.models.repair import Repair\nfrom pulpcore.client.pulp_npm.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n host = \"https://env-ephemeral-xtzmuk.apps.crc-eph.r9lp.p1.openshiftapps.com\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = pulpcore.client.pulp_npm.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure API key authorization: cookieAuth\nconfiguration.api_key['cookieAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['cookieAuth'] = 'Bearer'\n\n# Enter a context with an instance of the API client\nwith pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)\n npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str | \n repair = pulpcore.client.pulp_npm.Repair() # Repair | \n x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)\n\n try:\n api_response = api_instance.repair(npm_npm_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)\n print(\"The response of RepositoriesNpmVersionsApi->repair:\\n\")\n pprint(api_response)\n except Exception as e:\n print(\"Exception when calling RepositoriesNpmVersionsApi->repair: %s\\n\" % e)\n```\n\n\n\n### Parameters\n\n\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------\n **npm_npm_repository_version_href** | **str**| | \n **repair** | [**Repair**](Repair.md)| | \n **x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional] \n\n### Return type\n\n[**AsyncOperationResponse**](AsyncOperationResponse.md)\n\n### Authorization\n\n[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)\n\n### HTTP request headers\n\n - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data\n - **Accept**: application/json\n\n### HTTP response details\n\n| Status code | Description | Response headers |\n|-------------|-------------|------------------|\n**202** | | - |\n\n[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)\n\n# RepositoryAddRemoveContent\n\nBase serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**add_content_units** | **List[str]** | A list of content units to add to a new repository version. This content is added after remove_content_units are removed. | [optional] \n**remove_content_units** | **List[str]** | A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added. | [optional] \n**base_version** | **str** | A repository version whose content will be used as the initial set of content for the new repository version | [optional] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.repository_add_remove_content import RepositoryAddRemoveContent\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of RepositoryAddRemoveContent from a JSON string\nrepository_add_remove_content_instance = RepositoryAddRemoveContent.from_json(json)\n# print the JSON string representation of the object\nprint(RepositoryAddRemoveContent.to_json())\n\n# convert the object into a dict\nrepository_add_remove_content_dict = repository_add_remove_content_instance.to_dict()\n# create an instance of RepositoryAddRemoveContent from a dict\nrepository_add_remove_content_from_dict = RepositoryAddRemoveContent.from_dict(repository_add_remove_content_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# RepositorySyncURL\n\nA mixin for validating unknown serializers' fields.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**remote** | **str** | A remote to sync from. This will override a remote set on repository. | [optional] \n**mirror** | **bool** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional] [default to False]\n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.repository_sync_url import RepositorySyncURL\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of RepositorySyncURL from a JSON string\nrepository_sync_url_instance = RepositorySyncURL.from_json(json)\n# print the JSON string representation of the object\nprint(RepositorySyncURL.to_json())\n\n# convert the object into a dict\nrepository_sync_url_dict = repository_sync_url_instance.to_dict()\n# create an instance of RepositorySyncURL from a dict\nrepository_sync_url_from_dict = RepositorySyncURL.from_dict(repository_sync_url_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# RepositoryVersionResponse\n\nBase serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**pulp_href** | **str** | | [optional] [readonly] \n**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly] \n**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly] \n**pulp_last_updated** | **datetime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] \n**number** | **int** | | [optional] [readonly] \n**repository** | **str** | | [optional] [readonly] \n**base_version** | **str** | A repository version whose content was used as the initial set of content for this repository version | [optional] \n**content_summary** | [**ContentSummaryResponse**](ContentSummaryResponse.md) | Various count summaries of the content in the version and the HREF to view them. | [optional] [readonly] \n**vuln_report** | **str** | | [optional] [readonly] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.repository_version_response import RepositoryVersionResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of RepositoryVersionResponse from a JSON string\nrepository_version_response_instance = RepositoryVersionResponse.from_json(json)\n# print the JSON string representation of the object\nprint(RepositoryVersionResponse.to_json())\n\n# convert the object into a dict\nrepository_version_response_dict = repository_version_response_instance.to_dict()\n# create an instance of RepositoryVersionResponse from a dict\nrepository_version_response_from_dict = RepositoryVersionResponse.from_dict(repository_version_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# SetLabel\n\nSerializer for synchronously setting a label.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**key** | **str** | | \n**value** | **str** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.set_label import SetLabel\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of SetLabel from a JSON string\nset_label_instance = SetLabel.from_json(json)\n# print the JSON string representation of the object\nprint(SetLabel.to_json())\n\n# convert the object into a dict\nset_label_dict = set_label_instance.to_dict()\n# create an instance of SetLabel from a dict\nset_label_from_dict = SetLabel.from_dict(set_label_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# SetLabelResponse\n\nSerializer for synchronously setting a label.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**key** | **str** | | \n**value** | **str** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of SetLabelResponse from a JSON string\nset_label_response_instance = SetLabelResponse.from_json(json)\n# print the JSON string representation of the object\nprint(SetLabelResponse.to_json())\n\n# convert the object into a dict\nset_label_response_dict = set_label_response_instance.to_dict()\n# create an instance of SetLabelResponse from a dict\nset_label_response_from_dict = SetLabelResponse.from_dict(set_label_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# UnsetLabel\n\nSerializer for synchronously UNsetting a label.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**key** | **str** | | \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.unset_label import UnsetLabel\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of UnsetLabel from a JSON string\nunset_label_instance = UnsetLabel.from_json(json)\n# print the JSON string representation of the object\nprint(UnsetLabel.to_json())\n\n# convert the object into a dict\nunset_label_dict = unset_label_instance.to_dict()\n# create an instance of UnsetLabel from a dict\nunset_label_from_dict = UnsetLabel.from_dict(unset_label_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n# UnsetLabelResponse\n\nSerializer for synchronously UNsetting a label.\n\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n**key** | **str** | | \n**value** | **str** | | [optional] [readonly] \n\n## Example\n\n```python\nfrom pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse\n\n# TODO update the JSON string below\njson = \"{}\"\n# create an instance of UnsetLabelResponse from a JSON string\nunset_label_response_instance = UnsetLabelResponse.from_json(json)\n# print the JSON string representation of the object\nprint(UnsetLabelResponse.to_json())\n\n# convert the object into a dict\nunset_label_response_dict = unset_label_response_instance.to_dict()\n# create an instance of UnsetLabelResponse from a dict\nunset_label_response_from_dict = UnsetLabelResponse.from_dict(unset_label_response_dict)\n```\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n\n",
"bugtrack_url": null,
"license": "GPLv2+",
"summary": "Pulp 3 API",
"version": "20251030.1",
"project_urls": null,
"split_keywords": [
"pulp",
" pulpcore",
" client",
" pulp 3 api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ecb408a75da8917b68ac0325c8f68bd7537175bb491f17ec087917490c17a47d",
"md5": "bdd98bb176bb9ac4b64ea25752b3e0dd",
"sha256": "492c69c00b7b953fd8044177a8a13fe54061d993e04abf07507a77ce612e981e"
},
"downloads": -1,
"filename": "crc_pulp_npm_client-20251030.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdd98bb176bb9ac4b64ea25752b3e0dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 120164,
"upload_time": "2025-10-30T12:27:30",
"upload_time_iso_8601": "2025-10-30T12:27:30.995952Z",
"url": "https://files.pythonhosted.org/packages/ec/b4/08a75da8917b68ac0325c8f68bd7537175bb491f17ec087917490c17a47d/crc_pulp_npm_client-20251030.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e88da5f6fa1a37129cc41dd814e55fa744447de13852add944e3b413f6f71307",
"md5": "80ce0e2787fea99d9f34070adfdd2b8d",
"sha256": "42de198da4bf4f72ce00022589c99d127c4b12eeb3411c570698e90ef277be17"
},
"downloads": -1,
"filename": "crc_pulp_npm_client-20251030.1.tar.gz",
"has_sig": false,
"md5_digest": "80ce0e2787fea99d9f34070adfdd2b8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 99094,
"upload_time": "2025-10-30T12:27:32",
"upload_time_iso_8601": "2025-10-30T12:27:32.350875Z",
"url": "https://files.pythonhosted.org/packages/e8/8d/a5f6fa1a37129cc41dd814e55fa744447de13852add944e3b413f6f71307/crc_pulp_npm_client-20251030.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-30 12:27:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "crc-pulp-npm-client"
}
JSON