pulp_npm_client 0.1.0a4 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -10
  3. data/docs/AsyncOperationResponse.md +8 -7
  4. data/docs/ContentPackagesApi.md +126 -64
  5. data/docs/ContentSummaryResponse.md +12 -11
  6. data/docs/DistributionsNpmApi.md +362 -93
  7. data/docs/NpmNpmDistribution.md +18 -15
  8. data/docs/NpmNpmDistributionResponse.md +30 -21
  9. data/docs/NpmNpmRemote.md +48 -47
  10. data/docs/NpmNpmRemoteResponse.md +48 -43
  11. data/docs/NpmNpmRemoteResponseHiddenFieldsInner.md +20 -0
  12. data/docs/NpmNpmRepository.md +16 -15
  13. data/docs/NpmNpmRepositoryResponse.md +28 -23
  14. data/docs/NpmPackageResponse.md +22 -17
  15. data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
  16. data/docs/PaginatednpmNpmDistributionResponseList.md +14 -13
  17. data/docs/PaginatednpmNpmRemoteResponseList.md +14 -13
  18. data/docs/PaginatednpmNpmRepositoryResponseList.md +14 -13
  19. data/docs/PaginatednpmPackageResponseList.md +14 -13
  20. data/docs/PatchednpmNpmDistribution.md +18 -15
  21. data/docs/PatchednpmNpmRemote.md +48 -47
  22. data/docs/PatchednpmNpmRepository.md +16 -15
  23. data/docs/PolicyEnum.md +4 -5
  24. data/docs/RemotesNpmApi.md +364 -99
  25. data/docs/Repair.md +8 -7
  26. data/docs/RepositoriesNpmApi.md +429 -110
  27. data/docs/RepositoriesNpmVersionsApi.md +156 -80
  28. data/docs/RepositoryAddRemoveContent.md +12 -11
  29. data/docs/RepositorySyncURL.md +10 -9
  30. data/docs/RepositoryVersionResponse.md +22 -17
  31. data/docs/SetLabel.md +20 -0
  32. data/docs/SetLabelResponse.md +20 -0
  33. data/docs/UnsetLabel.md +18 -0
  34. data/docs/UnsetLabelResponse.md +20 -0
  35. data/lib/pulp_npm_client/api/content_packages_api.rb +72 -44
  36. data/lib/pulp_npm_client/api/distributions_npm_api.rb +243 -47
  37. data/lib/pulp_npm_client/api/remotes_npm_api.rb +247 -57
  38. data/lib/pulp_npm_client/api/repositories_npm_api.rb +283 -55
  39. data/lib/pulp_npm_client/api/repositories_npm_versions_api.rb +71 -52
  40. data/lib/pulp_npm_client/api_client.rb +137 -102
  41. data/lib/pulp_npm_client/api_error.rb +2 -1
  42. data/lib/pulp_npm_client/configuration.rb +163 -22
  43. data/lib/pulp_npm_client/models/async_operation_response.rb +32 -22
  44. data/lib/pulp_npm_client/models/content_summary_response.rb +36 -22
  45. data/lib/pulp_npm_client/models/npm_npm_distribution.rb +51 -25
  46. data/lib/pulp_npm_client/models/npm_npm_distribution_response.rb +83 -27
  47. data/lib/pulp_npm_client/models/npm_npm_remote.rb +61 -25
  48. data/lib/pulp_npm_client/models/npm_npm_remote_response.rb +99 -41
  49. data/lib/pulp_npm_client/models/npm_npm_remote_response_hidden_fields_inner.rb +237 -0
  50. data/lib/pulp_npm_client/models/npm_npm_repository.rb +37 -25
  51. data/lib/pulp_npm_client/models/npm_npm_repository_response.rb +59 -27
  52. data/lib/pulp_npm_client/models/npm_package_response.rb +58 -24
  53. data/lib/pulp_npm_client/models/paginated_repository_version_response_list.rb +44 -22
  54. data/lib/pulp_npm_client/models/paginatednpm_npm_distribution_response_list.rb +44 -22
  55. data/lib/pulp_npm_client/models/paginatednpm_npm_remote_response_list.rb +44 -22
  56. data/lib/pulp_npm_client/models/paginatednpm_npm_repository_response_list.rb +44 -22
  57. data/lib/pulp_npm_client/models/paginatednpm_package_response_list.rb +44 -22
  58. data/lib/pulp_npm_client/models/patchednpm_npm_distribution.rb +57 -27
  59. data/lib/pulp_npm_client/models/patchednpm_npm_remote.rb +67 -27
  60. data/lib/pulp_npm_client/models/patchednpm_npm_repository.rb +40 -26
  61. data/lib/pulp_npm_client/models/policy_enum.rb +8 -4
  62. data/lib/pulp_npm_client/models/repair.rb +30 -22
  63. data/lib/pulp_npm_client/models/repository_add_remove_content.rb +33 -25
  64. data/lib/pulp_npm_client/models/repository_sync_url.rb +30 -22
  65. data/lib/pulp_npm_client/models/repository_version_response.rb +53 -25
  66. data/lib/pulp_npm_client/models/set_label.rb +264 -0
  67. data/lib/pulp_npm_client/models/set_label_response.rb +255 -0
  68. data/lib/pulp_npm_client/models/unset_label.rb +252 -0
  69. data/lib/pulp_npm_client/models/unset_label_response.rb +252 -0
  70. data/lib/pulp_npm_client/version.rb +2 -2
  71. data/lib/pulp_npm_client.rb +6 -3
  72. data/pulp_npm_client.gemspec +10 -7
  73. data/spec/api/content_packages_api_spec.rb +22 -16
  74. data/spec/api/distributions_npm_api_spec.rb +51 -14
  75. data/spec/api/remotes_npm_api_spec.rb +54 -19
  76. data/spec/api/repositories_npm_api_spec.rb +60 -15
  77. data/spec/api/repositories_npm_versions_api_spec.rb +23 -19
  78. data/spec/models/async_operation_response_spec.rb +7 -12
  79. data/spec/models/content_summary_response_spec.rb +9 -14
  80. data/spec/models/npm_npm_distribution_response_spec.rb +38 -19
  81. data/spec/models/npm_npm_distribution_spec.rb +17 -16
  82. data/spec/models/npm_npm_remote_response_hidden_fields_inner_spec.rb +42 -0
  83. data/spec/models/npm_npm_remote_response_spec.rb +42 -35
  84. data/spec/models/npm_npm_remote_spec.rb +27 -32
  85. data/spec/models/npm_npm_repository_response_spec.rb +27 -20
  86. data/spec/models/npm_npm_repository_spec.rb +11 -16
  87. data/spec/models/npm_package_response_spec.rb +24 -17
  88. data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
  89. data/spec/models/paginatednpm_npm_distribution_response_list_spec.rb +10 -15
  90. data/spec/models/paginatednpm_npm_remote_response_list_spec.rb +10 -15
  91. data/spec/models/paginatednpm_npm_repository_response_list_spec.rb +10 -15
  92. data/spec/models/paginatednpm_package_response_list_spec.rb +10 -15
  93. data/spec/models/patchednpm_npm_distribution_spec.rb +17 -16
  94. data/spec/models/patchednpm_npm_remote_spec.rb +27 -32
  95. data/spec/models/patchednpm_npm_repository_spec.rb +11 -16
  96. data/spec/models/policy_enum_spec.rb +6 -11
  97. data/spec/models/repair_spec.rb +7 -12
  98. data/spec/models/repository_add_remove_content_spec.rb +9 -14
  99. data/spec/models/repository_sync_url_spec.rb +8 -13
  100. data/spec/models/repository_version_response_spec.rb +24 -17
  101. data/spec/models/set_label_response_spec.rb +42 -0
  102. data/spec/models/set_label_spec.rb +42 -0
  103. data/spec/models/unset_label_response_spec.rb +42 -0
  104. data/spec/models/unset_label_spec.rb +36 -0
  105. data/spec/spec_helper.rb +1 -1
  106. metadata +94 -59
  107. data/docs/NpmPackage.md +0 -29
  108. data/docs/PulpNpmPackagesApi.md +0 -60
  109. data/git_push.sh +0 -58
  110. data/lib/pulp_npm_client/api/pulp_npm_packages_api.rb +0 -86
  111. data/lib/pulp_npm_client/models/npm_package.rb +0 -337
  112. data/spec/api/pulp_npm_packages_api_spec.rb +0 -48
  113. data/spec/api_client_spec.rb +0 -188
  114. data/spec/configuration_spec.rb +0 -42
  115. data/spec/models/npm_package_spec.rb +0 -77
