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,32 +1,33 @@
1
1
  # PulpNpmClient::RepositoriesNpmApi
2
2
 
3
- All URIs are relative to *https://pulp*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create**](RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | Create a npm repository
8
- [**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
9
- [**list**](RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | List npm repositorys
10
- [**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
11
- [**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
12
- [**read**](RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
13
- [**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
14
- [**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository
15
-
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create**](RepositoriesNpmApi.md#create) | **POST** /pulp/api/v3/repositories/npm/npm/ | Create a npm repository |
8
+ | [**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository |
9
+ | [**list**](RepositoriesNpmApi.md#list) | **GET** /pulp/api/v3/repositories/npm/npm/ | List npm repositorys |
10
+ | [**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content |
11
+ | [**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository |
12
+ | [**read**](RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository |
13
+ | [**set_label**](RepositoriesNpmApi.md#set_label) | **POST** {npm_npm_repository_href}set_label/ | Set a label |
14
+ | [**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote |
15
+ | [**unset_label**](RepositoriesNpmApi.md#unset_label) | **POST** {npm_npm_repository_href}unset_label/ | Unset a label |
16
+ | [**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository |
16
17
 
17
18
 
18
19
  ## create
19
20
 
20
- > NpmNpmRepositoryResponse create(npm_npm_repository)
21
+ > <NpmNpmRepositoryResponse> create(npm_npm_repository)
21
22
 
22
23
  Create a npm repository
23
24
 
24
25
  A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
25
26
 
26
- ### Example
27
+ ### Examples
27
28
 
28
29
  ```ruby
29
- # load the gem
30
+ require 'time'
30
31
  require 'pulp_npm_client'
31
32
  # setup authorization
32
33
  PulpNpmClient.configure do |config|
@@ -36,23 +37,40 @@ PulpNpmClient.configure do |config|
36
37
  end
37
38
 
38
39
  api_instance = PulpNpmClient::RepositoriesNpmApi.new
39
- npm_npm_repository = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository |
40
+ npm_npm_repository = PulpNpmClient::NpmNpmRepository.new({name: 'name_example'}) # NpmNpmRepository |
40
41
 
41
42
  begin
42
- #Create a npm repository
43
+ # Create a npm repository
43
44
  result = api_instance.create(npm_npm_repository)
44
45
  p result
45
46
  rescue PulpNpmClient::ApiError => e
46
- puts "Exception when calling RepositoriesNpmApi->create: #{e}"
47
+ puts "Error when calling RepositoriesNpmApi->create: #{e}"
47
48
  end
48
49
  ```
49
50
 
50
- ### Parameters
51
+ #### Using the create_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(<NpmNpmRepositoryResponse>, Integer, Hash)> create_with_http_info(npm_npm_repository)
56
+
57
+ ```ruby
58
+ begin
59
+ # Create a npm repository
60
+ data, status_code, headers = api_instance.create_with_http_info(npm_npm_repository)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => <NpmNpmRepositoryResponse>
64
+ rescue PulpNpmClient::ApiError => e
65
+ puts "Error when calling RepositoriesNpmApi->create_with_http_info: #{e}"
66
+ end
67
+ ```
51
68
 
69
+ ### Parameters
52
70
 
53
- Name | Type | Description | Notes
54
- ------------- | ------------- | ------------- | -------------
55
- **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)| |
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md) | | |
56
74
 
57
75
  ### Return type
58
76
 
@@ -70,16 +88,16 @@ Name | Type | Description | Notes
70
88
 
71
89
  ## delete
72
90
 
73
- > AsyncOperationResponse delete(npm_npm_repository_href)
91
+ > <AsyncOperationResponse> delete(npm_npm_repository_href)
74
92
 
75
93
  Delete a npm repository
76
94
 
77
95
  Trigger an asynchronous delete task
78
96
 
79
- ### Example
97
+ ### Examples
80
98
 
81
99
  ```ruby
82
- # load the gem
100
+ require 'time'
83
101
  require 'pulp_npm_client'
84
102
  # setup authorization
85
103
  PulpNpmClient.configure do |config|
@@ -92,20 +110,37 @@ api_instance = PulpNpmClient::RepositoriesNpmApi.new
92
110
  npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
93
111
 
94
112
  begin
95
- #Delete a npm repository
113
+ # Delete a npm repository
96
114
  result = api_instance.delete(npm_npm_repository_href)
97
115
  p result
98
116
  rescue PulpNpmClient::ApiError => e
99
- puts "Exception when calling RepositoriesNpmApi->delete: #{e}"
117
+ puts "Error when calling RepositoriesNpmApi->delete: #{e}"
100
118
  end
101
119
  ```
102
120
 
103
- ### Parameters
121
+ #### Using the delete_with_http_info variant
104
122
 
123
+ This returns an Array which contains the response data, status code and headers.
105
124
 
106
- Name | Type | Description | Notes
107
- ------------- | ------------- | ------------- | -------------
108
- **npm_npm_repository_href** | **String**| |
125
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(npm_npm_repository_href)
126
+
127
+ ```ruby
128
+ begin
129
+ # Delete a npm repository
130
+ data, status_code, headers = api_instance.delete_with_http_info(npm_npm_repository_href)
131
+ p status_code # => 2xx
132
+ p headers # => { ... }
133
+ p data # => <AsyncOperationResponse>
134
+ rescue PulpNpmClient::ApiError => e
135
+ puts "Error when calling RepositoriesNpmApi->delete_with_http_info: #{e}"
136
+ end
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ | Name | Type | Description | Notes |
142
+ | ---- | ---- | ----------- | ----- |
143
+ | **npm_npm_repository_href** | **String** | | |
109
144
 
110
145
  ### Return type
111
146
 
@@ -123,16 +158,16 @@ Name | Type | Description | Notes
123
158
 
124
159
  ## list
125
160
 
126
- > PaginatednpmNpmRepositoryResponseList list(opts)
161
+ > <PaginatednpmNpmRepositoryResponseList> list(opts)
127
162
 
128
163
  List npm repositorys
129
164
 
130
165
  A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
131
166
 
132
- ### Example
167
+ ### Examples
133
168
 
134
169
  ```ruby
135
- # load the gem
170
+ require 'time'
136
171
  require 'pulp_npm_client'
137
172
  # setup authorization
138
173
  PulpNpmClient.configure do |config|
@@ -143,44 +178,99 @@ end
143
178
 
144
179
  api_instance = PulpNpmClient::RepositoriesNpmApi.new
145
180
  opts = {
181
+ latest_with_content: 'latest_with_content_example', # String | Content Unit referenced by HREF/PRN
146
182
  limit: 56, # Integer | Number of results to return per page.
147
- name: 'name_example', # String |
183
+ name: 'name_example', # String | Filter results where name matches value
148
184
  name__contains: 'name__contains_example', # String | Filter results where name contains value
149
185
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
150
- name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
186
+ name__iexact: 'name__iexact_example', # String | Filter results where name matches value
187
+ name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
188
+ name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
189
+ name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
190
+ name__regex: 'name__regex_example', # String | Filter results where name matches regex value
151
191
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
152
192
  offset: 56, # Integer | The initial index from which to return the results.
153
- ordering: ['ordering_example'], # Array<String> | Ordering
193
+ ordering: ['-description'], # 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) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
194
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
195
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
196
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
154
197
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
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.
198
+ q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
199
+ remote: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Foreign Key referenced by HREF
200
+ retain_repo_versions: 56, # Integer | Filter results where retain_repo_versions matches value
201
+ retain_repo_versions__gt: 56, # Integer | Filter results where retain_repo_versions is greater than value
202
+ retain_repo_versions__gte: 56, # Integer | Filter results where retain_repo_versions is greater than or equal to value
203
+ retain_repo_versions__isnull: true, # Boolean | Filter results where retain_repo_versions has a null value
204
+ retain_repo_versions__lt: 56, # Integer | Filter results where retain_repo_versions is less than value
205
+ retain_repo_versions__lte: 56, # Integer | Filter results where retain_repo_versions is less than or equal to value
206
+ retain_repo_versions__ne: 56, # Integer | Filter results where retain_repo_versions not equal to value
207
+ retain_repo_versions__range: [37], # Array<Integer> | Filter results where retain_repo_versions is between two comma separated values
208
+ with_content: 'with_content_example', # String | Content Unit referenced by HREF/PRN
209
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
210
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
157
211
  }
158
212
 
159
213
  begin
160
- #List npm repositorys
214
+ # List npm repositorys
161
215
  result = api_instance.list(opts)
162
216
  p result
163
217
  rescue PulpNpmClient::ApiError => e
164
- puts "Exception when calling RepositoriesNpmApi->list: #{e}"
218
+ puts "Error when calling RepositoriesNpmApi->list: #{e}"
165
219
  end
166
220
  ```
167
221
 
168
- ### Parameters
222
+ #### Using the list_with_http_info variant
169
223
 
224
+ This returns an Array which contains the response data, status code and headers.
170
225
 
171
- Name | Type | Description | Notes
172
- ------------- | ------------- | ------------- | -------------
173
- **limit** | **Integer**| Number of results to return per page. | [optional]
174
- **name** | **String**| | [optional]
175
- **name__contains** | **String**| Filter results where name contains value | [optional]
176
- **name__icontains** | **String**| Filter results where name contains value | [optional]
177
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
178
- **name__startswith** | **String**| Filter results where name starts with value | [optional]
179
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
180
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional]
181
- **pulp_label_select** | **String**| Filter labels by search string | [optional]
182
- **fields** | **String**| A list of fields to include in the response. | [optional]
183
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
226
+ > <Array(<PaginatednpmNpmRepositoryResponseList>, Integer, Hash)> list_with_http_info(opts)
227
+
228
+ ```ruby
229
+ begin
230
+ # List npm repositorys
231
+ data, status_code, headers = api_instance.list_with_http_info(opts)
232
+ p status_code # => 2xx
233
+ p headers # => { ... }
234
+ p data # => <PaginatednpmNpmRepositoryResponseList>
235
+ rescue PulpNpmClient::ApiError => e
236
+ puts "Error when calling RepositoriesNpmApi->list_with_http_info: #{e}"
237
+ end
238
+ ```
239
+
240
+ ### Parameters
241
+
242
+ | Name | Type | Description | Notes |
243
+ | ---- | ---- | ----------- | ----- |
244
+ | **latest_with_content** | **String** | Content Unit referenced by HREF/PRN | [optional] |
245
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
246
+ | **name** | **String** | Filter results where name matches value | [optional] |
247
+ | **name__contains** | **String** | Filter results where name contains value | [optional] |
248
+ | **name__icontains** | **String** | Filter results where name contains value | [optional] |
249
+ | **name__iexact** | **String** | Filter results where name matches value | [optional] |
250
+ | **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
251
+ | **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
252
+ | **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
253
+ | **name__regex** | **String** | Filter results where name matches regex value | [optional] |
254
+ | **name__startswith** | **String** | Filter results where name starts with value | [optional] |
255
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
256
+ | **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;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;next_version&#x60; - Next version * &#x60;-next_version&#x60; - Next version (descending) * &#x60;retain_repo_versions&#x60; - Retain repo versions * &#x60;-retain_repo_versions&#x60; - Retain repo versions (descending) * &#x60;user_hidden&#x60; - User hidden * &#x60;-user_hidden&#x60; - User hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
257
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
258
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
259
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
260
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
261
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
262
+ | **remote** | **String** | Foreign Key referenced by HREF | [optional] |
263
+ | **retain_repo_versions** | **Integer** | Filter results where retain_repo_versions matches value | [optional] |
264
+ | **retain_repo_versions__gt** | **Integer** | Filter results where retain_repo_versions is greater than value | [optional] |
265
+ | **retain_repo_versions__gte** | **Integer** | Filter results where retain_repo_versions is greater than or equal to value | [optional] |
266
+ | **retain_repo_versions__isnull** | **Boolean** | Filter results where retain_repo_versions has a null value | [optional] |
267
+ | **retain_repo_versions__lt** | **Integer** | Filter results where retain_repo_versions is less than value | [optional] |
268
+ | **retain_repo_versions__lte** | **Integer** | Filter results where retain_repo_versions is less than or equal to value | [optional] |
269
+ | **retain_repo_versions__ne** | **Integer** | Filter results where retain_repo_versions not equal to value | [optional] |
270
+ | **retain_repo_versions__range** | [**Array&lt;Integer&gt;**](Integer.md) | Filter results where retain_repo_versions is between two comma separated values | [optional] |
271
+ | **with_content** | **String** | Content Unit referenced by HREF/PRN | [optional] |
272
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
273
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
184
274
 
185
275
  ### Return type
186
276
 
@@ -198,16 +288,16 @@ Name | Type | Description | Notes
198
288
 
199
289
  ## modify
200
290
 
201
- > AsyncOperationResponse modify(npm_npm_repository_href, repository_add_remove_content)
291
+ > <AsyncOperationResponse> modify(npm_npm_repository_href, repository_add_remove_content)
202
292
 
203
293
  Modify Repository Content
204
294
 
205
295
  Trigger an asynchronous task to create a new repository version.
206
296
 
207
- ### Example
297
+ ### Examples
208
298
 
209
299
  ```ruby
210
- # load the gem
300
+ require 'time'
211
301
  require 'pulp_npm_client'
212
302
  # setup authorization
213
303
  PulpNpmClient.configure do |config|
@@ -221,21 +311,38 @@ npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
221
311
  repository_add_remove_content = PulpNpmClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent |
222
312
 
223
313
  begin
224
- #Modify Repository Content
314
+ # Modify Repository Content
225
315
  result = api_instance.modify(npm_npm_repository_href, repository_add_remove_content)
226
316
  p result
227
317
  rescue PulpNpmClient::ApiError => e
228
- puts "Exception when calling RepositoriesNpmApi->modify: #{e}"
318
+ puts "Error when calling RepositoriesNpmApi->modify: #{e}"
229
319
  end
230
320
  ```
231
321
 
232
- ### Parameters
322
+ #### Using the modify_with_http_info variant
323
+
324
+ This returns an Array which contains the response data, status code and headers.
233
325
 
326
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> modify_with_http_info(npm_npm_repository_href, repository_add_remove_content)
234
327
 
235
- Name | Type | Description | Notes
236
- ------------- | ------------- | ------------- | -------------
237
- **npm_npm_repository_href** | **String**| |
238
- **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)| |
328
+ ```ruby
329
+ begin
330
+ # Modify Repository Content
331
+ data, status_code, headers = api_instance.modify_with_http_info(npm_npm_repository_href, repository_add_remove_content)
332
+ p status_code # => 2xx
333
+ p headers # => { ... }
334
+ p data # => <AsyncOperationResponse>
335
+ rescue PulpNpmClient::ApiError => e
336
+ puts "Error when calling RepositoriesNpmApi->modify_with_http_info: #{e}"
337
+ end
338
+ ```
339
+
340
+ ### Parameters
341
+
342
+ | Name | Type | Description | Notes |
343
+ | ---- | ---- | ----------- | ----- |
344
+ | **npm_npm_repository_href** | **String** | | |
345
+ | **repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md) | | |
239
346
 
240
347
  ### Return type
241
348
 
@@ -253,16 +360,16 @@ Name | Type | Description | Notes
253
360
 
254
361
  ## partial_update
255
362
 
256
- > AsyncOperationResponse partial_update(npm_npm_repository_href, patchednpm_npm_repository)
363
+ > <AsyncOperationResponse> partial_update(npm_npm_repository_href, patchednpm_npm_repository)
257
364
 
258
365
  Update a npm repository
259
366
 
260
367
  Trigger an asynchronous partial update task
261
368
 
262
- ### Example
369
+ ### Examples
263
370
 
264
371
  ```ruby
265
- # load the gem
372
+ require 'time'
266
373
  require 'pulp_npm_client'
267
374
  # setup authorization
268
375
  PulpNpmClient.configure do |config|
@@ -276,21 +383,38 @@ npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
276
383
  patchednpm_npm_repository = PulpNpmClient::PatchednpmNpmRepository.new # PatchednpmNpmRepository |
277
384
 
278
385
  begin
279
- #Update a npm repository
386
+ # Update a npm repository
280
387
  result = api_instance.partial_update(npm_npm_repository_href, patchednpm_npm_repository)
281
388
  p result
282
389
  rescue PulpNpmClient::ApiError => e
283
- puts "Exception when calling RepositoriesNpmApi->partial_update: #{e}"
390
+ puts "Error when calling RepositoriesNpmApi->partial_update: #{e}"
284
391
  end
285
392
  ```
286
393
 
287
- ### Parameters
394
+ #### Using the partial_update_with_http_info variant
288
395
 
396
+ This returns an Array which contains the response data, status code and headers.
289
397
 
290
- Name | Type | Description | Notes
291
- ------------- | ------------- | ------------- | -------------
292
- **npm_npm_repository_href** | **String**| |
293
- **patchednpm_npm_repository** | [**PatchednpmNpmRepository**](PatchednpmNpmRepository.md)| |
398
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(npm_npm_repository_href, patchednpm_npm_repository)
399
+
400
+ ```ruby
401
+ begin
402
+ # Update a npm repository
403
+ data, status_code, headers = api_instance.partial_update_with_http_info(npm_npm_repository_href, patchednpm_npm_repository)
404
+ p status_code # => 2xx
405
+ p headers # => { ... }
406
+ p data # => <AsyncOperationResponse>
407
+ rescue PulpNpmClient::ApiError => e
408
+ puts "Error when calling RepositoriesNpmApi->partial_update_with_http_info: #{e}"
409
+ end
410
+ ```
411
+
412
+ ### Parameters
413
+
414
+ | Name | Type | Description | Notes |
415
+ | ---- | ---- | ----------- | ----- |
416
+ | **npm_npm_repository_href** | **String** | | |
417
+ | **patchednpm_npm_repository** | [**PatchednpmNpmRepository**](PatchednpmNpmRepository.md) | | |
294
418
 
295
419
  ### Return type
296
420
 
@@ -308,16 +432,16 @@ Name | Type | Description | Notes
308
432
 
309
433
  ## read
310
434
 
311
- > NpmNpmRepositoryResponse read(npm_npm_repository_href, opts)
435
+ > <NpmNpmRepositoryResponse> read(npm_npm_repository_href, opts)
312
436
 
313
437
  Inspect a npm repository
314
438
 
315
439
  A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
316
440
 
317
- ### Example
441
+ ### Examples
318
442
 
319
443
  ```ruby
320
- # load the gem
444
+ require 'time'
321
445
  require 'pulp_npm_client'
322
446
  # setup authorization
323
447
  PulpNpmClient.configure do |config|
@@ -329,27 +453,44 @@ end
329
453
  api_instance = PulpNpmClient::RepositoriesNpmApi.new
330
454
  npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
331
455
  opts = {
332
- fields: 'fields_example', # String | A list of fields to include in the response.
333
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
456
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
457
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
334
458
  }
335
459
 
336
460
  begin
337
- #Inspect a npm repository
461
+ # Inspect a npm repository
338
462
  result = api_instance.read(npm_npm_repository_href, opts)
339
463
  p result
340
464
  rescue PulpNpmClient::ApiError => e
341
- puts "Exception when calling RepositoriesNpmApi->read: #{e}"
465
+ puts "Error when calling RepositoriesNpmApi->read: #{e}"
342
466
  end
343
467
  ```
344
468
 
345
- ### Parameters
469
+ #### Using the read_with_http_info variant
470
+
471
+ This returns an Array which contains the response data, status code and headers.
472
+
473
+ > <Array(<NpmNpmRepositoryResponse>, Integer, Hash)> read_with_http_info(npm_npm_repository_href, opts)
474
+
475
+ ```ruby
476
+ begin
477
+ # Inspect a npm repository
478
+ data, status_code, headers = api_instance.read_with_http_info(npm_npm_repository_href, opts)
479
+ p status_code # => 2xx
480
+ p headers # => { ... }
481
+ p data # => <NpmNpmRepositoryResponse>
482
+ rescue PulpNpmClient::ApiError => e
483
+ puts "Error when calling RepositoriesNpmApi->read_with_http_info: #{e}"
484
+ end
485
+ ```
346
486
 
487
+ ### Parameters
347
488
 
348
- Name | Type | Description | Notes
349
- ------------- | ------------- | ------------- | -------------
350
- **npm_npm_repository_href** | **String**| |
351
- **fields** | **String**| A list of fields to include in the response. | [optional]
352
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
489
+ | Name | Type | Description | Notes |
490
+ | ---- | ---- | ----------- | ----- |
491
+ | **npm_npm_repository_href** | **String** | | |
492
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
493
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
353
494
 
354
495
  ### Return type
355
496
 
@@ -365,18 +506,90 @@ Name | Type | Description | Notes
365
506
  - **Accept**: application/json
366
507
 
367
508
 
509
+ ## set_label
510
+
511
+ > <SetLabelResponse> set_label(npm_npm_repository_href, set_label)
512
+
513
+ Set a label
514
+
515
+ Set a single pulp_label on the object to a specific value or null.
516
+
517
+ ### Examples
518
+
519
+ ```ruby
520
+ require 'time'
521
+ require 'pulp_npm_client'
522
+ # setup authorization
523
+ PulpNpmClient.configure do |config|
524
+ # Configure HTTP basic authorization: basicAuth
525
+ config.username = 'YOUR USERNAME'
526
+ config.password = 'YOUR PASSWORD'
527
+ end
528
+
529
+ api_instance = PulpNpmClient::RepositoriesNpmApi.new
530
+ npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
531
+ set_label = PulpNpmClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
532
+
533
+ begin
534
+ # Set a label
535
+ result = api_instance.set_label(npm_npm_repository_href, set_label)
536
+ p result
537
+ rescue PulpNpmClient::ApiError => e
538
+ puts "Error when calling RepositoriesNpmApi->set_label: #{e}"
539
+ end
540
+ ```
541
+
542
+ #### Using the set_label_with_http_info variant
543
+
544
+ This returns an Array which contains the response data, status code and headers.
545
+
546
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(npm_npm_repository_href, set_label)
547
+
548
+ ```ruby
549
+ begin
550
+ # Set a label
551
+ data, status_code, headers = api_instance.set_label_with_http_info(npm_npm_repository_href, set_label)
552
+ p status_code # => 2xx
553
+ p headers # => { ... }
554
+ p data # => <SetLabelResponse>
555
+ rescue PulpNpmClient::ApiError => e
556
+ puts "Error when calling RepositoriesNpmApi->set_label_with_http_info: #{e}"
557
+ end
558
+ ```
559
+
560
+ ### Parameters
561
+
562
+ | Name | Type | Description | Notes |
563
+ | ---- | ---- | ----------- | ----- |
564
+ | **npm_npm_repository_href** | **String** | | |
565
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
566
+
567
+ ### Return type
568
+
569
+ [**SetLabelResponse**](SetLabelResponse.md)
570
+
571
+ ### Authorization
572
+
573
+ [basicAuth](../README.md#basicAuth)
574
+
575
+ ### HTTP request headers
576
+
577
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
578
+ - **Accept**: application/json
579
+
580
+
368
581
  ## sync
369
582
 
370
- > AsyncOperationResponse sync(npm_npm_repository_href, repository_sync_url)
583
+ > <AsyncOperationResponse> sync(npm_npm_repository_href, repository_sync_url)
371
584
 
372
585
  Sync from remote
373
586
 
374
587
  Trigger an asynchronous task to sync content.
375
588
 
376
- ### Example
589
+ ### Examples
377
590
 
378
591
  ```ruby
379
- # load the gem
592
+ require 'time'
380
593
  require 'pulp_npm_client'
381
594
  # setup authorization
382
595
  PulpNpmClient.configure do |config|
@@ -390,21 +603,38 @@ npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
390
603
  repository_sync_url = PulpNpmClient::RepositorySyncURL.new # RepositorySyncURL |
391
604
 
392
605
  begin
393
- #Sync from remote
606
+ # Sync from remote
394
607
  result = api_instance.sync(npm_npm_repository_href, repository_sync_url)
395
608
  p result
396
609
  rescue PulpNpmClient::ApiError => e
397
- puts "Exception when calling RepositoriesNpmApi->sync: #{e}"
610
+ puts "Error when calling RepositoriesNpmApi->sync: #{e}"
398
611
  end
399
612
  ```
400
613
 
401
- ### Parameters
614
+ #### Using the sync_with_http_info variant
402
615
 
616
+ This returns an Array which contains the response data, status code and headers.
403
617
 
404
- Name | Type | Description | Notes
405
- ------------- | ------------- | ------------- | -------------
406
- **npm_npm_repository_href** | **String**| |
407
- **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)| |
618
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> sync_with_http_info(npm_npm_repository_href, repository_sync_url)
619
+
620
+ ```ruby
621
+ begin
622
+ # Sync from remote
623
+ data, status_code, headers = api_instance.sync_with_http_info(npm_npm_repository_href, repository_sync_url)
624
+ p status_code # => 2xx
625
+ p headers # => { ... }
626
+ p data # => <AsyncOperationResponse>
627
+ rescue PulpNpmClient::ApiError => e
628
+ puts "Error when calling RepositoriesNpmApi->sync_with_http_info: #{e}"
629
+ end
630
+ ```
631
+
632
+ ### Parameters
633
+
634
+ | Name | Type | Description | Notes |
635
+ | ---- | ---- | ----------- | ----- |
636
+ | **npm_npm_repository_href** | **String** | | |
637
+ | **repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md) | | |
408
638
 
409
639
  ### Return type
410
640
 
@@ -420,18 +650,90 @@ Name | Type | Description | Notes
420
650
  - **Accept**: application/json
421
651
 
422
652
 
653
+ ## unset_label
654
+
655
+ > <UnsetLabelResponse> unset_label(npm_npm_repository_href, unset_label)
656
+
657
+ Unset a label
658
+
659
+ Unset a single pulp_label on the object.
660
+
661
+ ### Examples
662
+
663
+ ```ruby
664
+ require 'time'
665
+ require 'pulp_npm_client'
666
+ # setup authorization
667
+ PulpNpmClient.configure do |config|
668
+ # Configure HTTP basic authorization: basicAuth
669
+ config.username = 'YOUR USERNAME'
670
+ config.password = 'YOUR PASSWORD'
671
+ end
672
+
673
+ api_instance = PulpNpmClient::RepositoriesNpmApi.new
674
+ npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
675
+ unset_label = PulpNpmClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
676
+
677
+ begin
678
+ # Unset a label
679
+ result = api_instance.unset_label(npm_npm_repository_href, unset_label)
680
+ p result
681
+ rescue PulpNpmClient::ApiError => e
682
+ puts "Error when calling RepositoriesNpmApi->unset_label: #{e}"
683
+ end
684
+ ```
685
+
686
+ #### Using the unset_label_with_http_info variant
687
+
688
+ This returns an Array which contains the response data, status code and headers.
689
+
690
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(npm_npm_repository_href, unset_label)
691
+
692
+ ```ruby
693
+ begin
694
+ # Unset a label
695
+ data, status_code, headers = api_instance.unset_label_with_http_info(npm_npm_repository_href, unset_label)
696
+ p status_code # => 2xx
697
+ p headers # => { ... }
698
+ p data # => <UnsetLabelResponse>
699
+ rescue PulpNpmClient::ApiError => e
700
+ puts "Error when calling RepositoriesNpmApi->unset_label_with_http_info: #{e}"
701
+ end
702
+ ```
703
+
704
+ ### Parameters
705
+
706
+ | Name | Type | Description | Notes |
707
+ | ---- | ---- | ----------- | ----- |
708
+ | **npm_npm_repository_href** | **String** | | |
709
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
710
+
711
+ ### Return type
712
+
713
+ [**UnsetLabelResponse**](UnsetLabelResponse.md)
714
+
715
+ ### Authorization
716
+
717
+ [basicAuth](../README.md#basicAuth)
718
+
719
+ ### HTTP request headers
720
+
721
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
722
+ - **Accept**: application/json
723
+
724
+
423
725
  ## update
424
726
 
425
- > AsyncOperationResponse update(npm_npm_repository_href, npm_npm_repository)
727
+ > <AsyncOperationResponse> update(npm_npm_repository_href, npm_npm_repository)
426
728
 
427
729
  Update a npm repository
428
730
 
429
731
  Trigger an asynchronous update task
430
732
 
431
- ### Example
733
+ ### Examples
432
734
 
433
735
  ```ruby
434
- # load the gem
736
+ require 'time'
435
737
  require 'pulp_npm_client'
436
738
  # setup authorization
437
739
  PulpNpmClient.configure do |config|
@@ -442,24 +744,41 @@ end
442
744
 
443
745
  api_instance = PulpNpmClient::RepositoriesNpmApi.new
444
746
  npm_npm_repository_href = 'npm_npm_repository_href_example' # String |
445
- npm_npm_repository = PulpNpmClient::NpmNpmRepository.new # NpmNpmRepository |
747
+ npm_npm_repository = PulpNpmClient::NpmNpmRepository.new({name: 'name_example'}) # NpmNpmRepository |
446
748
 
447
749
  begin
448
- #Update a npm repository
750
+ # Update a npm repository
449
751
  result = api_instance.update(npm_npm_repository_href, npm_npm_repository)
450
752
  p result
451
753
  rescue PulpNpmClient::ApiError => e
452
- puts "Exception when calling RepositoriesNpmApi->update: #{e}"
754
+ puts "Error when calling RepositoriesNpmApi->update: #{e}"
453
755
  end
454
756
  ```
455
757
 
456
- ### Parameters
758
+ #### Using the update_with_http_info variant
759
+
760
+ This returns an Array which contains the response data, status code and headers.
457
761
 
762
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(npm_npm_repository_href, npm_npm_repository)
763
+
764
+ ```ruby
765
+ begin
766
+ # Update a npm repository
767
+ data, status_code, headers = api_instance.update_with_http_info(npm_npm_repository_href, npm_npm_repository)
768
+ p status_code # => 2xx
769
+ p headers # => { ... }
770
+ p data # => <AsyncOperationResponse>
771
+ rescue PulpNpmClient::ApiError => e
772
+ puts "Error when calling RepositoriesNpmApi->update_with_http_info: #{e}"
773
+ end
774
+ ```
775
+
776
+ ### Parameters
458
777
 
459
- Name | Type | Description | Notes
460
- ------------- | ------------- | ------------- | -------------
461
- **npm_npm_repository_href** | **String**| |
462
- **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)| |
778
+ | Name | Type | Description | Notes |
779
+ | ---- | ---- | ----------- | ----- |
780
+ | **npm_npm_repository_href** | **String** | | |
781
+ | **npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md) | | |
463
782
 
464
783
  ### Return type
465
784