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::DistributionsNpmApi
2
2
 
3
- All URIs are relative to *https://pulp*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create**](DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ | Create a npm distribution
8
- [**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution
9
- [**list**](DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions
10
- [**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution
11
- [**read**](DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution
12
- [**update**](DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution
3
+ All URIs are relative to *http://localhost:24817*
13
4
 
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create**](DistributionsNpmApi.md#create) | **POST** /pulp/api/v3/distributions/npm/npm/ | Create a npm distribution |
8
+ | [**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution |
9
+ | [**list**](DistributionsNpmApi.md#list) | **GET** /pulp/api/v3/distributions/npm/npm/ | List npm distributions |
10
+ | [**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution |
11
+ | [**read**](DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution |
12
+ | [**set_label**](DistributionsNpmApi.md#set_label) | **POST** {npm_npm_distribution_href}set_label/ | Set a label |
13
+ | [**unset_label**](DistributionsNpmApi.md#unset_label) | **POST** {npm_npm_distribution_href}unset_label/ | Unset a label |
14
+ | [**update**](DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution |
14
15
 
15
16
 
16
17
  ## create
17
18
 
18
- > AsyncOperationResponse create(npm_npm_distribution)
19
+ > <AsyncOperationResponse> create(npm_npm_distribution)
19
20
 
20
21
  Create a npm distribution
21
22
 
22
23
  Trigger an asynchronous create task
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::DistributionsNpmApi.new
37
- npm_npm_distribution = PulpNpmClient::NpmNpmDistribution.new # NpmNpmDistribution |
38
+ npm_npm_distribution = PulpNpmClient::NpmNpmDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # NpmNpmDistribution |
38
39
 
39
40
  begin
40
- #Create a npm distribution
41
+ # Create a npm distribution
41
42
  result = api_instance.create(npm_npm_distribution)
42
43
  p result
43
44
  rescue PulpNpmClient::ApiError => e
44
- puts "Exception when calling DistributionsNpmApi->create: #{e}"
45
+ puts "Error when calling DistributionsNpmApi->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(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(npm_npm_distribution)
54
+
55
+ ```ruby
56
+ begin
57
+ # Create a npm distribution
58
+ data, status_code, headers = api_instance.create_with_http_info(npm_npm_distribution)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => <AsyncOperationResponse>
62
+ rescue PulpNpmClient::ApiError => e
63
+ puts "Error when calling DistributionsNpmApi->create_with_http_info: #{e}"
64
+ end
65
+ ```
49
66
 
67
+ ### Parameters
50
68
 
51
- Name | Type | Description | Notes
52
- ------------- | ------------- | ------------- | -------------
53
- **npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| |
69
+ | Name | Type | Description | Notes |
70
+ | ---- | ---- | ----------- | ----- |
71
+ | **npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.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_distribution_href)
89
+ > <AsyncOperationResponse> delete(npm_npm_distribution_href)
72
90
 
73
91
  Delete a npm distribution
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::DistributionsNpmApi.new
90
108
  npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String |
91
109
 
92
110
  begin
93
- #Delete a npm distribution
111
+ # Delete a npm distribution
94
112
  result = api_instance.delete(npm_npm_distribution_href)
95
113
  p result
96
114
  rescue PulpNpmClient::ApiError => e
97
- puts "Exception when calling DistributionsNpmApi->delete: #{e}"
115
+ puts "Error when calling DistributionsNpmApi->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_distribution_href)
124
+
125
+ ```ruby
126
+ begin
127
+ # Delete a npm distribution
128
+ data, status_code, headers = api_instance.delete_with_http_info(npm_npm_distribution_href)
129
+ p status_code # => 2xx
130
+ p headers # => { ... }
131
+ p data # => <AsyncOperationResponse>
132
+ rescue PulpNpmClient::ApiError => e
133
+ puts "Error when calling DistributionsNpmApi->delete_with_http_info: #{e}"
134
+ end
135
+ ```
102
136
 
137
+ ### Parameters
103
138
 
104
- Name | Type | Description | Notes
105
- ------------- | ------------- | ------------- | -------------
106
- **npm_npm_distribution_href** | **String**| |
139
+ | Name | Type | Description | Notes |
140
+ | ---- | ---- | ----------- | ----- |
141
+ | **npm_npm_distribution_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
- > PaginatednpmNpmDistributionResponseList list(opts)
159
+ > <PaginatednpmNpmDistributionResponseList> list(opts)
125
160
 
126
161
  List npm distributions
127
162
 
128
163
  ViewSet for NPM Distributions.
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|
@@ -141,52 +176,91 @@ end
141
176
 
142
177
  api_instance = PulpNpmClient::DistributionsNpmApi.new
143
178
  opts = {
144
- base_path: 'base_path_example', # String |
179
+ base_path: 'base_path_example', # String | Filter results where base_path matches value
145
180
  base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
146
181
  base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
147
- base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
182
+ base_path__in: ['inner_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
148
183
  limit: 56, # Integer | Number of results to return per page.
149
- name: 'name_example', # String |
184
+ name: 'name_example', # String | Filter results where name matches value
150
185
  name__contains: 'name__contains_example', # String | Filter results where name contains value
151
186
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
152
- name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
187
+ name__iexact: 'name__iexact_example', # String | Filter results where name matches value
188
+ name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
189
+ name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
190
+ name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
191
+ name__regex: 'name__regex_example', # String | Filter results where name matches regex value
153
192
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
154
193
  offset: 56, # Integer | The initial index from which to return the results.
155
- ordering: ['ordering_example'], # Array<String> | Ordering
194
+ ordering: ['-base_path'], # 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) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
195
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
196
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
197
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
156
198
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
157
- fields: 'fields_example', # String | A list of fields to include in the response.
158
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
199
+ q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
200
+ repository: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter results where repository matches value
201
+ repository__in: ['inner_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
202
+ with_content: 'with_content_example', # String | Filter distributions based on the content served by them
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.
159
205
  }
160
206
 
161
207
  begin
162
- #List npm distributions
208
+ # List npm distributions
163
209
  result = api_instance.list(opts)
164
210
  p result
165
211
  rescue PulpNpmClient::ApiError => e
166
- puts "Exception when calling DistributionsNpmApi->list: #{e}"
212
+ puts "Error when calling DistributionsNpmApi->list: #{e}"
167
213
  end
168
214
  ```
169
215
 
170
- ### 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(<PaginatednpmNpmDistributionResponseList>, Integer, Hash)> list_with_http_info(opts)
221
+
222
+ ```ruby
223
+ begin
224
+ # List npm distributions
225
+ data, status_code, headers = api_instance.list_with_http_info(opts)
226
+ p status_code # => 2xx
227
+ p headers # => { ... }
228
+ p data # => <PaginatednpmNpmDistributionResponseList>
229
+ rescue PulpNpmClient::ApiError => e
230
+ puts "Error when calling DistributionsNpmApi->list_with_http_info: #{e}"
231
+ end
232
+ ```
171
233
 
234
+ ### Parameters
172
235
 
173
- Name | Type | Description | Notes
174
- ------------- | ------------- | ------------- | -------------
175
- **base_path** | **String**| | [optional]
176
- **base_path__contains** | **String**| Filter results where base_path contains value | [optional]
177
- **base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
178
- **base_path__in** | [**Array&lt;String&gt;**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional]
179
- **limit** | **Integer**| Number of results to return per page. | [optional]
180
- **name** | **String**| | [optional]
181
- **name__contains** | **String**| Filter results where name contains value | [optional]
182
- **name__icontains** | **String**| Filter results where name contains value | [optional]
183
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
184
- **name__startswith** | **String**| Filter results where name starts with value | [optional]
185
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
186
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
187
- **pulp_label_select** | **String**| Filter labels by search string | [optional]
188
- **fields** | **String**| A list of fields to include in the response. | [optional]
189
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
236
+ | Name | Type | Description | Notes |
237
+ | ---- | ---- | ----------- | ----- |
238
+ | **base_path** | **String** | Filter results where base_path matches value | [optional] |
239
+ | **base_path__contains** | **String** | Filter results where base_path contains value | [optional] |
240
+ | **base_path__icontains** | **String** | Filter results where base_path contains value | [optional] |
241
+ | **base_path__in** | [**Array&lt;String&gt;**](String.md) | Filter results where base_path is in a comma-separated list of values | [optional] |
242
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
243
+ | **name** | **String** | Filter results where name matches value | [optional] |
244
+ | **name__contains** | **String** | Filter results where name contains value | [optional] |
245
+ | **name__icontains** | **String** | Filter results where name contains value | [optional] |
246
+ | **name__iexact** | **String** | Filter results where name matches value | [optional] |
247
+ | **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
248
+ | **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
249
+ | **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
250
+ | **name__regex** | **String** | Filter results where name matches regex value | [optional] |
251
+ | **name__startswith** | **String** | Filter results where name starts with value | [optional] |
252
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
253
+ | **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;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
254
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
255
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
256
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
257
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
258
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
259
+ | **repository** | **String** | Filter results where repository matches value | [optional] |
260
+ | **repository__in** | [**Array&lt;String&gt;**](String.md) | Filter results where repository is in a comma-separated list of values | [optional] |
261
+ | **with_content** | **String** | Filter distributions based on the content served by them | [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] |
190
264
 
191
265
  ### Return type
192
266
 
@@ -204,16 +278,16 @@ Name | Type | Description | Notes
204
278
 
205
279
  ## partial_update
206
280
 
207
- > AsyncOperationResponse partial_update(npm_npm_distribution_href, patchednpm_npm_distribution)
281
+ > <AsyncOperationResponse> partial_update(npm_npm_distribution_href, patchednpm_npm_distribution)
208
282
 
209
283
  Update a npm distribution
210
284
 
211
285
  Trigger an asynchronous partial update task
212
286
 
213
- ### Example
287
+ ### Examples
214
288
 
215
289
  ```ruby
216
- # load the gem
290
+ require 'time'
217
291
  require 'pulp_npm_client'
218
292
  # setup authorization
219
293
  PulpNpmClient.configure do |config|
@@ -227,21 +301,38 @@ npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String |
227
301
  patchednpm_npm_distribution = PulpNpmClient::PatchednpmNpmDistribution.new # PatchednpmNpmDistribution |
228
302
 
229
303
  begin
230
- #Update a npm distribution
304
+ # Update a npm distribution
231
305
  result = api_instance.partial_update(npm_npm_distribution_href, patchednpm_npm_distribution)
232
306
  p result
233
307
  rescue PulpNpmClient::ApiError => e
234
- puts "Exception when calling DistributionsNpmApi->partial_update: #{e}"
308
+ puts "Error when calling DistributionsNpmApi->partial_update: #{e}"
235
309
  end
236
310
  ```
237
311
 
238
- ### 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.
239
315
 
316
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(npm_npm_distribution_href, patchednpm_npm_distribution)
317
+
318
+ ```ruby
319
+ begin
320
+ # Update a npm distribution
321
+ data, status_code, headers = api_instance.partial_update_with_http_info(npm_npm_distribution_href, patchednpm_npm_distribution)
322
+ p status_code # => 2xx
323
+ p headers # => { ... }
324
+ p data # => <AsyncOperationResponse>
325
+ rescue PulpNpmClient::ApiError => e
326
+ puts "Error when calling DistributionsNpmApi->partial_update_with_http_info: #{e}"
327
+ end
328
+ ```
240
329
 
241
- Name | Type | Description | Notes
242
- ------------- | ------------- | ------------- | -------------
243
- **npm_npm_distribution_href** | **String**| |
244
- **patchednpm_npm_distribution** | [**PatchednpmNpmDistribution**](PatchednpmNpmDistribution.md)| |
330
+ ### Parameters
331
+
332
+ | Name | Type | Description | Notes |
333
+ | ---- | ---- | ----------- | ----- |
334
+ | **npm_npm_distribution_href** | **String** | | |
335
+ | **patchednpm_npm_distribution** | [**PatchednpmNpmDistribution**](PatchednpmNpmDistribution.md) | | |
245
336
 
246
337
  ### Return type
247
338
 
@@ -259,16 +350,16 @@ Name | Type | Description | Notes
259
350
 
260
351
  ## read
261
352
 
262
- > NpmNpmDistributionResponse read(npm_npm_distribution_href, opts)
353
+ > <NpmNpmDistributionResponse> read(npm_npm_distribution_href, opts)
263
354
 
264
355
  Inspect a npm distribution
265
356
 
266
357
  ViewSet for NPM Distributions.
267
358
 
268
- ### Example
359
+ ### Examples
269
360
 
270
361
  ```ruby
271
- # load the gem
362
+ require 'time'
272
363
  require 'pulp_npm_client'
273
364
  # setup authorization
274
365
  PulpNpmClient.configure do |config|
@@ -280,27 +371,44 @@ end
280
371
  api_instance = PulpNpmClient::DistributionsNpmApi.new
281
372
  npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String |
282
373
  opts = {
283
- fields: 'fields_example', # String | A list of fields to include in the response.
284
- 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.
285
376
  }
286
377
 
287
378
  begin
288
- #Inspect a npm distribution
379
+ # Inspect a npm distribution
289
380
  result = api_instance.read(npm_npm_distribution_href, opts)
290
381
  p result
291
382
  rescue PulpNpmClient::ApiError => e
292
- puts "Exception when calling DistributionsNpmApi->read: #{e}"
383
+ puts "Error when calling DistributionsNpmApi->read: #{e}"
293
384
  end
294
385
  ```
295
386
 
296
- ### 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(<NpmNpmDistributionResponse>, Integer, Hash)> read_with_http_info(npm_npm_distribution_href, opts)
392
+
393
+ ```ruby
394
+ begin
395
+ # Inspect a npm distribution
396
+ data, status_code, headers = api_instance.read_with_http_info(npm_npm_distribution_href, opts)
397
+ p status_code # => 2xx
398
+ p headers # => { ... }
399
+ p data # => <NpmNpmDistributionResponse>
400
+ rescue PulpNpmClient::ApiError => e
401
+ puts "Error when calling DistributionsNpmApi->read_with_http_info: #{e}"
402
+ end
403
+ ```
297
404
 
405
+ ### Parameters
298
406
 
299
- Name | Type | Description | Notes
300
- ------------- | ------------- | ------------- | -------------
301
- **npm_npm_distribution_href** | **String**| |
302
- **fields** | **String**| A list of fields to include in the response. | [optional]
303
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
407
+ | Name | Type | Description | Notes |
408
+ | ---- | ---- | ----------- | ----- |
409
+ | **npm_npm_distribution_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] |
304
412
 
305
413
  ### Return type
306
414
 
@@ -316,18 +424,162 @@ Name | Type | Description | Notes
316
424
  - **Accept**: application/json
317
425
 
318
426
 
427
+ ## set_label
428
+
429
+ > <SetLabelResponse> set_label(npm_npm_distribution_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::DistributionsNpmApi.new
448
+ npm_npm_distribution_href = 'npm_npm_distribution_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_distribution_href, set_label)
454
+ p result
455
+ rescue PulpNpmClient::ApiError => e
456
+ puts "Error when calling DistributionsNpmApi->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_distribution_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_distribution_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 DistributionsNpmApi->set_label_with_http_info: #{e}"
475
+ end
476
+ ```
477
+
478
+ ### Parameters
479
+
480
+ | Name | Type | Description | Notes |
481
+ | ---- | ---- | ----------- | ----- |
482
+ | **npm_npm_distribution_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_distribution_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::DistributionsNpmApi.new
520
+ npm_npm_distribution_href = 'npm_npm_distribution_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_distribution_href, unset_label)
526
+ p result
527
+ rescue PulpNpmClient::ApiError => e
528
+ puts "Error when calling DistributionsNpmApi->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_distribution_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_distribution_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 DistributionsNpmApi->unset_label_with_http_info: #{e}"
547
+ end
548
+ ```
549
+
550
+ ### Parameters
551
+
552
+ | Name | Type | Description | Notes |
553
+ | ---- | ---- | ----------- | ----- |
554
+ | **npm_npm_distribution_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
+
319
571
  ## update
320
572
 
321
- > AsyncOperationResponse update(npm_npm_distribution_href, npm_npm_distribution)
573
+ > <AsyncOperationResponse> update(npm_npm_distribution_href, npm_npm_distribution)
322
574
 
323
575
  Update a npm distribution
324
576
 
325
577
  Trigger an asynchronous update task
326
578
 
327
- ### Example
579
+ ### Examples
328
580
 
329
581
  ```ruby
330
- # load the gem
582
+ require 'time'
331
583
  require 'pulp_npm_client'
332
584
  # setup authorization
333
585
  PulpNpmClient.configure do |config|
@@ -338,24 +590,41 @@ end
338
590
 
339
591
  api_instance = PulpNpmClient::DistributionsNpmApi.new
340
592
  npm_npm_distribution_href = 'npm_npm_distribution_href_example' # String |
341
- npm_npm_distribution = PulpNpmClient::NpmNpmDistribution.new # NpmNpmDistribution |
593
+ npm_npm_distribution = PulpNpmClient::NpmNpmDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # NpmNpmDistribution |
342
594
 
343
595
  begin
344
- #Update a npm distribution
596
+ # Update a npm distribution
345
597
  result = api_instance.update(npm_npm_distribution_href, npm_npm_distribution)
346
598
  p result
347
599
  rescue PulpNpmClient::ApiError => e
348
- puts "Exception when calling DistributionsNpmApi->update: #{e}"
600
+ puts "Error when calling DistributionsNpmApi->update: #{e}"
349
601
  end
350
602
  ```
351
603
 
352
- ### Parameters
604
+ #### Using the update_with_http_info variant
353
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_distribution_href, npm_npm_distribution)
609
+
610
+ ```ruby
611
+ begin
612
+ # Update a npm distribution
613
+ data, status_code, headers = api_instance.update_with_http_info(npm_npm_distribution_href, npm_npm_distribution)
614
+ p status_code # => 2xx
615
+ p headers # => { ... }
616
+ p data # => <AsyncOperationResponse>
617
+ rescue PulpNpmClient::ApiError => e
618
+ puts "Error when calling DistributionsNpmApi->update_with_http_info: #{e}"
619
+ end
620
+ ```
621
+
622
+ ### Parameters
354
623
 
355
- Name | Type | Description | Notes
356
- ------------- | ------------- | ------------- | -------------
357
- **npm_npm_distribution_href** | **String**| |
358
- **npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| |
624
+ | Name | Type | Description | Notes |
625
+ | ---- | ---- | ----------- | ----- |
626
+ | **npm_npm_distribution_href** | **String** | | |
627
+ | **npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md) | | |
359
628
 
360
629
  ### Return type
361
630