@@ -1,30 +1,31 @@
1
1
  # PulpNpmClient::RemotesNpmApi
2
2
 
3
- All URIs are relative to *https://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
3
+ All URIs are relative to *http://localhost:24817*
13
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
+ | [**set_label**](RemotesNpmApi.md#set_label) | **POST** {npm_npm_remote_href}set_label/ | Set a label |
13
+ | [**unset_label**](RemotesNpmApi.md#unset_label) | **POST** {npm_npm_remote_href}unset_label/ | Unset a label |
14
+ | [**update**](RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote |
14
15
 
15
16
 
16
17
  ## create
17
18
 
18
- > NpmNpmRemoteResponse create(npm_npm_remote)
19
+ > <NpmNpmRemoteResponse> create(npm_npm_remote)
19
20
 
20
21
  Create a npm remote
21
22
 
22
23
  A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
23
24
 
24
- ### Example
25
+ ### Examples
25
26
 
26
27
  ```ruby
27
- # load the gem
28
+ require 'time'
28
29
  require 'pulp_npm_client'
29
30
  # setup authorization
30
31
  PulpNpmClient.configure do |config|
@@ -34,23 +35,40 @@ PulpNpmClient.configure do |config|
34
35
  end
35
36
 
36
37
  api_instance = PulpNpmClient::RemotesNpmApi.new
37
- npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote |
38
+ npm_npm_remote = PulpNpmClient::NpmNpmRemote.new({name: 'name_example', url: 'url_example'}) # NpmNpmRemote |
38
39
 
39
40
  begin
40
- #Create a npm remote
41
+ # Create a npm remote
41
42
  result = api_instance.create(npm_npm_remote)
42
43
  p result
43
44
  rescue PulpNpmClient::ApiError => e
44
- puts "Exception when calling RemotesNpmApi->create: #{e}"
45
+ puts "Error when calling RemotesNpmApi->create: #{e}"
45
46
  end
46
47
  ```
47
48
 
48
- ### Parameters
49
+ #### Using the create_with_http_info variant
50
+
51
+ This returns an Array which contains the response data, status code and headers.
52
+
53
+ > <Array(<NpmNpmRemoteResponse>, Integer, Hash)> create_with_http_info(npm_npm_remote)
54
+
55
+ ```ruby
56
+ begin
57
+ # Create a npm remote
58
+ data, status_code, headers = api_instance.create_with_http_info(npm_npm_remote)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => <NpmNpmRemoteResponse>
62
+ rescue PulpNpmClient::ApiError => e
63
+ puts "Error when calling RemotesNpmApi->create_with_http_info: #{e}"
64
+ end
65
+ ```
49
66
 
67
+ ### Parameters
50
68
 
51
- Name | Type | Description | Notes
52
- ------------- | ------------- | ------------- | -------------
53
- **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| |
69
+ | Name | Type | Description | Notes |
70
+ | ---- | ---- | ----------- | ----- |
71
+ | **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md) | | |
54
72
 
55
73
  ### Return type
56
74
 
@@ -68,16 +86,16 @@ Name | Type | Description | Notes
68
86
 
69
87
  ## delete
70
88
 
71
- > AsyncOperationResponse delete(npm_npm_remote_href)
89
+ > <AsyncOperationResponse> delete(npm_npm_remote_href)
72
90
 
73
91
  Delete a npm remote
74
92
 
75
93
  Trigger an asynchronous delete task
76
94
 
77
- ### Example
95
+ ### Examples
78
96
 
79
97
  ```ruby
80
- # load the gem
98
+ require 'time'
81
99
  require 'pulp_npm_client'
82
100
  # setup authorization
83
101
  PulpNpmClient.configure do |config|
@@ -90,20 +108,37 @@ api_instance = PulpNpmClient::RemotesNpmApi.new
90
108
  npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
91
109
 
92
110
  begin
93
- #Delete a npm remote
111
+ # Delete a npm remote
94
112
  result = api_instance.delete(npm_npm_remote_href)
95
113
  p result
96
114
  rescue PulpNpmClient::ApiError => e
97
- puts "Exception when calling RemotesNpmApi->delete: #{e}"
115
+ puts "Error when calling RemotesNpmApi->delete: #{e}"
98
116
  end
99
117
  ```
100
118
 
101
- ### Parameters
119
+ #### Using the delete_with_http_info variant
120
+
121
+ This returns an Array which contains the response data, status code and headers.
122
+
123
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(npm_npm_remote_href)
124
+
125
+ ```ruby
126
+ begin
127
+ # Delete a npm remote
128
+ data, status_code, headers = api_instance.delete_with_http_info(npm_npm_remote_href)
129
+ p status_code # => 2xx
130
+ p headers # => { ... }
131
+ p data # => <AsyncOperationResponse>
132
+ rescue PulpNpmClient::ApiError => e
133
+ puts "Error when calling RemotesNpmApi->delete_with_http_info: #{e}"
134
+ end
135
+ ```
102
136
 
137
+ ### Parameters
103
138
 
104
- Name | Type | Description | Notes
105
- ------------- | ------------- | ------------- | -------------
106
- **npm_npm_remote_href** | **String**| |
139
+ | Name | Type | Description | Notes |
140
+ | ---- | ---- | ----------- | ----- |
141
+ | **npm_npm_remote_href** | **String** | | |
107
142
 
108
143
  ### Return type
109
144
 
@@ -121,16 +156,16 @@ Name | Type | Description | Notes
121
156
 
122
157
  ## list
123
158
 
124
- > PaginatednpmNpmRemoteResponseList list(opts)
159
+ > <PaginatednpmNpmRemoteResponseList> list(opts)
125
160
 
126
161
  List npm remotes
127
162
 
128
163
  A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
129
164
 
130
- ### Example
165
+ ### Examples
131
166
 
132
167
  ```ruby
133
- # load the gem
168
+ require 'time'
134
169
  require 'pulp_npm_client'
135
170
  # setup authorization
136
171
  PulpNpmClient.configure do |config|
@@ -142,55 +177,90 @@ end
142
177
  api_instance = PulpNpmClient::RemotesNpmApi.new
143
178
  opts = {
144
179
  limit: 56, # Integer | Number of results to return per page.
145
- name: 'name_example', # String |
180
+ name: 'name_example', # String | Filter results where name matches value
146
181
  name__contains: 'name__contains_example', # String | Filter results where name contains value
147
182
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
148
- name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
183
+ name__iexact: 'name__iexact_example', # String | Filter results where name matches value
184
+ name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
185
+ name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
186
+ name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
187
+ name__regex: 'name__regex_example', # String | Filter results where name matches regex value
149
188
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
150
189
  offset: 56, # Integer | The initial index from which to return the results.
151
- ordering: ['ordering_example'], # Array<String> | Ordering
190
+ ordering: ['-ca_cert'], # Array<String> | 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)
191
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
192
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
193
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
152
194
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
153
- pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
154
- pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
155
- pulp_last_updated__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than or equal to value
156
- pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
157
- pulp_last_updated__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than or equal to value
158
- pulp_last_updated__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_last_updated is between two comma separated values
159
- fields: 'fields_example', # String | A list of fields to include in the response.
160
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
195
+ pulp_last_updated: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated matches value
196
+ pulp_last_updated__gt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is greater than value
197
+ pulp_last_updated__gte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is greater than or equal to value
198
+ pulp_last_updated__isnull: true, # Boolean | Filter results where pulp_last_updated has a null value
199
+ pulp_last_updated__lt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is less than value
200
+ pulp_last_updated__lte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is less than or equal to value
201
+ pulp_last_updated__range: [Time.now], # Array<Time> | Filter results where pulp_last_updated is between two comma separated values
202
+ q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
203
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
204
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
161
205
  }
162
206
 
163
207
  begin
164
- #List npm remotes
208
+ # List npm remotes
165
209
  result = api_instance.list(opts)
166
210
  p result
167
211
  rescue PulpNpmClient::ApiError => e
168
- puts "Exception when calling RemotesNpmApi->list: #{e}"
212
+ puts "Error when calling RemotesNpmApi->list: #{e}"
169
213
  end
170
214
  ```
171
215
 
172
- ### Parameters
216
+ #### Using the list_with_http_info variant
217
+
218
+ This returns an Array which contains the response data, status code and headers.
219
+
220
+ > <Array(<PaginatednpmNpmRemoteResponseList>, Integer, Hash)> list_with_http_info(opts)
221
+
222
+ ```ruby
223
+ begin
224
+ # List npm remotes
225
+ data, status_code, headers = api_instance.list_with_http_info(opts)
226
+ p status_code # => 2xx
227
+ p headers # => { ... }
228
+ p data # => <PaginatednpmNpmRemoteResponseList>
229
+ rescue PulpNpmClient::ApiError => e
230
+ puts "Error when calling RemotesNpmApi->list_with_http_info: #{e}"
231
+ end
232
+ ```
173
233
 
234
+ ### Parameters
174
235
 
175
- Name | Type | Description | Notes
176
- ------------- | ------------- | ------------- | -------------
177
- **limit** | **Integer**| Number of results to return per page. | [optional]
178
- **name** | **String**| | [optional]
179
- **name__contains** | **String**| Filter results where name contains value | [optional]
180
- **name__icontains** | **String**| Filter results where name contains value | [optional]
181
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
182
- **name__startswith** | **String**| Filter results where name starts with value | [optional]
183
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
184
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
185
- **pulp_label_select** | **String**| Filter labels by search string | [optional]
186
- **pulp_last_updated** | **DateTime**| ISO 8601 formatted dates are supported | [optional]
187
- **pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional]
188
- **pulp_last_updated__gte** | **DateTime**| Filter results where pulp_last_updated is greater than or equal to value | [optional]
189
- **pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional]
190
- **pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional]
191
- **pulp_last_updated__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional]
192
- **fields** | **String**| A list of fields to include in the response. | [optional]
193
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
236
+ | Name | Type | Description | Notes |
237
+ | ---- | ---- | ----------- | ----- |
238
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
239
+ | **name** | **String** | Filter results where name matches value | [optional] |
240
+ | **name__contains** | **String** | Filter results where name contains value | [optional] |
241
+ | **name__icontains** | **String** | Filter results where name contains value | [optional] |
242
+ | **name__iexact** | **String** | Filter results where name matches value | [optional] |
243
+ | **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
244
+ | **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
245
+ | **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
246
+ | **name__regex** | **String** | Filter results where name matches regex value | [optional] |
247
+ | **name__startswith** | **String** | Filter results where name starts with value | [optional] |
248
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
249
+ | **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
250
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
251
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
252
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
253
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
254
+ | **pulp_last_updated** | **Time** | Filter results where pulp_last_updated matches value | [optional] |
255
+ | **pulp_last_updated__gt** | **Time** | Filter results where pulp_last_updated is greater than value | [optional] |
256
+ | **pulp_last_updated__gte** | **Time** | Filter results where pulp_last_updated is greater than or equal to value | [optional] |
257
+ | **pulp_last_updated__isnull** | **Boolean** | Filter results where pulp_last_updated has a null value | [optional] |
258
+ | **pulp_last_updated__lt** | **Time** | Filter results where pulp_last_updated is less than value | [optional] |
259
+ | **pulp_last_updated__lte** | **Time** | Filter results where pulp_last_updated is less than or equal to value | [optional] |
260
+ | **pulp_last_updated__range** | [**Array&lt;Time&gt;**](Time.md) | Filter results where pulp_last_updated is between two comma separated values | [optional] |
261
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
262
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
263
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
194
264
 
