zest 0.0.1

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 (136) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +185 -0
  4. data/Rakefile +8 -0
  5. data/api.json +1 -0
  6. data/config.json +6 -0
  7. data/docs/Artifact.md +17 -0
  8. data/docs/AsyncOperationResponse.md +8 -0
  9. data/docs/Distribution.md +16 -0
  10. data/docs/FileContent.md +12 -0
  11. data/docs/FilePublisher.md +14 -0
  12. data/docs/FileRemote.md +23 -0
  13. data/docs/InlineResponse200.md +11 -0
  14. data/docs/InlineResponse2001.md +11 -0
  15. data/docs/InlineResponse20010.md +11 -0
  16. data/docs/InlineResponse2002.md +11 -0
  17. data/docs/InlineResponse2003.md +11 -0
  18. data/docs/InlineResponse2004.md +11 -0
  19. data/docs/InlineResponse2005.md +11 -0
  20. data/docs/InlineResponse2006.md +11 -0
  21. data/docs/InlineResponse2007.md +11 -0
  22. data/docs/InlineResponse2008.md +11 -0
  23. data/docs/InlineResponse2009.md +11 -0
  24. data/docs/ProgressReport.md +13 -0
  25. data/docs/Publication.md +13 -0
  26. data/docs/PulpApi.md +3056 -0
  27. data/docs/Repository.md +13 -0
  28. data/docs/RepositoryPublishURL.md +9 -0
  29. data/docs/RepositorySyncURL.md +9 -0
  30. data/docs/RepositoryVersion.md +17 -0
  31. data/docs/RepositoryVersionCreate.md +10 -0
  32. data/docs/Task.md +21 -0
  33. data/docs/User.md +11 -0
  34. data/docs/Worker.md +13 -0
  35. data/git_push.sh +55 -0
  36. data/katello_pulp_api-0.0.1.gem +0 -0
  37. data/katello_pulp_api.gemspec +46 -0
  38. data/lib/katello_pulp_api.rb +67 -0
  39. data/lib/katello_pulp_api/api/pulp_api.rb +3277 -0
  40. data/lib/katello_pulp_api/api_client.rb +389 -0
  41. data/lib/katello_pulp_api/api_error.rb +38 -0
  42. data/lib/katello_pulp_api/configuration.rb +209 -0
  43. data/lib/katello_pulp_api/models/artifact.rb +278 -0
  44. data/lib/katello_pulp_api/models/async_operation_response.rb +194 -0
  45. data/lib/katello_pulp_api/models/distribution.rb +350 -0
  46. data/lib/katello_pulp_api/models/file_content.rb +272 -0
  47. data/lib/katello_pulp_api/models/file_publisher.rb +306 -0
  48. data/lib/katello_pulp_api/models/file_remote.rb +452 -0
  49. data/lib/katello_pulp_api/models/inline_response_200.rb +227 -0
  50. data/lib/katello_pulp_api/models/inline_response_200_1.rb +227 -0
  51. data/lib/katello_pulp_api/models/inline_response_200_10.rb +227 -0
  52. data/lib/katello_pulp_api/models/inline_response_200_2.rb +227 -0
  53. data/lib/katello_pulp_api/models/inline_response_200_3.rb +227 -0
  54. data/lib/katello_pulp_api/models/inline_response_200_4.rb +227 -0
  55. data/lib/katello_pulp_api/models/inline_response_200_5.rb +227 -0
  56. data/lib/katello_pulp_api/models/inline_response_200_6.rb +227 -0
  57. data/lib/katello_pulp_api/models/inline_response_200_7.rb +227 -0
  58. data/lib/katello_pulp_api/models/inline_response_200_8.rb +227 -0
  59. data/lib/katello_pulp_api/models/inline_response_200_9.rb +227 -0
  60. data/lib/katello_pulp_api/models/progress_report.rb +271 -0
  61. data/lib/katello_pulp_api/models/publication.rb +249 -0
  62. data/lib/katello_pulp_api/models/repository.rb +260 -0
  63. data/lib/katello_pulp_api/models/repository_publish_url.rb +199 -0
  64. data/lib/katello_pulp_api/models/repository_sync_url.rb +206 -0
  65. data/lib/katello_pulp_api/models/repository_version.rb +277 -0
  66. data/lib/katello_pulp_api/models/repository_version_create.rb +223 -0
  67. data/lib/katello_pulp_api/models/task.rb +363 -0
  68. data/lib/katello_pulp_api/models/user.rb +284 -0
  69. data/lib/katello_pulp_api/models/worker.rb +254 -0
  70. data/lib/katello_pulp_api/version.rb +15 -0
  71. data/lib/zest.rb +67 -0
  72. data/lib/zest/api/pulp_api.rb +3277 -0
  73. data/lib/zest/api_client.rb +389 -0
  74. data/lib/zest/api_error.rb +38 -0
  75. data/lib/zest/configuration.rb +209 -0
  76. data/lib/zest/models/artifact.rb +278 -0
  77. data/lib/zest/models/async_operation_response.rb +194 -0
  78. data/lib/zest/models/distribution.rb +350 -0
  79. data/lib/zest/models/file_content.rb +272 -0
  80. data/lib/zest/models/file_publisher.rb +306 -0
  81. data/lib/zest/models/file_remote.rb +452 -0
  82. data/lib/zest/models/inline_response_200.rb +227 -0
  83. data/lib/zest/models/inline_response_200_1.rb +227 -0
  84. data/lib/zest/models/inline_response_200_10.rb +227 -0
  85. data/lib/zest/models/inline_response_200_2.rb +227 -0
  86. data/lib/zest/models/inline_response_200_3.rb +227 -0
  87. data/lib/zest/models/inline_response_200_4.rb +227 -0
  88. data/lib/zest/models/inline_response_200_5.rb +227 -0
  89. data/lib/zest/models/inline_response_200_6.rb +227 -0
  90. data/lib/zest/models/inline_response_200_7.rb +227 -0
  91. data/lib/zest/models/inline_response_200_8.rb +227 -0
  92. data/lib/zest/models/inline_response_200_9.rb +227 -0
  93. data/lib/zest/models/progress_report.rb +271 -0
  94. data/lib/zest/models/publication.rb +249 -0
  95. data/lib/zest/models/repository.rb +260 -0
  96. data/lib/zest/models/repository_publish_url.rb +199 -0
  97. data/lib/zest/models/repository_sync_url.rb +206 -0
  98. data/lib/zest/models/repository_version.rb +277 -0
  99. data/lib/zest/models/repository_version_create.rb +223 -0
  100. data/lib/zest/models/task.rb +363 -0
  101. data/lib/zest/models/user.rb +284 -0
  102. data/lib/zest/models/worker.rb +254 -0
  103. data/lib/zest/version.rb +15 -0
  104. data/spec/api/pulp_api_spec.rb +784 -0
  105. data/spec/api_client_spec.rb +226 -0
  106. data/spec/configuration_spec.rb +42 -0
  107. data/spec/models/artifact_spec.rb +96 -0
  108. data/spec/models/async_operation_response_spec.rb +42 -0
  109. data/spec/models/distribution_spec.rb +90 -0
  110. data/spec/models/file_content_spec.rb +66 -0
  111. data/spec/models/file_publisher_spec.rb +78 -0
  112. data/spec/models/file_remote_spec.rb +136 -0
  113. data/spec/models/inline_response_200_10_spec.rb +60 -0
  114. data/spec/models/inline_response_200_1_spec.rb +60 -0
  115. data/spec/models/inline_response_200_2_spec.rb +60 -0
  116. data/spec/models/inline_response_200_3_spec.rb +60 -0
  117. data/spec/models/inline_response_200_4_spec.rb +60 -0
  118. data/spec/models/inline_response_200_5_spec.rb +60 -0
  119. data/spec/models/inline_response_200_6_spec.rb +60 -0
  120. data/spec/models/inline_response_200_7_spec.rb +60 -0
  121. data/spec/models/inline_response_200_8_spec.rb +60 -0
  122. data/spec/models/inline_response_200_9_spec.rb +60 -0
  123. data/spec/models/inline_response_200_spec.rb +60 -0
  124. data/spec/models/progress_report_spec.rb +72 -0
  125. data/spec/models/publication_spec.rb +72 -0
  126. data/spec/models/repository_publish_url_spec.rb +48 -0
  127. data/spec/models/repository_spec.rb +72 -0
  128. data/spec/models/repository_sync_url_spec.rb +48 -0
  129. data/spec/models/repository_version_create_spec.rb +54 -0
  130. data/spec/models/repository_version_spec.rb +96 -0
  131. data/spec/models/task_spec.rb +120 -0
  132. data/spec/models/user_spec.rb +60 -0
  133. data/spec/models/worker_spec.rb +72 -0
  134. data/spec/spec_helper.rb +111 -0
  135. data/zest.gemspec +46 -0
  136. metadata +391 -0
