pulp_npm_client 0.1.0a1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +157 -0
  4. data/Rakefile +10 -0
  5. data/docs/AsyncOperationResponse.md +17 -0
  6. data/docs/ContentPackagesApi.md +208 -0
  7. data/docs/ContentSummary.md +21 -0
  8. data/docs/ContentSummaryResponse.md +21 -0
  9. data/docs/DistributionsNpmApi.md +364 -0
  10. data/docs/NpmNpmDistribution.md +25 -0
  11. data/docs/NpmNpmDistributionResponse.md +31 -0
  12. data/docs/NpmNpmRemote.md +37 -0
  13. data/docs/NpmNpmRemoteResponse.md +43 -0
  14. data/docs/NpmNpmRepository.md +21 -0
  15. data/docs/NpmNpmRepositoryResponse.md +29 -0
  16. data/docs/NpmPackage.md +27 -0
  17. data/docs/NpmPackageResponse.md +27 -0
  18. data/docs/PaginatedRepositoryVersionResponseList.md +23 -0
  19. data/docs/PaginatednpmNpmDistributionResponseList.md +23 -0
  20. data/docs/PaginatednpmNpmRemoteResponseList.md +23 -0
  21. data/docs/PaginatednpmNpmRepositoryResponseList.md +23 -0
  22. data/docs/PaginatednpmPackageResponseList.md +23 -0
  23. data/docs/PatchednpmNpmDistribution.md +25 -0
  24. data/docs/PatchednpmNpmRemote.md +37 -0
  25. data/docs/PatchednpmNpmRepository.md +21 -0
  26. data/docs/PolicyEnum.md +16 -0
  27. data/docs/PulpNpmPackagesApi.md +60 -0
  28. data/docs/RemotesNpmApi.md +368 -0
  29. data/docs/RepositoriesNpmApi.md +468 -0
  30. data/docs/RepositoriesNpmVersionsApi.md +271 -0
  31. data/docs/RepositoryAddRemoveContent.md +21 -0
  32. data/docs/RepositorySyncURL.md +19 -0
  33. data/docs/RepositoryVersion.md +17 -0
  34. data/docs/RepositoryVersionResponse.md +25 -0
  35. data/git_push.sh +58 -0
  36. data/lib/pulp_npm_client.rb +69 -0
  37. data/lib/pulp_npm_client/api/content_packages_api.rb +264 -0
  38. data/lib/pulp_npm_client/api/distributions_npm_api.rb +445 -0
  39. data/lib/pulp_npm_client/api/pulp_npm_packages_api.rb +86 -0
  40. data/lib/pulp_npm_client/api/remotes_npm_api.rb +451 -0
  41. data/lib/pulp_npm_client/api/repositories_npm_api.rb +573 -0
  42. data/lib/pulp_npm_client/api/repositories_npm_versions_api.rb +339 -0
  43. data/lib/pulp_npm_client/api_client.rb +402 -0
  44. data/lib/pulp_npm_client/api_error.rb +57 -0
  45. data/lib/pulp_npm_client/configuration.rb +243 -0
  46. data/lib/pulp_npm_client/models/async_operation_response.rb +213 -0
  47. data/lib/pulp_npm_client/models/content_summary.rb +240 -0
  48. data/lib/pulp_npm_client/models/content_summary_response.rb +240 -0
  49. data/lib/pulp_npm_client/models/npm_npm_distribution.rb +261 -0
  50. data/lib/pulp_npm_client/models/npm_npm_distribution_response.rb +290 -0
  51. data/lib/pulp_npm_client/models/npm_npm_remote.rb +339 -0
  52. data/lib/pulp_npm_client/models/npm_npm_remote_response.rb +368 -0
  53. data/lib/pulp_npm_client/models/npm_npm_repository.rb +234 -0
  54. data/lib/pulp_npm_client/models/npm_npm_repository_response.rb +271 -0
  55. data/lib/pulp_npm_client/models/npm_package.rb +270 -0
  56. data/lib/pulp_npm_client/models/npm_package_response.rb +269 -0
  57. data/lib/pulp_npm_client/models/paginated_repository_version_response_list.rb +237 -0
  58. data/lib/pulp_npm_client/models/paginatednpm_npm_distribution_response_list.rb +237 -0
  59. data/lib/pulp_npm_client/models/paginatednpm_npm_remote_response_list.rb +237 -0
  60. data/lib/pulp_npm_client/models/paginatednpm_npm_repository_response_list.rb +237 -0
  61. data/lib/pulp_npm_client/models/paginatednpm_package_response_list.rb +237 -0
  62. data/lib/pulp_npm_client/models/patchednpm_npm_distribution.rb +251 -0
  63. data/lib/pulp_npm_client/models/patchednpm_npm_remote.rb +329 -0
  64. data/lib/pulp_npm_client/models/patchednpm_npm_repository.rb +229 -0
  65. data/lib/pulp_npm_client/models/policy_enum.rb +37 -0
  66. data/lib/pulp_npm_client/models/repository_add_remove_content.rb +232 -0
  67. data/lib/pulp_npm_client/models/repository_sync_url.rb +220 -0
  68. data/lib/pulp_npm_client/models/repository_version.rb +208 -0
  69. data/lib/pulp_npm_client/models/repository_version_response.rb +246 -0
  70. data/lib/pulp_npm_client/version.rb +15 -0
  71. data/pulp_npm_client.gemspec +39 -0
  72. data/spec/api/content_packages_api_spec.rb +87 -0
  73. data/spec/api/distributions_npm_api_spec.rb +121 -0
  74. data/spec/api/pulp_npm_packages_api_spec.rb +48 -0
  75. data/spec/api/remotes_npm_api_spec.rb +123 -0
  76. data/spec/api/repositories_npm_api_spec.rb +143 -0
  77. data/spec/api/repositories_npm_versions_api_spec.rb +104 -0
  78. data/spec/api_client_spec.rb +188 -0
  79. data/spec/configuration_spec.rb +42 -0
  80. data/spec/models/async_operation_response_spec.rb +41 -0
  81. data/spec/models/content_summary_response_spec.rb +53 -0
  82. data/spec/models/content_summary_spec.rb +53 -0
  83. data/spec/models/npm_npm_distribution_response_spec.rb +83 -0
  84. data/spec/models/npm_npm_distribution_spec.rb +65 -0
  85. data/spec/models/npm_npm_remote_response_spec.rb +119 -0
  86. data/spec/models/npm_npm_remote_spec.rb +101 -0
  87. data/spec/models/npm_npm_repository_response_spec.rb +77 -0
  88. data/spec/models/npm_npm_repository_spec.rb +53 -0
  89. data/spec/models/npm_package_response_spec.rb +71 -0
  90. data/spec/models/npm_package_spec.rb +71 -0
  91. data/spec/models/paginated_repository_version_response_list_spec.rb +59 -0
  92. data/spec/models/paginatednpm_npm_distribution_response_list_spec.rb +59 -0
  93. data/spec/models/paginatednpm_npm_remote_response_list_spec.rb +59 -0
  94. data/spec/models/paginatednpm_npm_repository_response_list_spec.rb +59 -0
  95. data/spec/models/paginatednpm_package_response_list_spec.rb +59 -0
  96. data/spec/models/patchednpm_npm_distribution_spec.rb +65 -0
  97. data/spec/models/patchednpm_npm_remote_spec.rb +101 -0
  98. data/spec/models/patchednpm_npm_repository_spec.rb +53 -0
  99. data/spec/models/policy_enum_spec.rb +35 -0
  100. data/spec/models/repository_add_remove_content_spec.rb +53 -0
  101. data/spec/models/repository_sync_url_spec.rb +47 -0
  102. data/spec/models/repository_version_response_spec.rb +65 -0
  103. data/spec/models/repository_version_spec.rb +41 -0
  104. data/spec/spec_helper.rb +111 -0
  105. metadata +233 -0