195
265
  ### Return type
196
266
 
@@ -208,16 +278,16 @@ Name | Type | Description | Notes
208
278
 
209
279
  ## partial_update
210
280
 
211
- > AsyncOperationResponse partial_update(npm_npm_remote_href, patchednpm_npm_remote)
281
+ > <AsyncOperationResponse> partial_update(npm_npm_remote_href, patchednpm_npm_remote)
212
282
 
213
283
  Update a npm remote
214
284
 
215
285
  Trigger an asynchronous partial update task
216
286
 
217
- ### Example
287
+ ### Examples
218
288
 
219
289
  ```ruby
220
- # load the gem
290
+ require 'time'
221
291
  require 'pulp_npm_client'
222
292
  # setup authorization
223
293
  PulpNpmClient.configure do |config|
@@ -231,21 +301,38 @@ npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
231
301
  patchednpm_npm_remote = PulpNpmClient::PatchednpmNpmRemote.new # PatchednpmNpmRemote |
232
302
 
233
303
  begin
234
- #Update a npm remote
304
+ # Update a npm remote
235
305
  result = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote)
236
306
  p result
237
307
  rescue PulpNpmClient::ApiError => e
238
- puts "Exception when calling RemotesNpmApi->partial_update: #{e}"
308
+ puts "Error when calling RemotesNpmApi->partial_update: #{e}"
239
309
  end
240
310
  ```