@@ -0,0 +1,11 @@
1
+ # Zest::InlineResponse2009
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **count** | **Integer** | |
7
+ **_next** | **String** | | [optional]
8
+ **previous** | **String** | | [optional]
9
+ **results** | [**Array<User>**](User.md) | |
10
+
11
+
@@ -0,0 +1,13 @@
1
+ # Zest::ProgressReport
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | The message shown to the user for the progress report. | [optional]
7
+ **state** | **String** | The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed' and 'canceled'. The default is 'waiting'. | [optional]
8
+ **total** | **Integer** | The total count of items to be handled by the ProgressBar. | [optional]
9
+ **done** | **Integer** | The count of items already processed. Defaults to 0. | [optional]
10
+ **suffix** | **String** | The suffix to be shown with the progress report. | [optional]
11
+ **task** | **String** | The task associated with this progress report. | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Zest::Publication
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **_href** | **String** | | [optional]
7
+ **_created** | **DateTime** | Timestamp of creation. | [optional]
8
+ **pass_through** | **BOOLEAN** | The publication is a pass-through for the repository version. |
9
+ **publisher** | **String** | The publisher that created this publication. |
10
+ **distributions** | **Array<String>** | This publication is currently being served asdefined by these distributions. | [optional]
11
+ **repository_version** | **String** | | [optional]
12
+
13
+
@@ -0,0 +1,3056 @@
1
+ # Zest::PulpApi
2
+
3
+ All URIs are relative to *http://katello-gem-builder*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**artifacts_create**](PulpApi.md#artifacts_create) | **POST** /pulp/api/v3/artifacts/ |
8
+ [**artifacts_delete**](PulpApi.md#artifacts_delete) | **DELETE** {artifact_href} |
9
+ [**artifacts_list**](PulpApi.md#artifacts_list) | **GET** /pulp/api/v3/artifacts/ |
10
+ [**artifacts_read**](PulpApi.md#artifacts_read) | **GET** {artifact_href} |
11
+ [**content_file_files_create**](PulpApi.md#content_file_files_create) | **POST** /pulp/api/v3/content/file/files/ |
12
+ [**content_file_files_list**](PulpApi.md#content_file_files_list) | **GET** /pulp/api/v3/content/file/files/ |
13
+ [**content_file_files_read**](PulpApi.md#content_file_files_read) | **GET** {file_content_href} |
14
+ [**distributions_create**](PulpApi.md#distributions_create) | **POST** /pulp/api/v3/distributions/ |
15
+ [**distributions_delete**](PulpApi.md#distributions_delete) | **DELETE** {distribution_href} |
16
+ [**distributions_list**](PulpApi.md#distributions_list) | **GET** /pulp/api/v3/distributions/ |
17
+ [**distributions_partial_update**](PulpApi.md#distributions_partial_update) | **PATCH** {distribution_href} |
18
+ [**distributions_read**](PulpApi.md#distributions_read) | **GET** {distribution_href} |
19
+ [**distributions_update**](PulpApi.md#distributions_update) | **PUT** {distribution_href} |
20
+ [**orphans_delete**](PulpApi.md#orphans_delete) | **DELETE** /pulp/api/v3/orphans/ |
21
+ [**publications_delete**](PulpApi.md#publications_delete) | **DELETE** {publication_href} |
22
+ [**publications_list**](PulpApi.md#publications_list) | **GET** /pulp/api/v3/publications/ |
23
+ [**publications_read**](PulpApi.md#publications_read) | **GET** {publication_href} |
24
+ [**publishers_file_file_create**](PulpApi.md#publishers_file_file_create) | **POST** /pulp/api/v3/publishers/file/file/ |
25
+ [**publishers_file_file_delete**](PulpApi.md#publishers_file_file_delete) | **DELETE** {file_publisher_href} |
26
+ [**publishers_file_file_list**](PulpApi.md#publishers_file_file_list) | **GET** /pulp/api/v3/publishers/file/file/ |
27
+ [**publishers_file_file_partial_update**](PulpApi.md#publishers_file_file_partial_update) | **PATCH** {file_publisher_href} |
28
+ [**publishers_file_file_publish**](PulpApi.md#publishers_file_file_publish) | **POST** {file_publisher_href}publish/ |
29
+ [**publishers_file_file_read**](PulpApi.md#publishers_file_file_read) | **GET** {file_publisher_href} |
30
+ [**publishers_file_file_update**](PulpApi.md#publishers_file_file_update) | **PUT** {file_publisher_href} |
31
+ [**remotes_file_file_create**](PulpApi.md#remotes_file_file_create) | **POST** /pulp/api/v3/remotes/file/file/ |
32
+ [**remotes_file_file_delete**](PulpApi.md#remotes_file_file_delete) | **DELETE** {file_remote_href} |
33
+ [**remotes_file_file_list**](PulpApi.md#remotes_file_file_list) | **GET** /pulp/api/v3/remotes/file/file/ |
34
+ [**remotes_file_file_partial_update**](PulpApi.md#remotes_file_file_partial_update) | **PATCH** {file_remote_href} |
35
+ [**remotes_file_file_read**](PulpApi.md#remotes_file_file_read) | **GET** {file_remote_href} |
36
+ [**remotes_file_file_sync**](PulpApi.md#remotes_file_file_sync) | **POST** {file_remote_href}sync/ |
37
+ [**remotes_file_file_update**](PulpApi.md#remotes_file_file_update) | **PUT** {file_remote_href} |
38
+ [**repositories_create**](PulpApi.md#repositories_create) | **POST** /pulp/api/v3/repositories/ |
39
+ [**repositories_delete**](PulpApi.md#repositories_delete) | **DELETE** {repository_href} |
40
+ [**repositories_list**](PulpApi.md#repositories_list) | **GET** /pulp/api/v3/repositories/ |
41
+ [**repositories_partial_update**](PulpApi.md#repositories_partial_update) | **PATCH** {repository_href} |
42
+ [**repositories_read**](PulpApi.md#repositories_read) | **GET** {repository_href} |
43
+ [**repositories_update**](PulpApi.md#repositories_update) | **PUT** {repository_href} |
44
+ [**repositories_versions_create**](PulpApi.md#repositories_versions_create) | **POST** /pulp/api/v3/repositories/{repository_pk}/versions/ |
45
+ [**repositories_versions_delete**](PulpApi.md#repositories_versions_delete) | **DELETE** {repository_version_href} |
46
+ [**repositories_versions_list**](PulpApi.md#repositories_versions_list) | **GET** /pulp/api/v3/repositories/{repository_pk}/versions/ |
47
+ [**repositories_versions_partial_update**](PulpApi.md#repositories_versions_partial_update) | **PATCH** {repository_version_href} |
48
+ [**repositories_versions_read**](PulpApi.md#repositories_versions_read) | **GET** {repository_version_href} |
49
+ [**repositories_versions_update**](PulpApi.md#repositories_versions_update) | **PUT** {repository_version_href} |
50
+ [**status_list**](PulpApi.md#status_list) | **GET** /pulp/api/v3/status/ |
51
+ [**tasks_cancel**](PulpApi.md#tasks_cancel) | **POST** {task_href}cancel/ |
52
+ [**tasks_delete**](PulpApi.md#tasks_delete) | **DELETE** {task_href} |
53
+ [**tasks_list**](PulpApi.md#tasks_list) | **GET** /pulp/api/v3/tasks/ |
54
+ [**tasks_read**](PulpApi.md#tasks_read) | **GET** {task_href} |
55
+ [**users_delete**](PulpApi.md#users_delete) | **DELETE** {user_href} |
56
+ [**users_list**](PulpApi.md#users_list) | **GET** /pulp/api/v3/users/ |
57
+ [**users_read**](PulpApi.md#users_read) | **GET** {user_href} |
58
+ [**workers_list**](PulpApi.md#workers_list) | **GET** /pulp/api/v3/workers/ |
59
+ [**workers_read**](PulpApi.md#workers_read) | **GET** {worker_href} |
60
+
61
+
62
+ # **artifacts_create**
63
+ > Artifact artifacts_create(file, opts)
64
+
65
+
66
+
67
+
68
+
69
+ ### Example
70
+ ```ruby
71
+ # load the gem
72
+ require 'zest'
73
+ # setup authorization
74
+ Zest.configure do |config|
75
+ # Configure HTTP basic authorization: Basic
76
+ config.username = 'YOUR USERNAME'
77
+ config.password = 'YOUR PASSWORD'
78
+ end
79
+
80
+ api_instance = Zest::PulpApi.new
81
+
82
+ file = File.new("/path/to/file.txt") # File | The stored file.
83
+
84
+ opts = {
85
+ size: 56, # Integer | The size of the file in bytes.
86
+ md5: "md5_example", # String | The MD5 checksum of the file if available.
87
+ sha1: "sha1_example", # String | The SHA-1 checksum of the file if available.
88
+ sha224: "sha224_example", # String | The SHA-224 checksum of the file if available.
89
+ sha256: "sha256_example", # String | The SHA-256 checksum of the file if available.
90
+ sha384: "sha384_example", # String | The SHA-384 checksum of the file if available.
91
+ sha512: "sha512_example" # String | The SHA-512 checksum of the file if available.
92
+ }
93
+
94
+ begin
95
+ result = api_instance.artifacts_create(file, opts)
96
+ p result
97
+ rescue Zest::ApiError => e
98
+ puts "Exception when calling PulpApi->artifacts_create: #{e}"
99
+ end
100
+ ```
101
+
102
+ ### Parameters
103
+
104
+ Name | Type | Description | Notes
105
+ ------------- | ------------- | ------------- | -------------
106
+ **file** | **File**| The stored file. |
107
+ **size** | **Integer**| The size of the file in bytes. | [optional]
108
+ **md5** | **String**| The MD5 checksum of the file if available. | [optional]
109
+ **sha1** | **String**| The SHA-1 checksum of the file if available. | [optional]
110
+ **sha224** | **String**| The SHA-224 checksum of the file if available. | [optional]
111
+ **sha256** | **String**| The SHA-256 checksum of the file if available. | [optional]
112
+ **sha384** | **String**| The SHA-384 checksum of the file if available. | [optional]
113
+ **sha512** | **String**| The SHA-512 checksum of the file if available. | [optional]
114
+
115
+ ### Return type
116
+
117
+ [**Artifact**](Artifact.md)
118
+
119
+ ### Authorization
120
+
121
+ [Basic](../README.md#Basic)
122
+
123
+ ### HTTP request headers
124
+
125
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
126
+ - **Accept**: application/json
127
+
128
+
129
+
130
+ # **artifacts_delete**
131
+ > artifacts_delete(artifact_href)
132
+
133
+
134
+
135
+ Remove Artifact only if it is not associated with any Content.
136
+
137
+ ### Example
138
+ ```ruby
139
+ # load the gem
140
+ require 'zest'
141
+ # setup authorization
142
+ Zest.configure do |config|
143
+ # Configure HTTP basic authorization: Basic
144
+ config.username = 'YOUR USERNAME'
145
+ config.password = 'YOUR PASSWORD'
146
+ end
147
+
148
+ api_instance = Zest::PulpApi.new
149
+
150
+ artifact_href = "artifact_href_example" # String | URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/
151
+
152
+
153
+ begin
154
+ api_instance.artifacts_delete(artifact_href)
155
+ rescue Zest::ApiError => e
156
+ puts "Exception when calling PulpApi->artifacts_delete: #{e}"
157
+ end
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+ Name | Type | Description | Notes
163
+ ------------- | ------------- | ------------- | -------------
164
+ **artifact_href** | **String**| URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/ |
165
+
166
+ ### Return type
167
+
168
+ nil (empty response body)
169
+
170
+ ### Authorization
171
+
172
+ [Basic](../README.md#Basic)
173
+
174
+ ### HTTP request headers
175
+
176
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
177
+ - **Accept**: application/json
178
+
179
+
180
+
181
+ # **artifacts_list**
182
+ > InlineResponse200 artifacts_list(opts)
183
+
184
+
185
+
186
+
187
+
188
+ ### Example
189
+ ```ruby
190
+ # load the gem
191
+ require 'zest'
192
+ # setup authorization
193
+ Zest.configure do |config|
194
+ # Configure HTTP basic authorization: Basic
195
+ config.username = 'YOUR USERNAME'
196
+ config.password = 'YOUR PASSWORD'
197
+ end
198
+
199
+ api_instance = Zest::PulpApi.new
200
+
201
+ opts = {
202
+ md5: "md5_example", # String | Filter results where md5 matches value
203
+ sha1: "sha1_example", # String | Filter results where sha1 matches value
204
+ sha224: "sha224_example", # String | Filter results where sha224 matches value
205
+ sha256: "sha256_example", # String | Filter results where sha256 matches value
206
+ sha384: "sha384_example", # String | Filter results where sha384 matches value
207
+ sha512: "sha512_example", # String | Filter results where sha512 matches value
208
+ page: 56, # Integer | A page number within the paginated result set.
209
+ page_size: 56 # Integer | Number of results to return per page.
210
+ }
211
+
212
+ begin
213
+ result = api_instance.artifacts_list(opts)
214
+ p result
215
+ rescue Zest::ApiError => e
216
+ puts "Exception when calling PulpApi->artifacts_list: #{e}"
217
+ end
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ Name | Type | Description | Notes
223
+ ------------- | ------------- | ------------- | -------------
224
+ **md5** | **String**| Filter results where md5 matches value | [optional]
225
+ **sha1** | **String**| Filter results where sha1 matches value | [optional]
226
+ **sha224** | **String**| Filter results where sha224 matches value | [optional]
227
+ **sha256** | **String**| Filter results where sha256 matches value | [optional]
228
+ **sha384** | **String**| Filter results where sha384 matches value | [optional]
229
+ **sha512** | **String**| Filter results where sha512 matches value | [optional]
230
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
231
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
232
+
233
+ ### Return type
234
+
235
+ [**InlineResponse200**](InlineResponse200.md)
236
+
237
+ ### Authorization
238
+
239
+ [Basic](../README.md#Basic)
240
+
241
+ ### HTTP request headers
242
+
243
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
244
+ - **Accept**: application/json
245
+
246
+
247
+
248
+ # **artifacts_read**
249
+ > Artifact artifacts_read(artifact_href)
250
+
251
+
252
+
253
+
254
+
255
+ ### Example
256
+ ```ruby
257
+ # load the gem
258
+ require 'zest'
259
+ # setup authorization
260
+ Zest.configure do |config|
261
+ # Configure HTTP basic authorization: Basic
262
+ config.username = 'YOUR USERNAME'
263
+ config.password = 'YOUR PASSWORD'
264
+ end
265
+
266
+ api_instance = Zest::PulpApi.new
267
+
268
+ artifact_href = "artifact_href_example" # String | URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/
269
+
270
+
271
+ begin
272
+ result = api_instance.artifacts_read(artifact_href)
273
+ p result
274
+ rescue Zest::ApiError => e
275
+ puts "Exception when calling PulpApi->artifacts_read: #{e}"
276
+ end
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ Name | Type | Description | Notes
282
+ ------------- | ------------- | ------------- | -------------
283
+ **artifact_href** | **String**| URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/ |
284
+
285
+ ### Return type
286
+
287
+ [**Artifact**](Artifact.md)
288
+
289
+ ### Authorization
290
+
291
+ [Basic](../README.md#Basic)
292
+
293
+ ### HTTP request headers
294
+
295
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
296
+ - **Accept**: application/json
297
+
298
+
299
+
300
+ # **content_file_files_create**
301
+ > FileContent content_file_files_create(data)
302
+
303
+
304
+
305
+ Create a new FileContent from a request.
306
+
307
+ ### Example
308
+ ```ruby
309
+ # load the gem
310
+ require 'zest'
311
+ # setup authorization
312
+ Zest.configure do |config|
313
+ # Configure HTTP basic authorization: Basic
314
+ config.username = 'YOUR USERNAME'
315
+ config.password = 'YOUR PASSWORD'
316
+ end
317
+
318
+ api_instance = Zest::PulpApi.new
319
+
320
+ data = Zest::FileContent.new # FileContent |
321
+
322
+
323
+ begin
324
+ result = api_instance.content_file_files_create(data)
325
+ p result
326
+ rescue Zest::ApiError => e
327
+ puts "Exception when calling PulpApi->content_file_files_create: #{e}"
328
+ end
329
+ ```
330
+
331
+ ### Parameters
332
+
333
+ Name | Type | Description | Notes
334
+ ------------- | ------------- | ------------- | -------------
335
+ **data** | [**FileContent**](FileContent.md)| |
336
+
337
+ ### Return type
338
+
339
+ [**FileContent**](FileContent.md)
340
+
341
+ ### Authorization
342
+
343
+ [Basic](../README.md#Basic)
344
+
345
+ ### HTTP request headers
346
+
347
+ - **Content-Type**: application/json
348
+ - **Accept**: application/json
349
+
350
+
351
+
352
+ # **content_file_files_list**
353
+ > InlineResponse2001 content_file_files_list(opts)
354
+
355
+
356
+
357
+ ViewSet for FileContent.
358
+
359
+ ### Example
360
+ ```ruby
361
+ # load the gem
362
+ require 'zest'
363
+ # setup authorization
364
+ Zest.configure do |config|
365
+ # Configure HTTP basic authorization: Basic
366
+ config.username = 'YOUR USERNAME'
367
+ config.password = 'YOUR PASSWORD'
368
+ end
369
+
370
+ api_instance = Zest::PulpApi.new
371
+
372
+ opts = {
373
+ relative_path: "relative_path_example", # String | Filter results where relative_path matches value
374
+ digest: "digest_example", # String | Filter results where digest matches value
375
+ repository_version: "repository_version_example", # String | Repository Version referenced by HREF
376
+ repository_version_added: "repository_version_added_example", # String | Repository Version referenced by HREF
377
+ repository_version_removed: "repository_version_removed_example", # String | Repository Version referenced by HREF
378
+ page: 56, # Integer | A page number within the paginated result set.
379
+ page_size: 56 # Integer | Number of results to return per page.
380
+ }
381
+
382
+ begin
383
+ result = api_instance.content_file_files_list(opts)
384
+ p result
385
+ rescue Zest::ApiError => e
386
+ puts "Exception when calling PulpApi->content_file_files_list: #{e}"
387
+ end
388
+ ```
389
+
390
+ ### Parameters
391
+
392
+ Name | Type | Description | Notes
393
+ ------------- | ------------- | ------------- | -------------
394
+ **relative_path** | **String**| Filter results where relative_path matches value | [optional]
395
+ **digest** | **String**| Filter results where digest matches value | [optional]
396
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional]
397
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
398
+ **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional]
399
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
400
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
401
+
402
+ ### Return type
403
+
404
+ [**InlineResponse2001**](InlineResponse2001.md)
405
+
406
+ ### Authorization
407
+
408
+ [Basic](../README.md#Basic)
409
+
410
+ ### HTTP request headers
411
+
412
+ - **Content-Type**: application/json
413
+ - **Accept**: application/json
414
+
415
+
416
+
417
+ # **content_file_files_read**
418
+ > FileContent content_file_files_read(file_content_href)
419
+
420
+
421
+
422
+ ViewSet for FileContent.
423
+
424
+ ### Example
425
+ ```ruby
426
+ # load the gem
427
+ require 'zest'
428
+ # setup authorization
429
+ Zest.configure do |config|
430
+ # Configure HTTP basic authorization: Basic
431
+ config.username = 'YOUR USERNAME'
432
+ config.password = 'YOUR PASSWORD'
433
+ end
434
+
435
+ api_instance = Zest::PulpApi.new
436
+
437
+ file_content_href = "file_content_href_example" # String | URI of File Content. e.g.: /pulp/api/v3/content/file/files/1/
438
+
439
+
440
+ begin
441
+ result = api_instance.content_file_files_read(file_content_href)
442
+ p result
443
+ rescue Zest::ApiError => e
444
+ puts "Exception when calling PulpApi->content_file_files_read: #{e}"
445
+ end
446
+ ```
447
+
448
+ ### Parameters
449
+
450
+ Name | Type | Description | Notes
451
+ ------------- | ------------- | ------------- | -------------
452
+ **file_content_href** | **String**| URI of File Content. e.g.: /pulp/api/v3/content/file/files/1/ |
453
+
454
+ ### Return type
455
+
456
+ [**FileContent**](FileContent.md)
457
+
458
+ ### Authorization
459
+
460
+ [Basic](../README.md#Basic)
461
+
462
+ ### HTTP request headers
463
+
464
+ - **Content-Type**: application/json
465
+ - **Accept**: application/json
466
+
467
+
468
+
469
+ # **distributions_create**
470
+ > Distribution distributions_create(data)
471
+
472
+
473
+
474
+
475
+
476
+ ### Example
477
+ ```ruby
478
+ # load the gem
479
+ require 'zest'
480
+ # setup authorization
481
+ Zest.configure do |config|
482
+ # Configure HTTP basic authorization: Basic
483
+ config.username = 'YOUR USERNAME'
484
+ config.password = 'YOUR PASSWORD'
485
+ end
486
+
487
+ api_instance = Zest::PulpApi.new
488
+
489
+ data = Zest::Distribution.new # Distribution |
490
+
491
+
492
+ begin
493
+ result = api_instance.distributions_create(data)
494
+ p result
495
+ rescue Zest::ApiError => e
496
+ puts "Exception when calling PulpApi->distributions_create: #{e}"
497
+ end
498
+ ```
499
+
500
+ ### Parameters
501
+
502
+ Name | Type | Description | Notes
503
+ ------------- | ------------- | ------------- | -------------
504
+ **data** | [**Distribution**](Distribution.md)| |
505
+
506
+ ### Return type
507
+
508
+ [**Distribution**](Distribution.md)
509
+
510
+ ### Authorization
511
+
512
+ [Basic](../README.md#Basic)
513
+
514
+ ### HTTP request headers
515
+
516
+ - **Content-Type**: application/json
517
+ - **Accept**: application/json
518
+
519
+
520
+
521
+ # **distributions_delete**
522
+ > distributions_delete(distribution_href, )
523
+
524
+
525
+
526
+
527
+
528
+ ### Example
529
+ ```ruby
530
+ # load the gem
531
+ require 'zest'
532
+ # setup authorization
533
+ Zest.configure do |config|
534
+ # Configure HTTP basic authorization: Basic
535
+ config.username = 'YOUR USERNAME'
536
+ config.password = 'YOUR PASSWORD'
537
+ end
538
+
539
+ api_instance = Zest::PulpApi.new
540
+
541
+ distribution_href = "distribution_href_example" # String | URI of Distribution. e.g.: /pulp/api/v3/distributions/1/
542
+
543
+
544
+ begin
545
+ api_instance.distributions_delete(distribution_href, )
546
+ rescue Zest::ApiError => e
547
+ puts "Exception when calling PulpApi->distributions_delete: #{e}"
548
+ end
549
+ ```
550
+
551
+ ### Parameters
552
+
553
+ Name | Type | Description | Notes
554
+ ------------- | ------------- | ------------- | -------------
555
+ **distribution_href** | **String**| URI of Distribution. e.g.: /pulp/api/v3/distributions/1/ |
556
+
557
+ ### Return type
558
+
559
+ nil (empty response body)
560
+
561
+ ### Authorization
562
+
563
+ [Basic](../README.md#Basic)
564
+
565
+ ### HTTP request headers
566
+
567
+ - **Content-Type**: application/json
568
+ - **Accept**: application/json
569
+
570
+
571
+
572
+ # **distributions_list**
573
+ > InlineResponse2002 distributions_list(opts)
574
+
575
+
576
+
577
+
578
+
579
+ ### Example
580
+ ```ruby
581
+ # load the gem
582
+ require 'zest'
583
+ # setup authorization
584
+ Zest.configure do |config|
585
+ # Configure HTTP basic authorization: Basic
586
+ config.username = 'YOUR USERNAME'
587
+ config.password = 'YOUR PASSWORD'
588
+ end
589
+
590
+ api_instance = Zest::PulpApi.new
591
+
592
+ opts = {
593
+ name: "name_example", # String |
594
+ name__in: "name__in_example", # String | Filter results where name is in a comma-separated list of values
595
+ base_path: "base_path_example", # String |
596
+ base_path__contains: "base_path__contains_example", # String | Filter results where base_path contains value
597
+ base_path__icontains: "base_path__icontains_example", # String | Filter results where base_path contains value
598
+ base_path__in: "base_path__in_example", # String | Filter results where base_path is in a comma-separated list of values
599
+ page: 56, # Integer | A page number within the paginated result set.
600
+ page_size: 56 # Integer | Number of results to return per page.
601
+ }
602
+
603
+ begin
604
+ result = api_instance.distributions_list(opts)
605
+ p result
606
+ rescue Zest::ApiError => e
607
+ puts "Exception when calling PulpApi->distributions_list: #{e}"
608
+ end
609
+ ```
610
+
611
+ ### Parameters
612
+
613
+ Name | Type | Description | Notes
614
+ ------------- | ------------- | ------------- | -------------
615
+ **name** | **String**| | [optional]
616
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
617
+ **base_path** | **String**| | [optional]
618
+ **base_path__contains** | **String**| Filter results where base_path contains value | [optional]
619
+ **base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
620
+ **base_path__in** | **String**| Filter results where base_path is in a comma-separated list of values | [optional]
621
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
622
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
623
+
624
+ ### Return type
625
+
626
+ [**InlineResponse2002**](InlineResponse2002.md)
627
+
628
+ ### Authorization
629
+
630
+ [Basic](../README.md#Basic)
631
+
632
+ ### HTTP request headers
633
+
634
+ - **Content-Type**: application/json
635
+ - **Accept**: application/json
636
+
637
+
638
+
639
+ # **distributions_partial_update**
640
+ > Distribution distributions_partial_update(distribution_href, data)
641
+
642
+
643
+
644
+
645
+
646
+ ### Example
647
+ ```ruby
648
+ # load the gem
649
+ require 'zest'
650
+ # setup authorization
651
+ Zest.configure do |config|
652
+ # Configure HTTP basic authorization: Basic
653
+ config.username = 'YOUR USERNAME'
654
+ config.password = 'YOUR PASSWORD'
655
+ end
656
+
657
+ api_instance = Zest::PulpApi.new
658
+
659
+ distribution_href = "distribution_href_example" # String | URI of Distribution. e.g.: /pulp/api/v3/distributions/1/
660
+
661
+ data = Zest::Distribution.new # Distribution |
662
+
663
+
664
+ begin
665
+ result = api_instance.distributions_partial_update(distribution_href, data)
666
+ p result
667
+ rescue Zest::ApiError => e
668
+ puts "Exception when calling PulpApi->distributions_partial_update: #{e}"
669
+ end
670
+ ```
671
+
672
+ ### Parameters
673
+
674
+ Name | Type | Description | Notes
675
+ ------------- | ------------- | ------------- | -------------
676
+ **distribution_href** | **String**| URI of Distribution. e.g.: /pulp/api/v3/distributions/1/ |
677
+ **data** | [**Distribution**](Distribution.md)| |
678
+
679
+ ### Return type
680
+
681
+ [**Distribution**](Distribution.md)
682
+
683
+ ### Authorization
684
+
685
+ [Basic](../README.md#Basic)
686
+
687
+ ### HTTP request headers
688
+
689
+ - **Content-Type**: application/json
690
+ - **Accept**: application/json
691
+
692
+
693
+
694
+ # **distributions_read**
695
+ > Distribution distributions_read(distribution_href, )
696
+
697
+
698
+
699
+
700
+
701
+ ### Example
702
+ ```ruby
703
+ # load the gem
704
+ require 'zest'
705
+ # setup authorization
706
+ Zest.configure do |config|
707
+ # Configure HTTP basic authorization: Basic
708
+ config.username = 'YOUR USERNAME'
709
+ config.password = 'YOUR PASSWORD'
710
+ end
711
+
712
+ api_instance = Zest::PulpApi.new
713
+
714
+ distribution_href = "distribution_href_example" # String | URI of Distribution. e.g.: /pulp/api/v3/distributions/1/
715
+
716
+
717
+ begin
718
+ result = api_instance.distributions_read(distribution_href, )
719
+ p result
720
+ rescue Zest::ApiError => e
721
+ puts "Exception when calling PulpApi->distributions_read: #{e}"
722
+ end
723
+ ```
724
+
725
+ ### Parameters
726
+
727
+ Name | Type | Description | Notes
728
+ ------------- | ------------- | ------------- | -------------
729
+ **distribution_href** | **String**| URI of Distribution. e.g.: /pulp/api/v3/distributions/1/ |
730
+
731
+ ### Return type
732
+
733
+ [**Distribution**](Distribution.md)
734
+
735
+ ### Authorization
736
+
737
+ [Basic](../README.md#Basic)
738
+
739
+ ### HTTP request headers
740
+
741
+ - **Content-Type**: application/json
742
+ - **Accept**: application/json
743
+
744
+
745
+
746
+ # **distributions_update**
747
+ > Distribution distributions_update(distribution_href, data)
748
+
749
+
750
+
751
+
752
+
753
+ ### Example
754
+ ```ruby
755
+ # load the gem
756
+ require 'zest'
757
+ # setup authorization
758
+ Zest.configure do |config|
759
+ # Configure HTTP basic authorization: Basic
760
+ config.username = 'YOUR USERNAME'
761
+ config.password = 'YOUR PASSWORD'
762
+ end
763
+
764
+ api_instance = Zest::PulpApi.new
765
+
766
+ distribution_href = "distribution_href_example" # String | URI of Distribution. e.g.: /pulp/api/v3/distributions/1/
767
+
768
+ data = Zest::Distribution.new # Distribution |
769
+
770
+
771
+ begin
772
+ result = api_instance.distributions_update(distribution_href, data)
773
+ p result
774
+ rescue Zest::ApiError => e
775
+ puts "Exception when calling PulpApi->distributions_update: #{e}"
776
+ end
777
+ ```
778
+
779
+ ### Parameters
780
+
781
+ Name | Type | Description | Notes
782
+ ------------- | ------------- | ------------- | -------------
783
+ **distribution_href** | **String**| URI of Distribution. e.g.: /pulp/api/v3/distributions/1/ |
784
+ **data** | [**Distribution**](Distribution.md)| |
785
+
786
+ ### Return type
787
+
788
+ [**Distribution**](Distribution.md)
789
+
790
+ ### Authorization
791
+
792
+ [Basic](../README.md#Basic)
793
+
794
+ ### HTTP request headers
795
+
796
+ - **Content-Type**: application/json
797
+ - **Accept**: application/json
798
+
799
+
800
+
801
+ # **orphans_delete**
802
+ > orphans_delete
803
+
804
+
805
+
806
+ Cleans up all the Content and Artifact orphans in the system
807
+
808
+ ### Example
809
+ ```ruby
810
+ # load the gem
811
+ require 'zest'
812
+ # setup authorization
813
+ Zest.configure do |config|
814
+ # Configure HTTP basic authorization: Basic
815
+ config.username = 'YOUR USERNAME'
816
+ config.password = 'YOUR PASSWORD'
817
+ end
818
+
819
+ api_instance = Zest::PulpApi.new
820
+
821
+ begin
822
+ api_instance.orphans_delete
823
+ rescue Zest::ApiError => e
824
+ puts "Exception when calling PulpApi->orphans_delete: #{e}"
825
+ end
826
+ ```
827
+
828
+ ### Parameters
829
+ This endpoint does not need any parameter.
830
+
831
+ ### Return type
832
+
833
+ nil (empty response body)
834
+
835
+ ### Authorization
836
+
837
+ [Basic](../README.md#Basic)
838
+
839
+ ### HTTP request headers
840
+
841
+ - **Content-Type**: application/json
842
+ - **Accept**: application/json
843
+
844
+
845
+
846
+ # **publications_delete**
847
+ > publications_delete(publication_href)
848
+
849
+
850
+
851
+
852
+
853
+ ### Example
854
+ ```ruby
855
+ # load the gem
856
+ require 'zest'
857
+ # setup authorization
858
+ Zest.configure do |config|
859
+ # Configure HTTP basic authorization: Basic
860
+ config.username = 'YOUR USERNAME'
861
+ config.password = 'YOUR PASSWORD'
862
+ end
863
+
864
+ api_instance = Zest::PulpApi.new
865
+
866
+ publication_href = "publication_href_example" # String | URI of Publication. e.g.: /pulp/api/v3/publications/1/
867
+
868
+
869
+ begin
870
+ api_instance.publications_delete(publication_href)
871
+ rescue Zest::ApiError => e
872
+ puts "Exception when calling PulpApi->publications_delete: #{e}"
873
+ end
874
+ ```
875
+
876
+ ### Parameters
877
+
878
+ Name | Type | Description | Notes
879
+ ------------- | ------------- | ------------- | -------------
880
+ **publication_href** | **String**| URI of Publication. e.g.: /pulp/api/v3/publications/1/ |
881
+
882
+ ### Return type
883
+
884
+ nil (empty response body)
885
+
886
+ ### Authorization
887
+
888
+ [Basic](../README.md#Basic)
889
+
890
+ ### HTTP request headers
891
+
892
+ - **Content-Type**: application/json
893
+ - **Accept**: application/json
894
+
895
+
896
+
897
+ # **publications_list**
898
+ > InlineResponse2003 publications_list(opts)
899
+
900
+
901
+
902
+
903
+
904
+ ### Example
905
+ ```ruby
906
+ # load the gem
907
+ require 'zest'
908
+ # setup authorization
909
+ Zest.configure do |config|
910
+ # Configure HTTP basic authorization: Basic
911
+ config.username = 'YOUR USERNAME'
912
+ config.password = 'YOUR PASSWORD'
913
+ end
914
+
915
+ api_instance = Zest::PulpApi.new
916
+
917
+ opts = {
918
+ ordering: "ordering_example", # String | Which field to use when ordering the results.
919
+ page: 56, # Integer | A page number within the paginated result set.
920
+ page_size: 56 # Integer | Number of results to return per page.
921
+ }
922
+
923
+ begin
924
+ result = api_instance.publications_list(opts)
925
+ p result
926
+ rescue Zest::ApiError => e
927
+ puts "Exception when calling PulpApi->publications_list: #{e}"
928
+ end
929
+ ```
930
+
931
+ ### Parameters
932
+
933
+ Name | Type | Description | Notes
934
+ ------------- | ------------- | ------------- | -------------
935
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
936
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
937
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
938
+
939
+ ### Return type
940
+
941
+ [**InlineResponse2003**](InlineResponse2003.md)
942
+
943
+ ### Authorization
944
+
945
+ [Basic](../README.md#Basic)
946
+
947
+ ### HTTP request headers
948
+
949
+ - **Content-Type**: application/json
950
+ - **Accept**: application/json
951
+
952
+
953
+
954
+ # **publications_read**
955
+ > Publication publications_read(publication_href)
956
+
957
+
958
+
959
+
960
+
961
+ ### Example
962
+ ```ruby
963
+ # load the gem
964
+ require 'zest'
965
+ # setup authorization
966
+ Zest.configure do |config|
967
+ # Configure HTTP basic authorization: Basic
968
+ config.username = 'YOUR USERNAME'
969
+ config.password = 'YOUR PASSWORD'
970
+ end
971
+
972
+ api_instance = Zest::PulpApi.new
973
+
974
+ publication_href = "publication_href_example" # String | URI of Publication. e.g.: /pulp/api/v3/publications/1/
975
+
976
+
977
+ begin
978
+ result = api_instance.publications_read(publication_href)
979
+ p result
980
+ rescue Zest::ApiError => e
981
+ puts "Exception when calling PulpApi->publications_read: #{e}"
982
+ end
983
+ ```
984
+
985
+ ### Parameters
986
+
987
+ Name | Type | Description | Notes
988
+ ------------- | ------------- | ------------- | -------------
989
+ **publication_href** | **String**| URI of Publication. e.g.: /pulp/api/v3/publications/1/ |
990
+
991
+ ### Return type
992
+
993
+ [**Publication**](Publication.md)
994
+
995
+ ### Authorization
996
+
997
+ [Basic](../README.md#Basic)
998
+
999
+ ### HTTP request headers
1000
+
1001
+ - **Content-Type**: application/json
1002
+ - **Accept**: application/json
1003
+
1004
+
1005
+
1006
+ # **publishers_file_file_create**
1007
+ > FilePublisher publishers_file_file_create(data)
1008
+
1009
+
1010
+
1011
+ ViewSet for File Publishers.
1012
+
1013
+ ### Example
1014
+ ```ruby
1015
+ # load the gem
1016
+ require 'zest'
1017
+ # setup authorization
1018
+ Zest.configure do |config|
1019
+ # Configure HTTP basic authorization: Basic
1020
+ config.username = 'YOUR USERNAME'
1021
+ config.password = 'YOUR PASSWORD'
1022
+ end
1023
+
1024
+ api_instance = Zest::PulpApi.new
1025
+
1026
+ data = Zest::FilePublisher.new # FilePublisher |
1027
+
1028
+
1029
+ begin
1030
+ result = api_instance.publishers_file_file_create(data)
1031
+ p result
1032
+ rescue Zest::ApiError => e
1033
+ puts "Exception when calling PulpApi->publishers_file_file_create: #{e}"
1034
+ end
1035
+ ```
1036
+
1037
+ ### Parameters
1038
+
1039
+ Name | Type | Description | Notes
1040
+ ------------- | ------------- | ------------- | -------------
1041
+ **data** | [**FilePublisher**](FilePublisher.md)| |
1042
+
1043
+ ### Return type
1044
+
1045
+ [**FilePublisher**](FilePublisher.md)
1046
+
1047
+ ### Authorization
1048
+
1049
+ [Basic](../README.md#Basic)
1050
+
1051
+ ### HTTP request headers
1052
+
1053
+ - **Content-Type**: application/json
1054
+ - **Accept**: application/json
1055
+
1056
+
1057
+
1058
+ # **publishers_file_file_delete**
1059
+ > AsyncOperationResponse publishers_file_file_delete(file_publisher_href, )
1060
+
1061
+
1062
+
1063
+ Trigger an asynchronous delete task
1064
+
1065
+ ### Example
1066
+ ```ruby
1067
+ # load the gem
1068
+ require 'zest'
1069
+ # setup authorization
1070
+ Zest.configure do |config|
1071
+ # Configure HTTP basic authorization: Basic
1072
+ config.username = 'YOUR USERNAME'
1073
+ config.password = 'YOUR PASSWORD'
1074
+ end
1075
+
1076
+ api_instance = Zest::PulpApi.new
1077
+
1078
+ file_publisher_href = "file_publisher_href_example" # String | URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
1079
+
1080
+
1081
+ begin
1082
+ result = api_instance.publishers_file_file_delete(file_publisher_href, )
1083
+ p result
1084
+ rescue Zest::ApiError => e
1085
+ puts "Exception when calling PulpApi->publishers_file_file_delete: #{e}"
1086
+ end
1087
+ ```
1088
+
1089
+ ### Parameters
1090
+
1091
+ Name | Type | Description | Notes
1092
+ ------------- | ------------- | ------------- | -------------
1093
+ **file_publisher_href** | **String**| URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/ |
1094
+
1095
+ ### Return type
1096
+
1097
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1098
+
1099
+ ### Authorization
1100
+
1101
+ [Basic](../README.md#Basic)
1102
+
1103
+ ### HTTP request headers
1104
+
1105
+ - **Content-Type**: application/json
1106
+ - **Accept**: application/json
1107
+
1108
+
1109
+
1110
+ # **publishers_file_file_list**
1111
+ > InlineResponse2004 publishers_file_file_list(opts)
1112
+
1113
+
1114
+
1115
+ ViewSet for File Publishers.
1116
+
1117
+ ### Example
1118
+ ```ruby
1119
+ # load the gem
1120
+ require 'zest'
1121
+ # setup authorization
1122
+ Zest.configure do |config|
1123
+ # Configure HTTP basic authorization: Basic
1124
+ config.username = 'YOUR USERNAME'
1125
+ config.password = 'YOUR PASSWORD'
1126
+ end
1127
+
1128
+ api_instance = Zest::PulpApi.new
1129
+
1130
+ opts = {
1131
+ name: "name_example", # String |
1132
+ name__in: "name__in_example", # String | Filter results where name is in a comma-separated list of values
1133
+ _last_updated__lt: "_last_updated__lt_example", # String | Filter results where _last_updated is less than value
1134
+ _last_updated__lte: "_last_updated__lte_example", # String | Filter results where _last_updated is less than or equal to value
1135
+ _last_updated__gt: "_last_updated__gt_example", # String | Filter results where _last_updated is greater than value
1136
+ _last_updated__gte: "_last_updated__gte_example", # String | Filter results where _last_updated is greater than or equal to value
1137
+ _last_updated__range: "_last_updated__range_example", # String | Filter results where _last_updated is between two comma separated values
1138
+ _last_updated: "_last_updated_example", # String | ISO 8601 formatted dates are supported
1139
+ page: 56, # Integer | A page number within the paginated result set.
1140
+ page_size: 56 # Integer | Number of results to return per page.
1141
+ }
1142
+
1143
+ begin
1144
+ result = api_instance.publishers_file_file_list(opts)
1145
+ p result
1146
+ rescue Zest::ApiError => e
1147
+ puts "Exception when calling PulpApi->publishers_file_file_list: #{e}"
1148
+ end
1149
+ ```
1150
+
1151
+ ### Parameters
1152
+
1153
+ Name | Type | Description | Notes
1154
+ ------------- | ------------- | ------------- | -------------
1155
+ **name** | **String**| | [optional]
1156
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
1157
+ **_last_updated__lt** | **String**| Filter results where _last_updated is less than value | [optional]
1158
+ **_last_updated__lte** | **String**| Filter results where _last_updated is less than or equal to value | [optional]
1159
+ **_last_updated__gt** | **String**| Filter results where _last_updated is greater than value | [optional]
1160
+ **_last_updated__gte** | **String**| Filter results where _last_updated is greater than or equal to value | [optional]
1161
+ **_last_updated__range** | **String**| Filter results where _last_updated is between two comma separated values | [optional]
1162
+ **_last_updated** | **String**| ISO 8601 formatted dates are supported | [optional]
1163
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
1164
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
1165
+
1166
+ ### Return type
1167
+
1168
+ [**InlineResponse2004**](InlineResponse2004.md)
1169
+
1170
+ ### Authorization
1171
+
1172
+ [Basic](../README.md#Basic)
1173
+
1174
+ ### HTTP request headers
1175
+
1176
+ - **Content-Type**: application/json
1177
+ - **Accept**: application/json
1178
+
1179
+
1180
+
1181
+ # **publishers_file_file_partial_update**
1182
+ > AsyncOperationResponse publishers_file_file_partial_update(file_publisher_href, data)
1183
+
1184
+
1185
+
1186
+ Trigger an asynchronous partial update task
1187
+
1188
+ ### Example
1189
+ ```ruby
1190
+ # load the gem
1191
+ require 'zest'
1192
+ # setup authorization
1193
+ Zest.configure do |config|
1194
+ # Configure HTTP basic authorization: Basic
1195
+ config.username = 'YOUR USERNAME'
1196
+ config.password = 'YOUR PASSWORD'
1197
+ end
1198
+
1199
+ api_instance = Zest::PulpApi.new
1200
+
1201
+ file_publisher_href = "file_publisher_href_example" # String | URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
1202
+
1203
+ data = Zest::FilePublisher.new # FilePublisher |
1204
+
1205
+
1206
+ begin
1207
+ result = api_instance.publishers_file_file_partial_update(file_publisher_href, data)
1208
+ p result
1209
+ rescue Zest::ApiError => e
1210
+ puts "Exception when calling PulpApi->publishers_file_file_partial_update: #{e}"
1211
+ end
1212
+ ```
1213
+
1214
+ ### Parameters
1215
+
1216
+ Name | Type | Description | Notes
1217
+ ------------- | ------------- | ------------- | -------------
1218
+ **file_publisher_href** | **String**| URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/ |
1219
+ **data** | [**FilePublisher**](FilePublisher.md)| |
1220
+
1221
+ ### Return type
1222
+
1223
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1224
+
1225
+ ### Authorization
1226
+
1227
+ [Basic](../README.md#Basic)
1228
+
1229
+ ### HTTP request headers
1230
+
1231
+ - **Content-Type**: application/json
1232
+ - **Accept**: application/json
1233
+
1234
+
1235
+
1236
+ # **publishers_file_file_publish**
1237
+ > AsyncOperationResponse publishers_file_file_publish(file_publisher_href, data)
1238
+
1239
+
1240
+
1241
+ Trigger an asynchronous task to publish file content.
1242
+
1243
+ ### Example
1244
+ ```ruby
1245
+ # load the gem
1246
+ require 'zest'
1247
+ # setup authorization
1248
+ Zest.configure do |config|
1249
+ # Configure HTTP basic authorization: Basic
1250
+ config.username = 'YOUR USERNAME'
1251
+ config.password = 'YOUR PASSWORD'
1252
+ end
1253
+
1254
+ api_instance = Zest::PulpApi.new
1255
+
1256
+ file_publisher_href = "file_publisher_href_example" # String | URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
1257
+
1258
+ data = Zest::RepositoryPublishURL.new # RepositoryPublishURL |
1259
+
1260
+
1261
+ begin
1262
+ result = api_instance.publishers_file_file_publish(file_publisher_href, data)
1263
+ p result
1264
+ rescue Zest::ApiError => e
1265
+ puts "Exception when calling PulpApi->publishers_file_file_publish: #{e}"
1266
+ end
1267
+ ```
1268
+
1269
+ ### Parameters
1270
+
1271
+ Name | Type | Description | Notes
1272
+ ------------- | ------------- | ------------- | -------------
1273
+ **file_publisher_href** | **String**| URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/ |
1274
+ **data** | [**RepositoryPublishURL**](RepositoryPublishURL.md)| |
1275
+
1276
+ ### Return type
1277
+
1278
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1279
+
1280
+ ### Authorization
1281
+
1282
+ [Basic](../README.md#Basic)
1283
+
1284
+ ### HTTP request headers
1285
+
1286
+ - **Content-Type**: application/json
1287
+ - **Accept**: application/json
1288
+
1289
+
1290
+
1291
+ # **publishers_file_file_read**
1292
+ > FilePublisher publishers_file_file_read(file_publisher_href, )
1293
+
1294
+
1295
+
1296
+ ViewSet for File Publishers.
1297
+
1298
+ ### Example
1299
+ ```ruby
1300
+ # load the gem
1301
+ require 'zest'
1302
+ # setup authorization
1303
+ Zest.configure do |config|
1304
+ # Configure HTTP basic authorization: Basic
1305
+ config.username = 'YOUR USERNAME'
1306
+ config.password = 'YOUR PASSWORD'
1307
+ end
1308
+
1309
+ api_instance = Zest::PulpApi.new
1310
+
1311
+ file_publisher_href = "file_publisher_href_example" # String | URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
1312
+
1313
+
1314
+ begin
1315
+ result = api_instance.publishers_file_file_read(file_publisher_href, )
1316
+ p result
1317
+ rescue Zest::ApiError => e
1318
+ puts "Exception when calling PulpApi->publishers_file_file_read: #{e}"
1319
+ end
1320
+ ```
1321
+
1322
+ ### Parameters
1323
+
1324
+ Name | Type | Description | Notes
1325
+ ------------- | ------------- | ------------- | -------------
1326
+ **file_publisher_href** | **String**| URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/ |
1327
+
1328
+ ### Return type
1329
+
1330
+ [**FilePublisher**](FilePublisher.md)
1331
+
1332
+ ### Authorization
1333
+
1334
+ [Basic](../README.md#Basic)
1335
+
1336
+ ### HTTP request headers
1337
+
1338
+ - **Content-Type**: application/json
1339
+ - **Accept**: application/json
1340
+
1341
+
1342
+
1343
+ # **publishers_file_file_update**
1344
+ > AsyncOperationResponse publishers_file_file_update(file_publisher_href, data)
1345
+
1346
+
1347
+
1348
+ Trigger an asynchronous update task
1349
+
1350
+ ### Example
1351
+ ```ruby
1352
+ # load the gem
1353
+ require 'zest'
1354
+ # setup authorization
1355
+ Zest.configure do |config|
1356
+ # Configure HTTP basic authorization: Basic
1357
+ config.username = 'YOUR USERNAME'
1358
+ config.password = 'YOUR PASSWORD'
1359
+ end
1360
+
1361
+ api_instance = Zest::PulpApi.new
1362
+
1363
+ file_publisher_href = "file_publisher_href_example" # String | URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/
1364
+
1365
+ data = Zest::FilePublisher.new # FilePublisher |
1366
+
1367
+
1368
+ begin
1369
+ result = api_instance.publishers_file_file_update(file_publisher_href, data)
1370
+ p result
1371
+ rescue Zest::ApiError => e
1372
+ puts "Exception when calling PulpApi->publishers_file_file_update: #{e}"
1373
+ end
1374
+ ```
1375
+
1376
+ ### Parameters
1377
+
1378
+ Name | Type | Description | Notes
1379
+ ------------- | ------------- | ------------- | -------------
1380
+ **file_publisher_href** | **String**| URI of File Publisher. e.g.: /pulp/api/v3/publishers/file/file/1/ |
1381
+ **data** | [**FilePublisher**](FilePublisher.md)| |
1382
+
1383
+ ### Return type
1384
+
1385
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1386
+
1387
+ ### Authorization
1388
+
1389
+ [Basic](../README.md#Basic)
1390
+
1391
+ ### HTTP request headers
1392
+
1393
+ - **Content-Type**: application/json
1394
+ - **Accept**: application/json
1395
+
1396
+
1397
+
1398
+ # **remotes_file_file_create**
1399
+ > FileRemote remotes_file_file_create(data)
1400
+
1401
+
1402
+
1403
+ ViewSet for File Remotes.
1404
+
1405
+ ### Example
1406
+ ```ruby
1407
+ # load the gem
1408
+ require 'zest'
1409
+ # setup authorization
1410
+ Zest.configure do |config|
1411
+ # Configure HTTP basic authorization: Basic
1412
+ config.username = 'YOUR USERNAME'
1413
+ config.password = 'YOUR PASSWORD'
1414
+ end
1415
+
1416
+ api_instance = Zest::PulpApi.new
1417
+
1418
+ data = Zest::FileRemote.new # FileRemote |
1419
+
1420
+
1421
+ begin
1422
+ result = api_instance.remotes_file_file_create(data)
1423
+ p result
1424
+ rescue Zest::ApiError => e
1425
+ puts "Exception when calling PulpApi->remotes_file_file_create: #{e}"
1426
+ end
1427
+ ```
1428
+
1429
+ ### Parameters
1430
+
1431
+ Name | Type | Description | Notes
1432
+ ------------- | ------------- | ------------- | -------------
1433
+ **data** | [**FileRemote**](FileRemote.md)| |
1434
+
1435
+ ### Return type
1436
+
1437
+ [**FileRemote**](FileRemote.md)
1438
+
1439
+ ### Authorization
1440
+
1441
+ [Basic](../README.md#Basic)
1442
+
1443
+ ### HTTP request headers
1444
+
1445
+ - **Content-Type**: application/json
1446
+ - **Accept**: application/json
1447
+
1448
+
1449
+
1450
+ # **remotes_file_file_delete**
1451
+ > AsyncOperationResponse remotes_file_file_delete(file_remote_href, )
1452
+
1453
+
1454
+
1455
+ Trigger an asynchronous delete task
1456
+
1457
+ ### Example
1458
+ ```ruby
1459
+ # load the gem
1460
+ require 'zest'
1461
+ # setup authorization
1462
+ Zest.configure do |config|
1463
+ # Configure HTTP basic authorization: Basic
1464
+ config.username = 'YOUR USERNAME'
1465
+ config.password = 'YOUR PASSWORD'
1466
+ end
1467
+
1468
+ api_instance = Zest::PulpApi.new
1469
+
1470
+ file_remote_href = "file_remote_href_example" # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
1471
+
1472
+
1473
+ begin
1474
+ result = api_instance.remotes_file_file_delete(file_remote_href, )
1475
+ p result
1476
+ rescue Zest::ApiError => e
1477
+ puts "Exception when calling PulpApi->remotes_file_file_delete: #{e}"
1478
+ end
1479
+ ```
1480
+
1481
+ ### Parameters
1482
+
1483
+ Name | Type | Description | Notes
1484
+ ------------- | ------------- | ------------- | -------------
1485
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ |
1486
+
1487
+ ### Return type
1488
+
1489
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1490
+
1491
+ ### Authorization
1492
+
1493
+ [Basic](../README.md#Basic)
1494
+
1495
+ ### HTTP request headers
1496
+
1497
+ - **Content-Type**: application/json
1498
+ - **Accept**: application/json
1499
+
1500
+
1501
+
1502
+ # **remotes_file_file_list**
1503
+ > InlineResponse2005 remotes_file_file_list(opts)
1504
+
1505
+
1506
+
1507
+ ViewSet for File Remotes.
1508
+
1509
+ ### Example
1510
+ ```ruby
1511
+ # load the gem
1512
+ require 'zest'
1513
+ # setup authorization
1514
+ Zest.configure do |config|
1515
+ # Configure HTTP basic authorization: Basic
1516
+ config.username = 'YOUR USERNAME'
1517
+ config.password = 'YOUR PASSWORD'
1518
+ end
1519
+
1520
+ api_instance = Zest::PulpApi.new
1521
+
1522
+ opts = {
1523
+ name: "name_example", # String |
1524
+ name__in: "name__in_example", # String | Filter results where name is in a comma-separated list of values
1525
+ _last_updated__lt: "_last_updated__lt_example", # String | Filter results where _last_updated is less than value
1526
+ _last_updated__lte: "_last_updated__lte_example", # String | Filter results where _last_updated is less than or equal to value
1527
+ _last_updated__gt: "_last_updated__gt_example", # String | Filter results where _last_updated is greater than value
1528
+ _last_updated__gte: "_last_updated__gte_example", # String | Filter results where _last_updated is greater than or equal to value
1529
+ _last_updated__range: "_last_updated__range_example", # String | Filter results where _last_updated is between two comma separated values
1530
+ _last_updated: "_last_updated_example", # String | ISO 8601 formatted dates are supported
1531
+ page: 56, # Integer | A page number within the paginated result set.
1532
+ page_size: 56 # Integer | Number of results to return per page.
1533
+ }
1534
+
1535
+ begin
1536
+ result = api_instance.remotes_file_file_list(opts)
1537
+ p result
1538
+ rescue Zest::ApiError => e
1539
+ puts "Exception when calling PulpApi->remotes_file_file_list: #{e}"
1540
+ end
1541
+ ```
1542
+
1543
+ ### Parameters
1544
+
1545
+ Name | Type | Description | Notes
1546
+ ------------- | ------------- | ------------- | -------------
1547
+ **name** | **String**| | [optional]
1548
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
1549
+ **_last_updated__lt** | **String**| Filter results where _last_updated is less than value | [optional]
1550
+ **_last_updated__lte** | **String**| Filter results where _last_updated is less than or equal to value | [optional]
1551
+ **_last_updated__gt** | **String**| Filter results where _last_updated is greater than value | [optional]
1552
+ **_last_updated__gte** | **String**| Filter results where _last_updated is greater than or equal to value | [optional]
1553
+ **_last_updated__range** | **String**| Filter results where _last_updated is between two comma separated values | [optional]
1554
+ **_last_updated** | **String**| ISO 8601 formatted dates are supported | [optional]
1555
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
1556
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
1557
+
1558
+ ### Return type
1559
+
1560
+ [**InlineResponse2005**](InlineResponse2005.md)
1561
+
1562
+ ### Authorization
1563
+
1564
+ [Basic](../README.md#Basic)
1565
+
1566
+ ### HTTP request headers
1567
+
1568
+ - **Content-Type**: application/json
1569
+ - **Accept**: application/json
1570
+
1571
+
1572
+
1573
+ # **remotes_file_file_partial_update**
1574
+ > AsyncOperationResponse remotes_file_file_partial_update(file_remote_href, data)
1575
+
1576
+
1577
+
1578
+ Trigger an asynchronous partial update task
1579
+
1580
+ ### Example
1581
+ ```ruby
1582
+ # load the gem
1583
+ require 'zest'
1584
+ # setup authorization
1585
+ Zest.configure do |config|
1586
+ # Configure HTTP basic authorization: Basic
1587
+ config.username = 'YOUR USERNAME'
1588
+ config.password = 'YOUR PASSWORD'
1589
+ end
1590
+
1591
+ api_instance = Zest::PulpApi.new
1592
+
1593
+ file_remote_href = "file_remote_href_example" # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
1594
+
1595
+ data = Zest::FileRemote.new # FileRemote |
1596
+
1597
+
1598
+ begin
1599
+ result = api_instance.remotes_file_file_partial_update(file_remote_href, data)
1600
+ p result
1601
+ rescue Zest::ApiError => e
1602
+ puts "Exception when calling PulpApi->remotes_file_file_partial_update: #{e}"
1603
+ end
1604
+ ```
1605
+
1606
+ ### Parameters
1607
+
1608
+ Name | Type | Description | Notes
1609
+ ------------- | ------------- | ------------- | -------------
1610
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ |
1611
+ **data** | [**FileRemote**](FileRemote.md)| |
1612
+
1613
+ ### Return type
1614
+
1615
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1616
+
1617
+ ### Authorization
1618
+
1619
+ [Basic](../README.md#Basic)
1620
+
1621
+ ### HTTP request headers
1622
+
1623
+ - **Content-Type**: application/json
1624
+ - **Accept**: application/json
1625
+
1626
+
1627
+
1628
+ # **remotes_file_file_read**
1629
+ > FileRemote remotes_file_file_read(file_remote_href, )
1630
+
1631
+
1632
+
1633
+ ViewSet for File Remotes.
1634
+
1635
+ ### Example
1636
+ ```ruby
1637
+ # load the gem
1638
+ require 'zest'
1639
+ # setup authorization
1640
+ Zest.configure do |config|
1641
+ # Configure HTTP basic authorization: Basic
1642
+ config.username = 'YOUR USERNAME'
1643
+ config.password = 'YOUR PASSWORD'
1644
+ end
1645
+
1646
+ api_instance = Zest::PulpApi.new
1647
+
1648
+ file_remote_href = "file_remote_href_example" # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
1649
+
1650
+
1651
+ begin
1652
+ result = api_instance.remotes_file_file_read(file_remote_href, )
1653
+ p result
1654
+ rescue Zest::ApiError => e
1655
+ puts "Exception when calling PulpApi->remotes_file_file_read: #{e}"
1656
+ end
1657
+ ```
1658
+
1659
+ ### Parameters
1660
+
1661
+ Name | Type | Description | Notes
1662
+ ------------- | ------------- | ------------- | -------------
1663
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ |
1664
+
1665
+ ### Return type
1666
+
1667
+ [**FileRemote**](FileRemote.md)
1668
+
1669
+ ### Authorization
1670
+
1671
+ [Basic](../README.md#Basic)
1672
+
1673
+ ### HTTP request headers
1674
+
1675
+ - **Content-Type**: application/json
1676
+ - **Accept**: application/json
1677
+
1678
+
1679
+
1680
+ # **remotes_file_file_sync**
1681
+ > AsyncOperationResponse remotes_file_file_sync(file_remote_href, data)
1682
+
1683
+
1684
+
1685
+ Trigger an asynchronous task to sync file content.
1686
+
1687
+ ### Example
1688
+ ```ruby
1689
+ # load the gem
1690
+ require 'zest'
1691
+ # setup authorization
1692
+ Zest.configure do |config|
1693
+ # Configure HTTP basic authorization: Basic
1694
+ config.username = 'YOUR USERNAME'
1695
+ config.password = 'YOUR PASSWORD'
1696
+ end
1697
+
1698
+ api_instance = Zest::PulpApi.new
1699
+
1700
+ file_remote_href = "file_remote_href_example" # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
1701
+
1702
+ data = Zest::RepositorySyncURL.new # RepositorySyncURL |
1703
+
1704
+
1705
+ begin
1706
+ result = api_instance.remotes_file_file_sync(file_remote_href, data)
1707
+ p result
1708
+ rescue Zest::ApiError => e
1709
+ puts "Exception when calling PulpApi->remotes_file_file_sync: #{e}"
1710
+ end
1711
+ ```
1712
+
1713
+ ### Parameters
1714
+
1715
+ Name | Type | Description | Notes
1716
+ ------------- | ------------- | ------------- | -------------
1717
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ |
1718
+ **data** | [**RepositorySyncURL**](RepositorySyncURL.md)| |
1719
+
1720
+ ### Return type
1721
+
1722
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1723
+
1724
+ ### Authorization
1725
+
1726
+ [Basic](../README.md#Basic)
1727
+
1728
+ ### HTTP request headers
1729
+
1730
+ - **Content-Type**: application/json
1731
+ - **Accept**: application/json
1732
+
1733
+
1734
+
1735
+ # **remotes_file_file_update**
1736
+ > AsyncOperationResponse remotes_file_file_update(file_remote_href, data)
1737
+
1738
+
1739
+
1740
+ Trigger an asynchronous update task
1741
+
1742
+ ### Example
1743
+ ```ruby
1744
+ # load the gem
1745
+ require 'zest'
1746
+ # setup authorization
1747
+ Zest.configure do |config|
1748
+ # Configure HTTP basic authorization: Basic
1749
+ config.username = 'YOUR USERNAME'
1750
+ config.password = 'YOUR PASSWORD'
1751
+ end
1752
+
1753
+ api_instance = Zest::PulpApi.new
1754
+
1755
+ file_remote_href = "file_remote_href_example" # String | URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/
1756
+
1757
+ data = Zest::FileRemote.new # FileRemote |
1758
+
1759
+
1760
+ begin
1761
+ result = api_instance.remotes_file_file_update(file_remote_href, data)
1762
+ p result
1763
+ rescue Zest::ApiError => e
1764
+ puts "Exception when calling PulpApi->remotes_file_file_update: #{e}"
1765
+ end
1766
+ ```
1767
+
1768
+ ### Parameters
1769
+
1770
+ Name | Type | Description | Notes
1771
+ ------------- | ------------- | ------------- | -------------
1772
+ **file_remote_href** | **String**| URI of File Remote. e.g.: /pulp/api/v3/remotes/file/file/1/ |
1773
+ **data** | [**FileRemote**](FileRemote.md)| |
1774
+
1775
+ ### Return type
1776
+
1777
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1778
+
1779
+ ### Authorization
1780
+
1781
+ [Basic](../README.md#Basic)
1782
+
1783
+ ### HTTP request headers
1784
+
1785
+ - **Content-Type**: application/json
1786
+ - **Accept**: application/json
1787
+
1788
+
1789
+
1790
+ # **repositories_create**
1791
+ > Repository repositories_create(data)
1792
+
1793
+
1794
+
1795
+
1796
+
1797
+ ### Example
1798
+ ```ruby
1799
+ # load the gem
1800
+ require 'zest'
1801
+ # setup authorization
1802
+ Zest.configure do |config|
1803
+ # Configure HTTP basic authorization: Basic
1804
+ config.username = 'YOUR USERNAME'
1805
+ config.password = 'YOUR PASSWORD'
1806
+ end
1807
+
1808
+ api_instance = Zest::PulpApi.new
1809
+
1810
+ data = Zest::Repository.new # Repository |
1811
+
1812
+
1813
+ begin
1814
+ result = api_instance.repositories_create(data)
1815
+ p result
1816
+ rescue Zest::ApiError => e
1817
+ puts "Exception when calling PulpApi->repositories_create: #{e}"
1818
+ end
1819
+ ```
1820
+
1821
+ ### Parameters
1822
+
1823
+ Name | Type | Description | Notes
1824
+ ------------- | ------------- | ------------- | -------------
1825
+ **data** | [**Repository**](Repository.md)| |
1826
+
1827
+ ### Return type
1828
+
1829
+ [**Repository**](Repository.md)
1830
+
1831
+ ### Authorization
1832
+
1833
+ [Basic](../README.md#Basic)
1834
+
1835
+ ### HTTP request headers
1836
+
1837
+ - **Content-Type**: application/json
1838
+ - **Accept**: application/json
1839
+
1840
+
1841
+
1842
+ # **repositories_delete**
1843
+ > AsyncOperationResponse repositories_delete(repository_href, )
1844
+
1845
+
1846
+
1847
+ Trigger an asynchronous task to delete a repository.
1848
+
1849
+ ### Example
1850
+ ```ruby
1851
+ # load the gem
1852
+ require 'zest'
1853
+ # setup authorization
1854
+ Zest.configure do |config|
1855
+ # Configure HTTP basic authorization: Basic
1856
+ config.username = 'YOUR USERNAME'
1857
+ config.password = 'YOUR PASSWORD'
1858
+ end
1859
+
1860
+ api_instance = Zest::PulpApi.new
1861
+
1862
+ repository_href = "repository_href_example" # String | URI of Repository. e.g.: /pulp/api/v3/repositories/1/
1863
+
1864
+
1865
+ begin
1866
+ result = api_instance.repositories_delete(repository_href, )
1867
+ p result
1868
+ rescue Zest::ApiError => e
1869
+ puts "Exception when calling PulpApi->repositories_delete: #{e}"
1870
+ end
1871
+ ```
1872
+
1873
+ ### Parameters
1874
+
1875
+ Name | Type | Description | Notes
1876
+ ------------- | ------------- | ------------- | -------------
1877
+ **repository_href** | **String**| URI of Repository. e.g.: /pulp/api/v3/repositories/1/ |
1878
+
1879
+ ### Return type
1880
+
1881
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
1882
+
1883
+ ### Authorization
1884
+
1885
+ [Basic](../README.md#Basic)
1886
+
1887
+ ### HTTP request headers
1888
+
1889
+ - **Content-Type**: application/json
1890
+ - **Accept**: application/json
1891
+
1892
+
1893
+
1894
+ # **repositories_list**
1895
+ > InlineResponse2006 repositories_list(opts)
1896
+
1897
+
1898
+
1899
+
1900
+
1901
+ ### Example
1902
+ ```ruby
1903
+ # load the gem
1904
+ require 'zest'
1905
+ # setup authorization
1906
+ Zest.configure do |config|
1907
+ # Configure HTTP basic authorization: Basic
1908
+ config.username = 'YOUR USERNAME'
1909
+ config.password = 'YOUR PASSWORD'
1910
+ end
1911
+
1912
+ api_instance = Zest::PulpApi.new
1913
+
1914
+ opts = {
1915
+ name: "name_example", # String |
1916
+ name__in: "name__in_example", # String | Filter results where name is in a comma-separated list of values
1917
+ page: 56, # Integer | A page number within the paginated result set.
1918
+ page_size: 56 # Integer | Number of results to return per page.
1919
+ }
1920
+
1921
+ begin
1922
+ result = api_instance.repositories_list(opts)
1923
+ p result
1924
+ rescue Zest::ApiError => e
1925
+ puts "Exception when calling PulpApi->repositories_list: #{e}"
1926
+ end
1927
+ ```
1928
+
1929
+ ### Parameters
1930
+
1931
+ Name | Type | Description | Notes
1932
+ ------------- | ------------- | ------------- | -------------
1933
+ **name** | **String**| | [optional]
1934
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
1935
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
1936
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
1937
+
1938
+ ### Return type
1939
+
1940
+ [**InlineResponse2006**](InlineResponse2006.md)
1941
+
1942
+ ### Authorization
1943
+
1944
+ [Basic](../README.md#Basic)
1945
+
1946
+ ### HTTP request headers
1947
+
1948
+ - **Content-Type**: application/json
1949
+ - **Accept**: application/json
1950
+
1951
+
1952
+
1953
+ # **repositories_partial_update**
1954
+ > Repository repositories_partial_update(repository_href, data)
1955
+
1956
+
1957
+
1958
+
1959
+
1960
+ ### Example
1961
+ ```ruby
1962
+ # load the gem
1963
+ require 'zest'
1964
+ # setup authorization
1965
+ Zest.configure do |config|
1966
+ # Configure HTTP basic authorization: Basic
1967
+ config.username = 'YOUR USERNAME'
1968
+ config.password = 'YOUR PASSWORD'
1969
+ end
1970
+
1971
+ api_instance = Zest::PulpApi.new
1972
+
1973
+ repository_href = "repository_href_example" # String | URI of Repository. e.g.: /pulp/api/v3/repositories/1/
1974
+
1975
+ data = Zest::Repository.new # Repository |
1976
+
1977
+
1978
+ begin
1979
+ result = api_instance.repositories_partial_update(repository_href, data)
1980
+ p result
1981
+ rescue Zest::ApiError => e
1982
+ puts "Exception when calling PulpApi->repositories_partial_update: #{e}"
1983
+ end
1984
+ ```
1985
+
1986
+ ### Parameters
1987
+
1988
+ Name | Type | Description | Notes
1989
+ ------------- | ------------- | ------------- | -------------
1990
+ **repository_href** | **String**| URI of Repository. e.g.: /pulp/api/v3/repositories/1/ |
1991
+ **data** | [**Repository**](Repository.md)| |
1992
+
1993
+ ### Return type
1994
+
1995
+ [**Repository**](Repository.md)
1996
+
1997
+ ### Authorization
1998
+
1999
+ [Basic](../README.md#Basic)
2000
+
2001
+ ### HTTP request headers
2002
+
2003
+ - **Content-Type**: application/json
2004
+ - **Accept**: application/json
2005
+
2006
+
2007
+
2008
+ # **repositories_read**
2009
+ > Repository repositories_read(repository_href, )
2010
+
2011
+
2012
+
2013
+
2014
+
2015
+ ### Example
2016
+ ```ruby
2017
+ # load the gem
2018
+ require 'zest'
2019
+ # setup authorization
2020
+ Zest.configure do |config|
2021
+ # Configure HTTP basic authorization: Basic
2022
+ config.username = 'YOUR USERNAME'
2023
+ config.password = 'YOUR PASSWORD'
2024
+ end
2025
+
2026
+ api_instance = Zest::PulpApi.new
2027
+
2028
+ repository_href = "repository_href_example" # String | URI of Repository. e.g.: /pulp/api/v3/repositories/1/
2029
+
2030
+
2031
+ begin
2032
+ result = api_instance.repositories_read(repository_href, )
2033
+ p result
2034
+ rescue Zest::ApiError => e
2035
+ puts "Exception when calling PulpApi->repositories_read: #{e}"
2036
+ end
2037
+ ```
2038
+
2039
+ ### Parameters
2040
+
2041
+ Name | Type | Description | Notes
2042
+ ------------- | ------------- | ------------- | -------------
2043
+ **repository_href** | **String**| URI of Repository. e.g.: /pulp/api/v3/repositories/1/ |
2044
+
2045
+ ### Return type
2046
+
2047
+ [**Repository**](Repository.md)
2048
+
2049
+ ### Authorization
2050
+
2051
+ [Basic](../README.md#Basic)
2052
+
2053
+ ### HTTP request headers
2054
+
2055
+ - **Content-Type**: application/json
2056
+ - **Accept**: application/json
2057
+
2058
+
2059
+
2060
+ # **repositories_update**
2061
+ > AsyncOperationResponse repositories_update(repository_href, data)
2062
+
2063
+
2064
+
2065
+ Trigger an asynchronous task to updatea repository.
2066
+
2067
+ ### Example
2068
+ ```ruby
2069
+ # load the gem
2070
+ require 'zest'
2071
+ # setup authorization
2072
+ Zest.configure do |config|
2073
+ # Configure HTTP basic authorization: Basic
2074
+ config.username = 'YOUR USERNAME'
2075
+ config.password = 'YOUR PASSWORD'
2076
+ end
2077
+
2078
+ api_instance = Zest::PulpApi.new
2079
+
2080
+ repository_href = "repository_href_example" # String | URI of Repository. e.g.: /pulp/api/v3/repositories/1/
2081
+
2082
+ data = Zest::Repository.new # Repository |
2083
+
2084
+
2085
+ begin
2086
+ result = api_instance.repositories_update(repository_href, data)
2087
+ p result
2088
+ rescue Zest::ApiError => e
2089
+ puts "Exception when calling PulpApi->repositories_update: #{e}"
2090
+ end
2091
+ ```
2092
+
2093
+ ### Parameters
2094
+
2095
+ Name | Type | Description | Notes
2096
+ ------------- | ------------- | ------------- | -------------
2097
+ **repository_href** | **String**| URI of Repository. e.g.: /pulp/api/v3/repositories/1/ |
2098
+ **data** | [**Repository**](Repository.md)| |
2099
+
2100
+ ### Return type
2101
+
2102
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
2103
+
2104
+ ### Authorization
2105
+
2106
+ [Basic](../README.md#Basic)
2107
+
2108
+ ### HTTP request headers
2109
+
2110
+ - **Content-Type**: application/json
2111
+ - **Accept**: application/json
2112
+
2113
+
2114
+
2115
+ # **repositories_versions_create**
2116
+ > AsyncOperationResponse repositories_versions_create(repository_pk, data)
2117
+
2118
+
2119
+
2120
+ Trigger an asynchronous task to create a new repository version.
2121
+
2122
+ ### Example
2123
+ ```ruby
2124
+ # load the gem
2125
+ require 'zest'
2126
+ # setup authorization
2127
+ Zest.configure do |config|
2128
+ # Configure HTTP basic authorization: Basic
2129
+ config.username = 'YOUR USERNAME'
2130
+ config.password = 'YOUR PASSWORD'
2131
+ end
2132
+
2133
+ api_instance = Zest::PulpApi.new
2134
+
2135
+ repository_pk = "repository_pk_example" # String |
2136
+
2137
+ data = Zest::RepositoryVersionCreate.new # RepositoryVersionCreate |
2138
+
2139
+
2140
+ begin
2141
+ result = api_instance.repositories_versions_create(repository_pk, data)
2142
+ p result
2143
+ rescue Zest::ApiError => e
2144
+ puts "Exception when calling PulpApi->repositories_versions_create: #{e}"
2145
+ end
2146
+ ```
2147
+
2148
+ ### Parameters
2149
+
2150
+ Name | Type | Description | Notes
2151
+ ------------- | ------------- | ------------- | -------------
2152
+ **repository_pk** | **String**| |
2153
+ **data** | [**RepositoryVersionCreate**](RepositoryVersionCreate.md)| |
2154
+
2155
+ ### Return type
2156
+
2157
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
2158
+
2159
+ ### Authorization
2160
+
2161
+ [Basic](../README.md#Basic)
2162
+
2163
+ ### HTTP request headers
2164
+
2165
+ - **Content-Type**: application/json
2166
+ - **Accept**: application/json
2167
+
2168
+
2169
+
2170
+ # **repositories_versions_delete**
2171
+ > AsyncOperationResponse repositories_versions_delete(repository_version_href, )
2172
+
2173
+
2174
+
2175
+ Trigger an asynchronous task to delete a repositroy version.
2176
+
2177
+ ### Example
2178
+ ```ruby
2179
+ # load the gem
2180
+ require 'zest'
2181
+ # setup authorization
2182
+ Zest.configure do |config|
2183
+ # Configure HTTP basic authorization: Basic
2184
+ config.username = 'YOUR USERNAME'
2185
+ config.password = 'YOUR PASSWORD'
2186
+ end
2187
+
2188
+ api_instance = Zest::PulpApi.new
2189
+
2190
+ repository_version_href = "repository_version_href_example" # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/
2191
+
2192
+
2193
+ begin
2194
+ result = api_instance.repositories_versions_delete(repository_version_href, )
2195
+ p result
2196
+ rescue Zest::ApiError => e
2197
+ puts "Exception when calling PulpApi->repositories_versions_delete: #{e}"
2198
+ end
2199
+ ```
2200
+
2201
+ ### Parameters
2202
+
2203
+ Name | Type | Description | Notes
2204
+ ------------- | ------------- | ------------- | -------------
2205
+ **repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/ |
2206
+
2207
+ ### Return type
2208
+
2209
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
2210
+
2211
+ ### Authorization
2212
+
2213
+ [Basic](../README.md#Basic)
2214
+
2215
+ ### HTTP request headers
2216
+
2217
+ - **Content-Type**: application/json
2218
+ - **Accept**: application/json
2219
+
2220
+
2221
+
2222
+ # **repositories_versions_list**
2223
+ > InlineResponse2007 repositories_versions_list(repository_pk, , opts)
2224
+
2225
+
2226
+
2227
+
2228
+
2229
+ ### Example
2230
+ ```ruby
2231
+ # load the gem
2232
+ require 'zest'
2233
+ # setup authorization
2234
+ Zest.configure do |config|
2235
+ # Configure HTTP basic authorization: Basic
2236
+ config.username = 'YOUR USERNAME'
2237
+ config.password = 'YOUR PASSWORD'
2238
+ end
2239
+
2240
+ api_instance = Zest::PulpApi.new
2241
+
2242
+ repository_pk = "repository_pk_example" # String |
2243
+
2244
+ opts = {
2245
+ ordering: "ordering_example", # String | Which field to use when ordering the results.
2246
+ number: 8.14, # Float |
2247
+ number__lt: 8.14, # Float | Filter results where number is less than value
2248
+ number__lte: 8.14, # Float | Filter results where number is less than or equal to value
2249
+ number__gt: 8.14, # Float | Filter results where number is greater than value
2250
+ number__gte: 8.14, # Float | Filter results where number is greater than or equal to value
2251
+ number__range: 8.14, # Float | Filter results where number is between two comma separated values
2252
+ _created__lt: "_created__lt_example", # String | Filter results where _created is less than value
2253
+ _created__lte: "_created__lte_example", # String | Filter results where _created is less than or equal to value
2254
+ _created__gt: "_created__gt_example", # String | Filter results where _created is greater than value
2255
+ _created__gte: "_created__gte_example", # String | Filter results where _created is greater than or equal to value
2256
+ _created__range: "_created__range_example", # String | Filter results where _created is between two comma separated values
2257
+ content: "content_example", # String | Content Unit referenced by HREF
2258
+ _created: "_created_example", # String | ISO 8601 formatted dates are supported
2259
+ page: 56, # Integer | A page number within the paginated result set.
2260
+ page_size: 56 # Integer | Number of results to return per page.
2261
+ }
2262
+
2263
+ begin
2264
+ result = api_instance.repositories_versions_list(repository_pk, , opts)
2265
+ p result
2266
+ rescue Zest::ApiError => e
2267
+ puts "Exception when calling PulpApi->repositories_versions_list: #{e}"
2268
+ end
2269
+ ```
2270
+
2271
+ ### Parameters
2272
+
2273
+ Name | Type | Description | Notes
2274
+ ------------- | ------------- | ------------- | -------------
2275
+ **repository_pk** | **String**| |
2276
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
2277
+ **number** | **Float**| | [optional]
2278
+ **number__lt** | **Float**| Filter results where number is less than value | [optional]
2279
+ **number__lte** | **Float**| Filter results where number is less than or equal to value | [optional]
2280
+ **number__gt** | **Float**| Filter results where number is greater than value | [optional]
2281
+ **number__gte** | **Float**| Filter results where number is greater than or equal to value | [optional]
2282
+ **number__range** | **Float**| Filter results where number is between two comma separated values | [optional]
2283
+ **_created__lt** | **String**| Filter results where _created is less than value | [optional]
2284
+ **_created__lte** | **String**| Filter results where _created is less than or equal to value | [optional]
2285
+ **_created__gt** | **String**| Filter results where _created is greater than value | [optional]
2286
+ **_created__gte** | **String**| Filter results where _created is greater than or equal to value | [optional]
2287
+ **_created__range** | **String**| Filter results where _created is between two comma separated values | [optional]
2288
+ **content** | **String**| Content Unit referenced by HREF | [optional]
2289
+ **_created** | **String**| ISO 8601 formatted dates are supported | [optional]
2290
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
2291
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
2292
+
2293
+ ### Return type
2294
+
2295
+ [**InlineResponse2007**](InlineResponse2007.md)
2296
+
2297
+ ### Authorization
2298
+
2299
+ [Basic](../README.md#Basic)
2300
+
2301
+ ### HTTP request headers
2302
+
2303
+ - **Content-Type**: application/json
2304
+ - **Accept**: application/json
2305
+
2306
+
2307
+
2308
+ # **repositories_versions_partial_update**
2309
+ > RepositoryVersion repositories_versions_partial_update(repository_version_href, data)
2310
+
2311
+
2312
+
2313
+
2314
+
2315
+ ### Example
2316
+ ```ruby
2317
+ # load the gem
2318
+ require 'zest'
2319
+ # setup authorization
2320
+ Zest.configure do |config|
2321
+ # Configure HTTP basic authorization: Basic
2322
+ config.username = 'YOUR USERNAME'
2323
+ config.password = 'YOUR PASSWORD'
2324
+ end
2325
+
2326
+ api_instance = Zest::PulpApi.new
2327
+
2328
+ repository_version_href = "repository_version_href_example" # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/
2329
+
2330
+ data = Zest::RepositoryVersion.new # RepositoryVersion |
2331
+
2332
+
2333
+ begin
2334
+ result = api_instance.repositories_versions_partial_update(repository_version_href, data)
2335
+ p result
2336
+ rescue Zest::ApiError => e
2337
+ puts "Exception when calling PulpApi->repositories_versions_partial_update: #{e}"
2338
+ end
2339
+ ```
2340
+
2341
+ ### Parameters
2342
+
2343
+ Name | Type | Description | Notes
2344
+ ------------- | ------------- | ------------- | -------------
2345
+ **repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/ |
2346
+ **data** | [**RepositoryVersion**](RepositoryVersion.md)| |
2347
+
2348
+ ### Return type
2349
+
2350
+ [**RepositoryVersion**](RepositoryVersion.md)
2351
+
2352
+ ### Authorization
2353
+
2354
+ [Basic](../README.md#Basic)
2355
+
2356
+ ### HTTP request headers
2357
+
2358
+ - **Content-Type**: application/json
2359
+ - **Accept**: application/json
2360
+
2361
+
2362
+
2363
+ # **repositories_versions_read**
2364
+ > RepositoryVersion repositories_versions_read(repository_version_href, )
2365
+
2366
+
2367
+
2368
+
2369
+
2370
+ ### Example
2371
+ ```ruby
2372
+ # load the gem
2373
+ require 'zest'
2374
+ # setup authorization
2375
+ Zest.configure do |config|
2376
+ # Configure HTTP basic authorization: Basic
2377
+ config.username = 'YOUR USERNAME'
2378
+ config.password = 'YOUR PASSWORD'
2379
+ end
2380
+
2381
+ api_instance = Zest::PulpApi.new
2382
+
2383
+ repository_version_href = "repository_version_href_example" # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/
2384
+
2385
+
2386
+ begin
2387
+ result = api_instance.repositories_versions_read(repository_version_href, )
2388
+ p result
2389
+ rescue Zest::ApiError => e
2390
+ puts "Exception when calling PulpApi->repositories_versions_read: #{e}"
2391
+ end
2392
+ ```
2393
+
2394
+ ### Parameters
2395
+
2396
+ Name | Type | Description | Notes
2397
+ ------------- | ------------- | ------------- | -------------
2398
+ **repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/ |
2399
+
2400
+ ### Return type
2401
+
2402
+ [**RepositoryVersion**](RepositoryVersion.md)
2403
+
2404
+ ### Authorization
2405
+
2406
+ [Basic](../README.md#Basic)
2407
+
2408
+ ### HTTP request headers
2409
+
2410
+ - **Content-Type**: application/json
2411
+ - **Accept**: application/json
2412
+
2413
+
2414
+
2415
+ # **repositories_versions_update**
2416
+ > RepositoryVersion repositories_versions_update(repository_version_href, data)
2417
+
2418
+
2419
+
2420
+
2421
+
2422
+ ### Example
2423
+ ```ruby
2424
+ # load the gem
2425
+ require 'zest'
2426
+ # setup authorization
2427
+ Zest.configure do |config|
2428
+ # Configure HTTP basic authorization: Basic
2429
+ config.username = 'YOUR USERNAME'
2430
+ config.password = 'YOUR PASSWORD'
2431
+ end
2432
+
2433
+ api_instance = Zest::PulpApi.new
2434
+
2435
+ repository_version_href = "repository_version_href_example" # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/
2436
+
2437
+ data = Zest::RepositoryVersion.new # RepositoryVersion |
2438
+
2439
+
2440
+ begin
2441
+ result = api_instance.repositories_versions_update(repository_version_href, data)
2442
+ p result
2443
+ rescue Zest::ApiError => e
2444
+ puts "Exception when calling PulpApi->repositories_versions_update: #{e}"
2445
+ end
2446
+ ```
2447
+
2448
+ ### Parameters
2449
+
2450
+ Name | Type | Description | Notes
2451
+ ------------- | ------------- | ------------- | -------------
2452
+ **repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/1/versions/1/ |
2453
+ **data** | [**RepositoryVersion**](RepositoryVersion.md)| |
2454
+
2455
+ ### Return type
2456
+
2457
+ [**RepositoryVersion**](RepositoryVersion.md)
2458
+
2459
+ ### Authorization
2460
+
2461
+ [Basic](../README.md#Basic)
2462
+
2463
+ ### HTTP request headers
2464
+
2465
+ - **Content-Type**: application/json
2466
+ - **Accept**: application/json
2467
+
2468
+
2469
+
2470
+ # **status_list**
2471
+ > status_list
2472
+
2473
+
2474
+
2475
+ Returns app information including the version of pulpcore and loaded pulp plugins, known workers, database connection status, and messaging connection status
2476
+
2477
+ ### Example
2478
+ ```ruby
2479
+ # load the gem
2480
+ require 'zest'
2481
+ # setup authorization
2482
+ Zest.configure do |config|
2483
+ # Configure HTTP basic authorization: Basic
2484
+ config.username = 'YOUR USERNAME'
2485
+ config.password = 'YOUR PASSWORD'
2486
+ end
2487
+
2488
+ api_instance = Zest::PulpApi.new
2489
+
2490
+ begin
2491
+ api_instance.status_list
2492
+ rescue Zest::ApiError => e
2493
+ puts "Exception when calling PulpApi->status_list: #{e}"
2494
+ end
2495
+ ```
2496
+
2497
+ ### Parameters
2498
+ This endpoint does not need any parameter.
2499
+
2500
+ ### Return type
2501
+
2502
+ nil (empty response body)
2503
+
2504
+ ### Authorization
2505
+
2506
+ [Basic](../README.md#Basic)
2507
+
2508
+ ### HTTP request headers
2509
+
2510
+ - **Content-Type**: application/json
2511
+ - **Accept**: application/json
2512
+
2513
+
2514
+
2515
+ # **tasks_cancel**
2516
+ > Task tasks_cancel(task_href, data)
2517
+
2518
+
2519
+
2520
+
2521
+
2522
+ ### Example
2523
+ ```ruby
2524
+ # load the gem
2525
+ require 'zest'
2526
+ # setup authorization
2527
+ Zest.configure do |config|
2528
+ # Configure HTTP basic authorization: Basic
2529
+ config.username = 'YOUR USERNAME'
2530
+ config.password = 'YOUR PASSWORD'
2531
+ end
2532
+
2533
+ api_instance = Zest::PulpApi.new
2534
+
2535
+ task_href = "task_href_example" # String | URI of Task. e.g.: /pulp/api/v3/tasks/1/
2536
+
2537
+ data = Zest::Task.new # Task |
2538
+
2539
+
2540
+ begin
2541
+ result = api_instance.tasks_cancel(task_href, data)
2542
+ p result
2543
+ rescue Zest::ApiError => e
2544
+ puts "Exception when calling PulpApi->tasks_cancel: #{e}"
2545
+ end
2546
+ ```
2547
+
2548
+ ### Parameters
2549
+
2550
+ Name | Type | Description | Notes
2551
+ ------------- | ------------- | ------------- | -------------
2552
+ **task_href** | **String**| URI of Task. e.g.: /pulp/api/v3/tasks/1/ |
2553
+ **data** | [**Task**](Task.md)| |
2554
+
2555
+ ### Return type
2556
+
2557
+ [**Task**](Task.md)
2558
+
2559
+ ### Authorization
2560
+
2561
+ [Basic](../README.md#Basic)
2562
+
2563
+ ### HTTP request headers
2564
+
2565
+ - **Content-Type**: application/json
2566
+ - **Accept**: application/json
2567
+
2568
+
2569
+
2570
+ # **tasks_delete**
2571
+ > tasks_delete(task_href)
2572
+
2573
+
2574
+
2575
+
2576
+
2577
+ ### Example
2578
+ ```ruby
2579
+ # load the gem
2580
+ require 'zest'
2581
+ # setup authorization
2582
+ Zest.configure do |config|
2583
+ # Configure HTTP basic authorization: Basic
2584
+ config.username = 'YOUR USERNAME'
2585
+ config.password = 'YOUR PASSWORD'
2586
+ end
2587
+
2588
+ api_instance = Zest::PulpApi.new
2589
+
2590
+ task_href = "task_href_example" # String | URI of Task. e.g.: /pulp/api/v3/tasks/1/
2591
+
2592
+
2593
+ begin
2594
+ api_instance.tasks_delete(task_href)
2595
+ rescue Zest::ApiError => e
2596
+ puts "Exception when calling PulpApi->tasks_delete: #{e}"
2597
+ end
2598
+ ```
2599
+
2600
+ ### Parameters
2601
+
2602
+ Name | Type | Description | Notes
2603
+ ------------- | ------------- | ------------- | -------------
2604
+ **task_href** | **String**| URI of Task. e.g.: /pulp/api/v3/tasks/1/ |
2605
+
2606
+ ### Return type
2607
+
2608
+ nil (empty response body)
2609
+
2610
+ ### Authorization
2611
+
2612
+ [Basic](../README.md#Basic)
2613
+
2614
+ ### HTTP request headers
2615
+
2616
+ - **Content-Type**: application/json
2617
+ - **Accept**: application/json
2618
+
2619
+
2620
+
2621
+ # **tasks_list**
2622
+ > InlineResponse2008 tasks_list(opts)
2623
+
2624
+
2625
+
2626
+
2627
+
2628
+ ### Example
2629
+ ```ruby
2630
+ # load the gem
2631
+ require 'zest'
2632
+ # setup authorization
2633
+ Zest.configure do |config|
2634
+ # Configure HTTP basic authorization: Basic
2635
+ config.username = 'YOUR USERNAME'
2636
+ config.password = 'YOUR PASSWORD'
2637
+ end
2638
+
2639
+ api_instance = Zest::PulpApi.new
2640
+
2641
+ opts = {
2642
+ ordering: "ordering_example", # String | Which field to use when ordering the results.
2643
+ state: "state_example", # String |
2644
+ state__in: "state__in_example", # String | Filter results where state is in a comma-separated list of values
2645
+ worker: "worker_example", # String | Foreign Key referenced by HREF
2646
+ worker__in: "worker__in_example", # String | Filter results where worker is in a comma-separated list of values
2647
+ name__contains: "name__contains_example", # String | Filter results where name contains value
2648
+ started_at__lt: "started_at__lt_example", # String | Filter results where started_at is less than value
2649
+ started_at__lte: "started_at__lte_example", # String | Filter results where started_at is less than or equal to value
2650
+ started_at__gt: "started_at__gt_example", # String | Filter results where started_at is greater than value
2651
+ started_at__gte: "started_at__gte_example", # String | Filter results where started_at is greater than or equal to value
2652
+ started_at__range: "started_at__range_example", # String | Filter results where started_at is between two comma separated values
2653
+ finished_at__lt: "finished_at__lt_example", # String | Filter results where finished_at is less than value
2654
+ finished_at__lte: "finished_at__lte_example", # String | Filter results where finished_at is less than or equal to value
2655
+ finished_at__gt: "finished_at__gt_example", # String | Filter results where finished_at is greater than value
2656
+ finished_at__gte: "finished_at__gte_example", # String | Filter results where finished_at is greater than or equal to value
2657
+ finished_at__range: "finished_at__range_example", # String | Filter results where finished_at is between two comma separated values
2658
+ parent: "parent_example", # String | Foreign Key referenced by HREF
2659
+ name: "name_example", # String |
2660
+ started_at: "started_at_example", # String | ISO 8601 formatted dates are supported
2661
+ finished_at: "finished_at_example", # String | ISO 8601 formatted dates are supported
2662
+ page: 56, # Integer | A page number within the paginated result set.
2663
+ page_size: 56 # Integer | Number of results to return per page.
2664
+ }
2665
+
2666
+ begin
2667
+ result = api_instance.tasks_list(opts)
2668
+ p result
2669
+ rescue Zest::ApiError => e
2670
+ puts "Exception when calling PulpApi->tasks_list: #{e}"
2671
+ end
2672
+ ```
2673
+
2674
+ ### Parameters
2675
+
2676
+ Name | Type | Description | Notes
2677
+ ------------- | ------------- | ------------- | -------------
2678
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
2679
+ **state** | **String**| | [optional]
2680
+ **state__in** | **String**| Filter results where state is in a comma-separated list of values | [optional]
2681
+ **worker** | **String**| Foreign Key referenced by HREF | [optional]
2682
+ **worker__in** | **String**| Filter results where worker is in a comma-separated list of values | [optional]
2683
+ **name__contains** | **String**| Filter results where name contains value | [optional]
2684
+ **started_at__lt** | **String**| Filter results where started_at is less than value | [optional]
2685
+ **started_at__lte** | **String**| Filter results where started_at is less than or equal to value | [optional]
2686
+ **started_at__gt** | **String**| Filter results where started_at is greater than value | [optional]
2687
+ **started_at__gte** | **String**| Filter results where started_at is greater than or equal to value | [optional]
2688
+ **started_at__range** | **String**| Filter results where started_at is between two comma separated values | [optional]
2689
+ **finished_at__lt** | **String**| Filter results where finished_at is less than value | [optional]
2690
+ **finished_at__lte** | **String**| Filter results where finished_at is less than or equal to value | [optional]
2691
+ **finished_at__gt** | **String**| Filter results where finished_at is greater than value | [optional]
2692
+ **finished_at__gte** | **String**| Filter results where finished_at is greater than or equal to value | [optional]
2693
+ **finished_at__range** | **String**| Filter results where finished_at is between two comma separated values | [optional]
2694
+ **parent** | **String**| Foreign Key referenced by HREF | [optional]
2695
+ **name** | **String**| | [optional]
2696
+ **started_at** | **String**| ISO 8601 formatted dates are supported | [optional]
2697
+ **finished_at** | **String**| ISO 8601 formatted dates are supported | [optional]
2698
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
2699
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
2700
+
2701
+ ### Return type
2702
+
2703
+ [**InlineResponse2008**](InlineResponse2008.md)
2704
+
2705
+ ### Authorization
2706
+
2707
+ [Basic](../README.md#Basic)
2708
+
2709
+ ### HTTP request headers
2710
+
2711
+ - **Content-Type**: application/json
2712
+ - **Accept**: application/json
2713
+
2714
+
2715
+
2716
+ # **tasks_read**
2717
+ > Task tasks_read(task_href)
2718
+
2719
+
2720
+
2721
+
2722
+
2723
+ ### Example
2724
+ ```ruby
2725
+ # load the gem
2726
+ require 'zest'
2727
+ # setup authorization
2728
+ Zest.configure do |config|
2729
+ # Configure HTTP basic authorization: Basic
2730
+ config.username = 'YOUR USERNAME'
2731
+ config.password = 'YOUR PASSWORD'
2732
+ end
2733
+
2734
+ api_instance = Zest::PulpApi.new
2735
+
2736
+ task_href = "task_href_example" # String | URI of Task. e.g.: /pulp/api/v3/tasks/1/
2737
+
2738
+
2739
+ begin
2740
+ result = api_instance.tasks_read(task_href)
2741
+ p result
2742
+ rescue Zest::ApiError => e
2743
+ puts "Exception when calling PulpApi->tasks_read: #{e}"
2744
+ end
2745
+ ```
2746
+
2747
+ ### Parameters
2748
+
2749
+ Name | Type | Description | Notes
2750
+ ------------- | ------------- | ------------- | -------------
2751
+ **task_href** | **String**| URI of Task. e.g.: /pulp/api/v3/tasks/1/ |
2752
+
2753
+ ### Return type
2754
+
2755
+ [**Task**](Task.md)
2756
+
2757
+ ### Authorization
2758
+
2759
+ [Basic](../README.md#Basic)
2760
+
2761
+ ### HTTP request headers
2762
+
2763
+ - **Content-Type**: application/json
2764
+ - **Accept**: application/json
2765
+
2766
+
2767
+
2768
+ # **users_delete**
2769
+ > users_delete(user_href)
2770
+
2771
+
2772
+
2773
+
2774
+
2775
+ ### Example
2776
+ ```ruby
2777
+ # load the gem
2778
+ require 'zest'
2779
+ # setup authorization
2780
+ Zest.configure do |config|
2781
+ # Configure HTTP basic authorization: Basic
2782
+ config.username = 'YOUR USERNAME'
2783
+ config.password = 'YOUR PASSWORD'
2784
+ end
2785
+
2786
+ api_instance = Zest::PulpApi.new
2787
+
2788
+ user_href = "user_href_example" # String | URI of User. e.g.: /pulp/api/v3/users/1/
2789
+
2790
+
2791
+ begin
2792
+ api_instance.users_delete(user_href)
2793
+ rescue Zest::ApiError => e
2794
+ puts "Exception when calling PulpApi->users_delete: #{e}"
2795
+ end
2796
+ ```
2797
+
2798
+ ### Parameters
2799
+
2800
+ Name | Type | Description | Notes
2801
+ ------------- | ------------- | ------------- | -------------
2802
+ **user_href** | **String**| URI of User. e.g.: /pulp/api/v3/users/1/ |
2803
+
2804
+ ### Return type
2805
+
2806
+ nil (empty response body)
2807
+
2808
+ ### Authorization
2809
+
2810
+ [Basic](../README.md#Basic)
2811
+
2812
+ ### HTTP request headers
2813
+
2814
+ - **Content-Type**: application/json
2815
+ - **Accept**: application/json
2816
+
2817
+
2818
+
2819
+ # **users_list**
2820
+ > InlineResponse2009 users_list(opts)
2821
+
2822
+
2823
+
2824
+
2825
+
2826
+ ### Example
2827
+ ```ruby
2828
+ # load the gem
2829
+ require 'zest'
2830
+ # setup authorization
2831
+ Zest.configure do |config|
2832
+ # Configure HTTP basic authorization: Basic
2833
+ config.username = 'YOUR USERNAME'
2834
+ config.password = 'YOUR PASSWORD'
2835
+ end
2836
+
2837
+ api_instance = Zest::PulpApi.new
2838
+
2839
+ opts = {
2840
+ username: "username_example", # String |
2841
+ username__in: "username__in_example", # String | Filter results where username is in a comma-separated list of values
2842
+ page: 56, # Integer | A page number within the paginated result set.
2843
+ page_size: 56 # Integer | Number of results to return per page.
2844
+ }
2845
+
2846
+ begin
2847
+ result = api_instance.users_list(opts)
2848
+ p result
2849
+ rescue Zest::ApiError => e
2850
+ puts "Exception when calling PulpApi->users_list: #{e}"
2851
+ end
2852
+ ```
2853
+
2854
+ ### Parameters
2855
+
2856
+ Name | Type | Description | Notes
2857
+ ------------- | ------------- | ------------- | -------------
2858
+ **username** | **String**| | [optional]
2859
+ **username__in** | **String**| Filter results where username is in a comma-separated list of values | [optional]
2860
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
2861
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
2862
+
2863
+ ### Return type
2864
+
2865
+ [**InlineResponse2009**](InlineResponse2009.md)
2866
+
2867
+ ### Authorization
2868
+
2869
+ [Basic](../README.md#Basic)
2870
+
2871
+ ### HTTP request headers
2872
+
2873
+ - **Content-Type**: application/json
2874
+ - **Accept**: application/json
2875
+
2876
+
2877
+
2878
+ # **users_read**
2879
+ > User users_read(user_href)
2880
+
2881
+
2882
+
2883
+
2884
+
2885
+ ### Example
2886
+ ```ruby
2887
+ # load the gem
2888
+ require 'zest'
2889
+ # setup authorization
2890
+ Zest.configure do |config|
2891
+ # Configure HTTP basic authorization: Basic
2892
+ config.username = 'YOUR USERNAME'
2893
+ config.password = 'YOUR PASSWORD'
2894
+ end
2895
+
2896
+ api_instance = Zest::PulpApi.new
2897
+
2898
+ user_href = "user_href_example" # String | URI of User. e.g.: /pulp/api/v3/users/1/
2899
+
2900
+
2901
+ begin
2902
+ result = api_instance.users_read(user_href)
2903
+ p result
2904
+ rescue Zest::ApiError => e
2905
+ puts "Exception when calling PulpApi->users_read: #{e}"
2906
+ end
2907
+ ```
2908
+
2909
+ ### Parameters
2910
+
2911
+ Name | Type | Description | Notes
2912
+ ------------- | ------------- | ------------- | -------------
2913
+ **user_href** | **String**| URI of User. e.g.: /pulp/api/v3/users/1/ |
2914
+
2915
+ ### Return type
2916
+
2917
+ [**User**](User.md)
2918
+
2919
+ ### Authorization
2920
+
2921
+ [Basic](../README.md#Basic)
2922
+
2923
+ ### HTTP request headers
2924
+
2925
+ - **Content-Type**: application/json
2926
+ - **Accept**: application/json
2927
+
2928
+
2929
+
2930
+ # **workers_list**
2931
+ > InlineResponse20010 workers_list(opts)
2932
+
2933
+
2934
+
2935
+
2936
+
2937
+ ### Example
2938
+ ```ruby
2939
+ # load the gem
2940
+ require 'zest'
2941
+ # setup authorization
2942
+ Zest.configure do |config|
2943
+ # Configure HTTP basic authorization: Basic
2944
+ config.username = 'YOUR USERNAME'
2945
+ config.password = 'YOUR PASSWORD'
2946
+ end
2947
+
2948
+ api_instance = Zest::PulpApi.new
2949
+
2950
+ opts = {
2951
+ name: "name_example", # String |
2952
+ name__in: "name__in_example", # String | Filter results where name is in a comma-separated list of values
2953
+ last_heartbeat__lt: "last_heartbeat__lt_example", # String | Filter results where last_heartbeat is less than value
2954
+ last_heartbeat__lte: "last_heartbeat__lte_example", # String | Filter results where last_heartbeat is less than or equal to value
2955
+ last_heartbeat__gt: "last_heartbeat__gt_example", # String | Filter results where last_heartbeat is greater than value
2956
+ last_heartbeat__gte: "last_heartbeat__gte_example", # String | Filter results where last_heartbeat is greater than or equal to value
2957
+ last_heartbeat__range: "last_heartbeat__range_example", # String | Filter results where last_heartbeat is between two comma separated values
2958
+ online: "online_example", # String |
2959
+ missing: "missing_example", # String |
2960
+ last_heartbeat: "last_heartbeat_example", # String | ISO 8601 formatted dates are supported
2961
+ page: 56, # Integer | A page number within the paginated result set.
2962
+ page_size: 56 # Integer | Number of results to return per page.
2963
+ }
2964
+
2965
+ begin
2966
+ result = api_instance.workers_list(opts)
2967
+ p result
2968
+ rescue Zest::ApiError => e
2969
+ puts "Exception when calling PulpApi->workers_list: #{e}"
2970
+ end
2971
+ ```
2972
+
2973
+ ### Parameters
2974
+
2975
+ Name | Type | Description | Notes
2976
+ ------------- | ------------- | ------------- | -------------
2977
+ **name** | **String**| | [optional]
2978
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
2979
+ **last_heartbeat__lt** | **String**| Filter results where last_heartbeat is less than value | [optional]
2980
+ **last_heartbeat__lte** | **String**| Filter results where last_heartbeat is less than or equal to value | [optional]
2981
+ **last_heartbeat__gt** | **String**| Filter results where last_heartbeat is greater than value | [optional]
2982
+ **last_heartbeat__gte** | **String**| Filter results where last_heartbeat is greater than or equal to value | [optional]
2983
+ **last_heartbeat__range** | **String**| Filter results where last_heartbeat is between two comma separated values | [optional]
2984
+ **online** | **String**| | [optional]
2985
+ **missing** | **String**| | [optional]
2986
+ **last_heartbeat** | **String**| ISO 8601 formatted dates are supported | [optional]
2987
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
2988
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
2989
+
2990
+ ### Return type
2991
+
2992
+ [**InlineResponse20010**](InlineResponse20010.md)
2993
+
2994
+ ### Authorization
2995
+
2996
+ [Basic](../README.md#Basic)
2997
+
2998
+ ### HTTP request headers
2999
+
3000
+ - **Content-Type**: application/json
3001
+ - **Accept**: application/json
3002
+
3003
+
3004
+
3005
+ # **workers_read**
3006
+ > Worker workers_read(worker_href)
3007
+
3008
+
3009
+
3010
+
3011
+
3012
+ ### Example
3013
+ ```ruby
3014
+ # load the gem
3015
+ require 'zest'
3016
+ # setup authorization
3017
+ Zest.configure do |config|
3018
+ # Configure HTTP basic authorization: Basic
3019
+ config.username = 'YOUR USERNAME'
3020
+ config.password = 'YOUR PASSWORD'
3021
+ end
3022
+
3023
+ api_instance = Zest::PulpApi.new
3024
+
3025
+ worker_href = "worker_href_example" # String | URI of Worker. e.g.: /pulp/api/v3/workers/1/
3026
+
3027
+
3028
+ begin
3029
+ result = api_instance.workers_read(worker_href)
3030
+ p result
3031
+ rescue Zest::ApiError => e
3032
+ puts "Exception when calling PulpApi->workers_read: #{e}"
3033
+ end
3034
+ ```
3035
+
3036
+ ### Parameters
3037
+
3038
+ Name | Type | Description | Notes
3039
+ ------------- | ------------- | ------------- | -------------
3040
+ **worker_href** | **String**| URI of Worker. e.g.: /pulp/api/v3/workers/1/ |
3041
+
3042
+ ### Return type
3043
+
3044
+ [**Worker**](Worker.md)
3045
+
3046
+ ### Authorization
3047
+
3048
+ [Basic](../README.md#Basic)
3049
+
3050
+ ### HTTP request headers
3051
+
3052
+ - **Content-Type**: application/json
3053
+ - **Accept**: application/json
3054
+
3055
+
3056
+