@@ -0,0 +1,43 @@
1
+ # PulpNpmClient::NpmNpmRemoteResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pulp_href** | **String** | | [optional] [readonly]
8
+ **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
+ **name** | **String** | A unique name for this remote. |
10
+ **url** | **String** | The URL of an external content source. |
11
+ **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
12
+ **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
13
+ **client_key** | **String** | A PEM encoded private key used for authentication. | [optional]
14
+ **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
15
+ **proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [optional]
16
+ **username** | **String** | The username to be used for authentication when syncing. | [optional]
17
+ **password** | **String** | The password to be used for authentication when syncing. | [optional]
18
+ **pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly]
19
+ **download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional]
20
+ **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional]
21
+
22
+ ## Code Sample
23
+
24
+ ```ruby
25
+ require 'PulpNpmClient'
26
+
27
+ instance = PulpNpmClient::NpmNpmRemoteResponse.new(pulp_href: null,
28
+ pulp_created: null,
29
+ name: null,
30
+ url: null,
31
+ ca_cert: null,
32
+ client_cert: null,
33
+ client_key: null,
34
+ tls_validation: null,
35
+ proxy_url: null,
36
+ username: null,
37
+ password: null,
38
+ pulp_last_updated: null,
39
+ download_concurrency: null,
40
+ policy: null)
41
+ ```
42
+
43
+
@@ -0,0 +1,21 @@
1
+ # PulpNpmClient::NpmNpmRepository
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | A unique name for this repository. |
8
+ **description** | **String** | An optional description. | [optional]
9
+ **remote** | **String** | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'PulpNpmClient'
15
+
16
+ instance = PulpNpmClient::NpmNpmRepository.new(name: null,
17
+ description: null,
18
+ remote: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,29 @@
1
+ # PulpNpmClient::NpmNpmRepositoryResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pulp_href** | **String** | | [optional] [readonly]
8
+ **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
+ **versions_href** | **String** | | [optional] [readonly]
10
+ **latest_version_href** | **String** | | [optional] [readonly]
11
+ **name** | **String** | A unique name for this repository. |
12
+ **description** | **String** | An optional description. | [optional]
13
+ **remote** | **String** | | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'PulpNpmClient'
19
+
20
+ instance = PulpNpmClient::NpmNpmRepositoryResponse.new(pulp_href: null,
21
+ pulp_created: null,
22
+ versions_href: null,
23
+ latest_version_href: null,
24
+ name: null,
25
+ description: null,
26
+ remote: null)
27
+ ```
28
+
29
+
@@ -0,0 +1,27 @@
1
+ # PulpNpmClient::NpmPackage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **artifact** | **String** | Artifact file representing the physical content | [optional]
8
+ **relative_path** | **String** | |
9
+ **file** | **File** | An uploaded file that may be turned into the artifact of the content unit. | [optional]
10
+ **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional]
11
+ **name** | **String** | |
12
+ **version** | **String** | |
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'PulpNpmClient'
18
+
19
+ instance = PulpNpmClient::NpmPackage.new(artifact: null,
20
+ relative_path: null,
21
+ file: null,
22
+ repository: null,
23
+ name: null,
24
+ version: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,27 @@
1
+ # PulpNpmClient::NpmPackageResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **pulp_href** | **String** | | [optional] [readonly]
8
+ **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
+ **artifact** | **String** | Artifact file representing the physical content | [optional]
10
+ **relative_path** | **String** | |
11
+ **name** | **String** | |
12
+ **version** | **String** | |
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'PulpNpmClient'
18
+
19
+ instance = PulpNpmClient::NpmPackageResponse.new(pulp_href: null,
20
+ pulp_created: null,
21
+ artifact: null,
22
+ relative_path: null,
23
+ name: null,
24
+ version: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,23 @@
1
+ # PulpNpmClient::PaginatedRepositoryVersionResponseList
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | | [optional]
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<RepositoryVersionResponse>**](RepositoryVersionResponse.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpNpmClient'
16
+
17
+ instance = PulpNpmClient::PaginatedRepositoryVersionResponseList.new(count: 123,
18
+ _next: http://api.example.org/accounts/?offset=400&limit=100,
19
+ previous: http://api.example.org/accounts/?offset=200&limit=100,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpNpmClient::PaginatednpmNpmDistributionResponseList
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | | [optional]
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<NpmNpmDistributionResponse>**](NpmNpmDistributionResponse.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpNpmClient'
16
+
17
+ instance = PulpNpmClient::PaginatednpmNpmDistributionResponseList.new(count: 123,
18
+ _next: http://api.example.org/accounts/?offset=400&limit=100,
19
+ previous: http://api.example.org/accounts/?offset=200&limit=100,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpNpmClient::PaginatednpmNpmRemoteResponseList
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | | [optional]
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<NpmNpmRemoteResponse>**](NpmNpmRemoteResponse.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpNpmClient'
16
+
17
+ instance = PulpNpmClient::PaginatednpmNpmRemoteResponseList.new(count: 123,
18
+ _next: http://api.example.org/accounts/?offset=400&limit=100,
19
+ previous: http://api.example.org/accounts/?offset=200&limit=100,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpNpmClient::PaginatednpmNpmRepositoryResponseList
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | | [optional]
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<NpmNpmRepositoryResponse>**](NpmNpmRepositoryResponse.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpNpmClient'
16
+
17
+ instance = PulpNpmClient::PaginatednpmNpmRepositoryResponseList.new(count: 123,
18
+ _next: http://api.example.org/accounts/?offset=400&limit=100,
19
+ previous: http://api.example.org/accounts/?offset=200&limit=100,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,23 @@
1
+ # PulpNpmClient::PaginatednpmPackageResponseList
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | | [optional]
8
+ **_next** | **String** | | [optional]
9
+ **previous** | **String** | | [optional]
10
+ **results** | [**Array<NpmPackageResponse>**](NpmPackageResponse.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'PulpNpmClient'
16
+
17
+ instance = PulpNpmClient::PaginatednpmPackageResponseList.new(count: 123,
18
+ _next: http://api.example.org/accounts/?offset=400&limit=100,
19
+ previous: http://api.example.org/accounts/?offset=200&limit=100,
20
+ results: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,25 @@
1
+ # PulpNpmClient::PatchednpmNpmDistribution
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **base_path** | **String** | 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]
8
+ **content_guard** | **String** | An optional content-guard. | [optional]
9
+ **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional]
10
+ **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
11
+ **repository_version** | **String** | RepositoryVersion to be served | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'PulpNpmClient'
17
+
18
+ instance = PulpNpmClient::PatchednpmNpmDistribution.new(base_path: null,
19
+ content_guard: null,
20
+ name: null,
21
+ repository: null,
22
+ repository_version: null)
23
+ ```
24
+
25
+
@@ -0,0 +1,37 @@
1
+ # PulpNpmClient::PatchednpmNpmRemote
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | A unique name for this remote. | [optional]
8
+ **url** | **String** | The URL of an external content source. | [optional]
9
+ **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
10
+ **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional]
11
+ **client_key** | **String** | A PEM encoded private key used for authentication. | [optional]
12
+ **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional]
13
+ **proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [optional]
14
+ **username** | **String** | The username to be used for authentication when syncing. | [optional]
15
+ **password** | **String** | The password to be used for authentication when syncing. | [optional]
16
+ **download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional]
17
+ **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. | [optional]
18
+
19
+ ## Code Sample
20
+
21
+ ```ruby
22
+ require 'PulpNpmClient'
23
+
24
+ instance = PulpNpmClient::PatchednpmNpmRemote.new(name: null,
25
+ url: null,
26
+ ca_cert: null,
27
+ client_cert: null,
28
+ client_key: null,
29
+ tls_validation: null,
30
+ proxy_url: null,
31
+ username: null,
32
+ password: null,
33
+ download_concurrency: null,
34
+ policy: null)
35
+ ```
36
+
37
+
@@ -0,0 +1,21 @@
1
+ # PulpNpmClient::PatchednpmNpmRepository
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | A unique name for this repository. | [optional]
8
+ **description** | **String** | An optional description. | [optional]
9
+ **remote** | **String** | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'PulpNpmClient'
15
+
16
+ instance = PulpNpmClient::PatchednpmNpmRepository.new(name: null,
17
+ description: null,
18
+ remote: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,16 @@
1
+ # PulpNpmClient::PolicyEnum
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'PulpNpmClient'
12
+
13
+ instance = PulpNpmClient::PolicyEnum.new()
14
+ ```
15
+
16
+
@@ -0,0 +1,60 @@
1
+ # PulpNpmClient::PulpNpmPackagesApi
2
+
3
+ All URIs are relative to *http://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get**](PulpNpmPackagesApi.md#get) | **GET** /pulp_npm/packages/{name}/ |
8
+
9
+
10
+
11
+ ## get
12
+
13
+ > get(name, opts)
14
+
15
+
16
+
17
+ Return a published package.
18
+
19
+ ### Example
20
+
21
+ ```ruby
22
+ # load the gem
23
+ require 'pulp_npm_client'
24
+
25
+ api_instance = PulpNpmClient::PulpNpmPackagesApi.new
26
+ name = 'name_example' # String |
27
+ opts = {
28
+ fields: 'fields_example', # String | A list of fields to include in the response.
29
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
30
+ }
31
+
32
+ begin
33
+ api_instance.get(name, opts)
34
+ rescue PulpNpmClient::ApiError => e
35
+ puts "Exception when calling PulpNpmPackagesApi->get: #{e}"
36
+ end
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+
42
+ Name | Type | Description | Notes
43
+ ------------- | ------------- | ------------- | -------------
44
+ **name** | **String**| |
45
+ **fields** | **String**| A list of fields to include in the response. | [optional]
46
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
47
+
48
+ ### Return type
49
+
50
+ nil (empty response body)
51
+
52
+ ### Authorization
53
+
54
+ No authorization required
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: Not defined
59
+ - **Accept**: Not defined
60
+
@@ -0,0 +1,368 @@
1
+ # PulpNpmClient::RemotesNpmApi
2
+
3
+ All URIs are relative to *http://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](RemotesNpmApi.md#create) | **POST** /pulp/api/v3/remotes/npm/npm/ | Create a npm remote
8
+ [**delete**](RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
9
+ [**list**](RemotesNpmApi.md#list) | **GET** /pulp/api/v3/remotes/npm/npm/ | List npm remotes
10
+ [**partial_update**](RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
11
+ [**read**](RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
12
+ [**update**](RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
13
+
14
+
15
+
16
+ ## create
17
+
18
+ > NpmNpmRemoteResponse create(npm_npm_remote)
19
+
20
+ Create a npm remote
21
+
22
+ A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
23
+
24
+ ### Example
25
+
26
+ ```ruby
27
+ # load the gem
28
+ require 'pulp_npm_client'
29
+ # setup authorization
30
+ PulpNpmClient.configure do |config|
31
+ # Configure HTTP basic authorization: basicAuth
32
+ config.username = 'YOUR USERNAME'
33
+ config.password = 'YOUR PASSWORD'
34
+ end
35
+
36
+ api_instance = PulpNpmClient::RemotesNpmApi.new
37
+ npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote |
38
+
39
+ begin
40
+ #Create a npm remote
41
+ result = api_instance.create(npm_npm_remote)
42
+ p result
43
+ rescue PulpNpmClient::ApiError => e
44
+ puts "Exception when calling RemotesNpmApi->create: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| |
54
+
55
+ ### Return type
56
+
57
+ [**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
58
+
59
+ ### Authorization
60
+
61
+ [basicAuth](../README.md#basicAuth)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
66
+ - **Accept**: application/json
67
+
68
+
69
+ ## delete
70
+
71
+ > AsyncOperationResponse delete(npm_npm_remote_href)
72
+
73
+ Delete a npm remote
74
+
75
+ Trigger an asynchronous delete task
76
+
77
+ ### Example
78
+
79
+ ```ruby
80
+ # load the gem
81
+ require 'pulp_npm_client'
82
+ # setup authorization
83
+ PulpNpmClient.configure do |config|
84
+ # Configure HTTP basic authorization: basicAuth
85
+ config.username = 'YOUR USERNAME'
86
+ config.password = 'YOUR PASSWORD'
87
+ end
88
+
89
+ api_instance = PulpNpmClient::RemotesNpmApi.new
90
+ npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
91
+
92
+ begin
93
+ #Delete a npm remote
94
+ result = api_instance.delete(npm_npm_remote_href)
95
+ p result
96
+ rescue PulpNpmClient::ApiError => e
97
+ puts "Exception when calling RemotesNpmApi->delete: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+
104
+ Name | Type | Description | Notes
105
+ ------------- | ------------- | ------------- | -------------
106
+ **npm_npm_remote_href** | **String**| |
107
+
108
+ ### Return type
109
+
110
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
111
+
112
+ ### Authorization
113
+
114
+ [basicAuth](../README.md#basicAuth)
115
+
116
+ ### HTTP request headers
117
+
118
+ - **Content-Type**: Not defined
119
+ - **Accept**: application/json
120
+
121
+
122
+ ## list
123
+
124
+ > PaginatednpmNpmRemoteResponseList list(opts)
125
+
126
+ List npm remotes
127
+
128
+ A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
129
+
130
+ ### Example
131
+
132
+ ```ruby
133
+ # load the gem
134
+ require 'pulp_npm_client'
135
+ # setup authorization
136
+ PulpNpmClient.configure do |config|
137
+ # Configure HTTP basic authorization: basicAuth
138
+ config.username = 'YOUR USERNAME'
139
+ config.password = 'YOUR PASSWORD'
140
+ end
141
+
142
+ api_instance = PulpNpmClient::RemotesNpmApi.new
143
+ opts = {
144
+ limit: 56, # Integer | Number of results to return per page.
145
+ name: 'name_example', # String | name
146
+ name__in: 'name__in_example', # String | name__in
147
+ offset: 56, # Integer | The initial index from which to return the results.
148
+ ordering: 'ordering_example', # String | Which field to use when ordering the results.
149
+ pulp_last_updated: 'pulp_last_updated_example', # String | pulp_last_updated
150
+ pulp_last_updated__gt: 'pulp_last_updated__gt_example', # String | pulp_last_updated__gt
151
+ pulp_last_updated__gte: 'pulp_last_updated__gte_example', # String | pulp_last_updated__gte
152
+ pulp_last_updated__lt: 'pulp_last_updated__lt_example', # String | pulp_last_updated__lt
153
+ pulp_last_updated__lte: 'pulp_last_updated__lte_example', # String | pulp_last_updated__lte
154
+ pulp_last_updated__range: 'pulp_last_updated__range_example', # String | pulp_last_updated__range
155
+ fields: 'fields_example', # String | A list of fields to include in the response.
156
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
157
+ }
158
+
159
+ begin
160
+ #List npm remotes
161
+ result = api_instance.list(opts)
162
+ p result
163
+ rescue PulpNpmClient::ApiError => e
164
+ puts "Exception when calling RemotesNpmApi->list: #{e}"
165
+ end
166
+ ```
167
+
168
+ ### Parameters
169
+
170
+
171
+ Name | Type | Description | Notes
172
+ ------------- | ------------- | ------------- | -------------
173
+ **limit** | **Integer**| Number of results to return per page. | [optional]
174
+ **name** | **String**| name | [optional]
175
+ **name__in** | **String**| name__in | [optional]
176
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
177
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
178
+ **pulp_last_updated** | **String**| pulp_last_updated | [optional]
179
+ **pulp_last_updated__gt** | **String**| pulp_last_updated__gt | [optional]
180
+ **pulp_last_updated__gte** | **String**| pulp_last_updated__gte | [optional]
181
+ **pulp_last_updated__lt** | **String**| pulp_last_updated__lt | [optional]
182
+ **pulp_last_updated__lte** | **String**| pulp_last_updated__lte | [optional]
183
+ **pulp_last_updated__range** | **String**| pulp_last_updated__range | [optional]
184
+ **fields** | **String**| A list of fields to include in the response. | [optional]
185
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
186
+
187
+ ### Return type
188
+
189
+ [**PaginatednpmNpmRemoteResponseList**](PaginatednpmNpmRemoteResponseList.md)
190
+
191
+ ### Authorization
192
+
193
+ [basicAuth](../README.md#basicAuth)
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: Not defined
198
+ - **Accept**: application/json
199
+
200
+
201
+ ## partial_update
202
+
203
+ > AsyncOperationResponse partial_update(npm_npm_remote_href, patchednpm_npm_remote)
204
+
205
+ Update a npm remote
206
+
207
+ Trigger an asynchronous partial update task
208
+
209
+ ### Example
210
+
211
+ ```ruby
212
+ # load the gem
213
+ require 'pulp_npm_client'
214
+ # setup authorization
215
+ PulpNpmClient.configure do |config|
216
+ # Configure HTTP basic authorization: basicAuth
217
+ config.username = 'YOUR USERNAME'
218
+ config.password = 'YOUR PASSWORD'
219
+ end
220
+
221
+ api_instance = PulpNpmClient::RemotesNpmApi.new
222
+ npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
223
+ patchednpm_npm_remote = PulpNpmClient::PatchednpmNpmRemote.new # PatchednpmNpmRemote |
224
+
225
+ begin
226
+ #Update a npm remote
227
+ result = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote)
228
+ p result
229
+ rescue PulpNpmClient::ApiError => e
230
+ puts "Exception when calling RemotesNpmApi->partial_update: #{e}"
231
+ end
232
+ ```
233
+
234
+ ### Parameters
235
+
236
+
237
+ Name | Type | Description | Notes
238
+ ------------- | ------------- | ------------- | -------------
239
+ **npm_npm_remote_href** | **String**| |
240
+ **patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md)| |
241
+
242
+ ### Return type
243
+
244
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
245
+
246
+ ### Authorization
247
+
248
+ [basicAuth](../README.md#basicAuth)
249
+
250
+ ### HTTP request headers
251
+
252
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
253
+ - **Accept**: application/json
254
+
255
+
256
+ ## read
257
+
258
+ > NpmNpmRemoteResponse read(npm_npm_remote_href, opts)
259
+
260
+ Inspect a npm remote
261
+
262
+ A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
263
+
264
+ ### Example
265
+
266
+ ```ruby
267
+ # load the gem
268
+ require 'pulp_npm_client'
269
+ # setup authorization
270
+ PulpNpmClient.configure do |config|
271
+ # Configure HTTP basic authorization: basicAuth
272
+ config.username = 'YOUR USERNAME'
273
+ config.password = 'YOUR PASSWORD'
274
+ end
275
+
276
+ api_instance = PulpNpmClient::RemotesNpmApi.new
277
+ npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
278
+ opts = {
279
+ fields: 'fields_example', # String | A list of fields to include in the response.
280
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
281
+ }
282
+
283
+ begin
284
+ #Inspect a npm remote
285
+ result = api_instance.read(npm_npm_remote_href, opts)
286
+ p result
287
+ rescue PulpNpmClient::ApiError => e
288
+ puts "Exception when calling RemotesNpmApi->read: #{e}"
289
+ end
290
+ ```
291
+
292
+ ### Parameters
293
+
294
+
295
+ Name | Type | Description | Notes
296
+ ------------- | ------------- | ------------- | -------------
297
+ **npm_npm_remote_href** | **String**| |
298
+ **fields** | **String**| A list of fields to include in the response. | [optional]
299
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
300
+
301
+ ### Return type
302
+
303
+ [**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
304
+
305
+ ### Authorization
306
+
307
+ [basicAuth](../README.md#basicAuth)
308
+
309
+ ### HTTP request headers
310
+
311
+ - **Content-Type**: Not defined
312
+ - **Accept**: application/json
313
+
314
+
315
+ ## update
316
+
317
+ > AsyncOperationResponse update(npm_npm_remote_href, npm_npm_remote)
318
+
319
+ Update a npm remote
320
+
321
+ Trigger an asynchronous update task
322
+
323
+ ### Example
324
+
325
+ ```ruby
326
+ # load the gem
327
+ require 'pulp_npm_client'
328
+ # setup authorization
329
+ PulpNpmClient.configure do |config|
330
+ # Configure HTTP basic authorization: basicAuth
331
+ config.username = 'YOUR USERNAME'
332
+ config.password = 'YOUR PASSWORD'
333
+ end
334
+
335
+ api_instance = PulpNpmClient::RemotesNpmApi.new
336
+ npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
337
+ npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote |
338
+
339
+ begin
340
+ #Update a npm remote
341
+ result = api_instance.update(npm_npm_remote_href, npm_npm_remote)
342
+ p result
343
+ rescue PulpNpmClient::ApiError => e
344
+ puts "Exception when calling RemotesNpmApi->update: #{e}"
345
+ end
346
+ ```
347
+
348
+ ### Parameters
349
+
350
+
351
+ Name | Type | Description | Notes
352
+ ------------- | ------------- | ------------- | -------------
353
+ **npm_npm_remote_href** | **String**| |
354
+ **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| |
355
+
356
+ ### Return type
357
+
358
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
359
+
360
+ ### Authorization
361
+
362
+ [basicAuth](../README.md#basicAuth)
363
+
364
+ ### HTTP request headers
365
+
366
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
367
+ - **Accept**: application/json
368
+