241
311
 
242
- ### Parameters
312
+ #### Using the partial_update_with_http_info variant
313
+
314
+ This returns an Array which contains the response data, status code and headers.
243
315
 
316
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(npm_npm_remote_href, patchednpm_npm_remote)
317
+
318
+ ```ruby
319
+ begin
320
+ # Update a npm remote
321
+ data, status_code, headers = api_instance.partial_update_with_http_info(npm_npm_remote_href, patchednpm_npm_remote)
322
+ p status_code # => 2xx
323
+ p headers # => { ... }
324
+ p data # => <AsyncOperationResponse>
325
+ rescue PulpNpmClient::ApiError => e
326
+ puts "Error when calling RemotesNpmApi->partial_update_with_http_info: #{e}"
327
+ end
328
+ ```
244
329
 
245
- Name | Type | Description | Notes
246
- ------------- | ------------- | ------------- | -------------
247
- **npm_npm_remote_href** | **String**| |
248
- **patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md)| |
330
+ ### Parameters
331
+
332
+ | Name | Type | Description | Notes |
333
+ | ---- | ---- | ----------- | ----- |
334
+ | **npm_npm_remote_href** | **String** | | |
335
+ | **patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md) | | |
249
336
 
250
337
  ### Return type
251
338
 
@@ -263,16 +350,16 @@ Name | Type | Description | Notes
263
350
 
264
351
  ## read
265
352
 
266
- > NpmNpmRemoteResponse read(npm_npm_remote_href, opts)
353
+ > <NpmNpmRemoteResponse> read(npm_npm_remote_href, opts)
267
354
 
268
355
  Inspect a npm remote
269
356
 
270
357
  A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
271
358
 
272
- ### Example
359
+ ### Examples
273
360
 
274
361
  ```ruby
275
- # load the gem
362
+ require 'time'
276
363
  require 'pulp_npm_client'
277
364
  # setup authorization
278
365
  PulpNpmClient.configure do |config|
@@ -284,27 +371,44 @@ end
284
371
  api_instance = PulpNpmClient::RemotesNpmApi.new
285
372
  npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
286
373
  opts = {
287
- fields: 'fields_example', # String | A list of fields to include in the response.
288
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
374
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
375
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
289
376
  }
290
377
 
291
378
  begin
292
- #Inspect a npm remote
379
+ # Inspect a npm remote
293
380
  result = api_instance.read(npm_npm_remote_href, opts)
294
381
  p result
295
382
  rescue PulpNpmClient::ApiError => e
296
- puts "Exception when calling RemotesNpmApi->read: #{e}"
383
+ puts "Error when calling RemotesNpmApi->read: #{e}"
297
384
  end
298
385
  ```
299
386
 
300
- ### Parameters
387
+ #### Using the read_with_http_info variant
388
+
389
+ This returns an Array which contains the response data, status code and headers.
390
+
391
+ > <Array(<NpmNpmRemoteResponse>, Integer, Hash)> read_with_http_info(npm_npm_remote_href, opts)
392
+
393
+ ```ruby
394
+ begin
395
+ # Inspect a npm remote
396
+ data, status_code, headers = api_instance.read_with_http_info(npm_npm_remote_href, opts)
397
+ p status_code # => 2xx
398
+ p headers # => { ... }
399
+ p data # => <NpmNpmRemoteResponse>
400
+ rescue PulpNpmClient::ApiError => e
401
+ puts "Error when calling RemotesNpmApi->read_with_http_info: #{e}"
402
+ end
403
+ ```
301
404
 
405
+ ### Parameters
302
406
 
303
- Name | Type | Description | Notes
304
- ------------- | ------------- | ------------- | -------------
305
- **npm_npm_remote_href** | **String**| |
306
- **fields** | **String**| A list of fields to include in the response. | [optional]
307
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
407
+ | Name | Type | Description | Notes |
408
+ | ---- | ---- | ----------- | ----- |
409
+ | **npm_npm_remote_href** | **String** | | |
410
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
411
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
308
412
 
309
413
  ### Return type
310
414
 
@@ -320,18 +424,162 @@ Name | Type | Description | Notes
320
424
  - **Accept**: application/json
321
425
 
322
426
 
427
+ ## set_label
428
+
429
+ > <SetLabelResponse> set_label(npm_npm_remote_href, set_label)
430
+
431
+ Set a label
432
+
433
+ Set a single pulp_label on the object to a specific value or null.
434
+
435
+ ### Examples
436
+
437
+ ```ruby
438
+ require 'time'
439
+ require 'pulp_npm_client'
440
+ # setup authorization
441
+ PulpNpmClient.configure do |config|
442
+ # Configure HTTP basic authorization: basicAuth
443
+ config.username = 'YOUR USERNAME'
444
+ config.password = 'YOUR PASSWORD'
445
+ end
446
+
447
+ api_instance = PulpNpmClient::RemotesNpmApi.new
448
+ npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
449
+ set_label = PulpNpmClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
450
+
451
+ begin
452
+ # Set a label
453
+ result = api_instance.set_label(npm_npm_remote_href, set_label)
454
+ p result
455
+ rescue PulpNpmClient::ApiError => e
456
+ puts "Error when calling RemotesNpmApi->set_label: #{e}"
457
+ end
458
+ ```
459
+
460
+ #### Using the set_label_with_http_info variant
461
+
462
+ This returns an Array which contains the response data, status code and headers.
463
+
464
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(npm_npm_remote_href, set_label)
465
+
466
+ ```ruby
467
+ begin
468
+ # Set a label
469
+ data, status_code, headers = api_instance.set_label_with_http_info(npm_npm_remote_href, set_label)
470
+ p status_code # => 2xx
471
+ p headers # => { ... }
472
+ p data # => <SetLabelResponse>
473
+ rescue PulpNpmClient::ApiError => e
474
+ puts "Error when calling RemotesNpmApi->set_label_with_http_info: #{e}"
475
+ end
476
+ ```
477
+
478
+ ### Parameters
479
+
480
+ | Name | Type | Description | Notes |
481
+ | ---- | ---- | ----------- | ----- |
482
+ | **npm_npm_remote_href** | **String** | | |
483
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
484
+
485
+ ### Return type
486
+
487
+ [**SetLabelResponse**](SetLabelResponse.md)
488
+
489
+ ### Authorization
490
+
491
+ [basicAuth](../README.md#basicAuth)
492
+
493
+ ### HTTP request headers
494
+
495
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
496
+ - **Accept**: application/json
497
+
498
+
499
+ ## unset_label
500
+
501
+ > <UnsetLabelResponse> unset_label(npm_npm_remote_href, unset_label)
502
+
503
+ Unset a label
504
+
505
+ Unset a single pulp_label on the object.
506
+
507
+ ### Examples
508
+
509
+ ```ruby
510
+ require 'time'
511
+ require 'pulp_npm_client'
512
+ # setup authorization
513
+ PulpNpmClient.configure do |config|
514
+ # Configure HTTP basic authorization: basicAuth
515
+ config.username = 'YOUR USERNAME'
516
+ config.password = 'YOUR PASSWORD'
517
+ end
518
+
519
+ api_instance = PulpNpmClient::RemotesNpmApi.new
520
+ npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
521
+ unset_label = PulpNpmClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
522
+
523
+ begin
524
+ # Unset a label
525
+ result = api_instance.unset_label(npm_npm_remote_href, unset_label)
526
+ p result
527
+ rescue PulpNpmClient::ApiError => e
528
+ puts "Error when calling RemotesNpmApi->unset_label: #{e}"
529
+ end
530
+ ```
531
+
532
+ #### Using the unset_label_with_http_info variant
533
+
534
+ This returns an Array which contains the response data, status code and headers.
535
+
536
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(npm_npm_remote_href, unset_label)
537
+
538
+ ```ruby
539
+ begin
540
+ # Unset a label
541
+ data, status_code, headers = api_instance.unset_label_with_http_info(npm_npm_remote_href, unset_label)
542
+ p status_code # => 2xx
543
+ p headers # => { ... }
544
+ p data # => <UnsetLabelResponse>
545
+ rescue PulpNpmClient::ApiError => e
546
+ puts "Error when calling RemotesNpmApi->unset_label_with_http_info: #{e}"
547
+ end
548
+ ```
549
+
550
+ ### Parameters
551
+
552
+ | Name | Type | Description | Notes |
553
+ | ---- | ---- | ----------- | ----- |
554
+ | **npm_npm_remote_href** | **String** | | |
555
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
556
+
557
+ ### Return type
558
+
559
+ [**UnsetLabelResponse**](UnsetLabelResponse.md)
560
+
561
+ ### Authorization
562
+
563
+ [basicAuth](../README.md#basicAuth)
564
+
565
+ ### HTTP request headers
566
+
567
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
568
+ - **Accept**: application/json
569
+
570
+
323
571
  ## update
324
572
 
325
- > AsyncOperationResponse update(npm_npm_remote_href, npm_npm_remote)
573
+ > <AsyncOperationResponse> update(npm_npm_remote_href, npm_npm_remote)
326
574
 
327
575
  Update a npm remote
328
576
 
329
577
  Trigger an asynchronous update task
330
578
 
331
- ### Example
579
+ ### Examples
332
580
 
333
581
  ```ruby
334
- # load the gem
582
+ require 'time'
335
583
  require 'pulp_npm_client'
336
584
  # setup authorization
337
585
  PulpNpmClient.configure do |config|
@@ -342,24 +590,41 @@ end
342
590
 
343
591
  api_instance = PulpNpmClient::RemotesNpmApi.new
344
592
  npm_npm_remote_href = 'npm_npm_remote_href_example' # String |
345
- npm_npm_remote = PulpNpmClient::NpmNpmRemote.new # NpmNpmRemote |
593
+ npm_npm_remote = PulpNpmClient::NpmNpmRemote.new({name: 'name_example', url: 'url_example'}) # NpmNpmRemote |
346
594
 
347
595
  begin
348
- #Update a npm remote
596
+ # Update a npm remote
349
597
  result = api_instance.update(npm_npm_remote_href, npm_npm_remote)
350
598
  p result
351
599
  rescue PulpNpmClient::ApiError => e
352
- puts "Exception when calling RemotesNpmApi->update: #{e}"
600
+ puts "Error when calling RemotesNpmApi->update: #{e}"
353
601
  end
354
602
  ```
355
603
 
356
- ### Parameters
604
+ #### Using the update_with_http_info variant
357
605
 
606
+ This returns an Array which contains the response data, status code and headers.
607
+
608
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(npm_npm_remote_href, npm_npm_remote)
609
+
610
+ ```ruby
611
+ begin
612
+ # Update a npm remote
613
+ data, status_code, headers = api_instance.update_with_http_info(npm_npm_remote_href, npm_npm_remote)
614
+ p status_code # => 2xx
615
+ p headers # => { ... }
616
+ p data # => <AsyncOperationResponse>
617
+ rescue PulpNpmClient::ApiError => e
618
+ puts "Error when calling RemotesNpmApi->update_with_http_info: #{e}"
619
+ end
620
+ ```
621
+
622
+ ### Parameters
358
623
 
359
- Name | Type | Description | Notes
360
- ------------- | ------------- | ------------- | -------------
361
- **npm_npm_remote_href** | **String**| |
362
- **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| |
624
+ | Name | Type | Description | Notes |
625
+ | ---- | ---- | ----------- | ----- |
626
+ | **npm_npm_remote_href** | **String** | | |
627
+ | **npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md) | | |
363
628
 
364
629
  ### Return type
365
630