pulp_file_client 3.69.2 → 3.70.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (154) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -7
  3. data/docs/AcsFileApi.md +343 -157
  4. data/docs/AsyncOperationResponse.md +8 -7
  5. data/docs/ContentFilesApi.md +114 -64
  6. data/docs/ContentSummaryResponse.md +12 -11
  7. data/docs/DistributionsFileApi.md +385 -182
  8. data/docs/FileFileAlternateContentSource.md +14 -13
  9. data/docs/FileFileAlternateContentSourceResponse.md +22 -21
  10. data/docs/FileFileContentResponse.md +30 -29
  11. data/docs/FileFileDistribution.md +20 -19
  12. data/docs/FileFileDistributionResponse.md +32 -31
  13. data/docs/FileFilePublication.md +12 -11
  14. data/docs/FileFilePublicationResponse.md +22 -21
  15. data/docs/FileFileRemote.md +48 -47
  16. data/docs/FileFileRemoteResponse.md +48 -47
  17. data/docs/FileFileRemoteResponseHiddenFieldsInner.md +20 -0
  18. data/docs/FileFileRepository.md +20 -19
  19. data/docs/FileFileRepositoryResponse.md +32 -31
  20. data/docs/MyPermissionsResponse.md +8 -7
  21. data/docs/NestedRole.md +12 -11
  22. data/docs/NestedRoleResponse.md +12 -11
  23. data/docs/ObjectRolesResponse.md +8 -7
  24. data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
  25. data/docs/PaginatedfileFileAlternateContentSourceResponseList.md +14 -13
  26. data/docs/PaginatedfileFileContentResponseList.md +14 -13
  27. data/docs/PaginatedfileFileDistributionResponseList.md +14 -13
  28. data/docs/PaginatedfileFilePublicationResponseList.md +14 -13
  29. data/docs/PaginatedfileFileRemoteResponseList.md +14 -13
  30. data/docs/PaginatedfileFileRepositoryResponseList.md +14 -13
  31. data/docs/PatchedfileFileAlternateContentSource.md +14 -13
  32. data/docs/PatchedfileFileDistribution.md +20 -19
  33. data/docs/PatchedfileFileRemote.md +48 -47
  34. data/docs/PatchedfileFileRepository.md +20 -19
  35. data/docs/PolicyEnum.md +4 -5
  36. data/docs/PublicationsFileApi.md +267 -130
  37. data/docs/RemotesFileApi.md +389 -184
  38. data/docs/Repair.md +8 -7
  39. data/docs/RepositoriesFileApi.md +444 -207
  40. data/docs/RepositoriesFileVersionsApi.md +152 -82
  41. data/docs/RepositoryAddRemoveContent.md +12 -11
  42. data/docs/RepositorySyncURL.md +10 -9
  43. data/docs/RepositoryVersionResponse.md +22 -21
  44. data/docs/SetLabel.md +10 -9
  45. data/docs/SetLabelResponse.md +10 -9
  46. data/docs/TaskGroupOperationResponse.md +8 -7
  47. data/docs/UnsetLabel.md +8 -7
  48. data/docs/UnsetLabelResponse.md +10 -9
  49. data/lib/pulp_file_client/api/acs_file_api.rb +76 -50
  50. data/lib/pulp_file_client/api/content_files_api.rb +20 -14
  51. data/lib/pulp_file_client/api/distributions_file_api.rb +89 -56
  52. data/lib/pulp_file_client/api/publications_file_api.rb +67 -47
  53. data/lib/pulp_file_client/api/remotes_file_api.rb +104 -68
  54. data/lib/pulp_file_client/api/repositories_file_api.rb +107 -66
  55. data/lib/pulp_file_client/api/repositories_file_versions_api.rb +40 -30
  56. data/lib/pulp_file_client/api_client.rb +137 -102
  57. data/lib/pulp_file_client/api_error.rb +2 -1
  58. data/lib/pulp_file_client/configuration.rb +162 -21
  59. data/lib/pulp_file_client/models/async_operation_response.rb +32 -22
  60. data/lib/pulp_file_client/models/content_summary_response.rb +36 -22
  61. data/lib/pulp_file_client/models/file_file_alternate_content_source.rb +35 -23
  62. data/lib/pulp_file_client/models/file_file_alternate_content_source_response.rb +37 -25
  63. data/lib/pulp_file_client/models/file_file_content_response.rb +34 -24
  64. data/lib/pulp_file_client/models/file_file_distribution.rb +34 -22
  65. data/lib/pulp_file_client/models/file_file_distribution_response.rb +36 -24
  66. data/lib/pulp_file_client/models/file_file_publication.rb +30 -22
  67. data/lib/pulp_file_client/models/file_file_publication_response.rb +32 -24
  68. data/lib/pulp_file_client/models/file_file_remote.rb +56 -22
  69. data/lib/pulp_file_client/models/file_file_remote_response.rb +59 -25
  70. data/lib/pulp_file_client/models/{file_file_remote_response_hidden_fields.rb → file_file_remote_response_hidden_fields_inner.rb} +37 -25
  71. data/lib/pulp_file_client/models/file_file_repository.rb +32 -22
  72. data/lib/pulp_file_client/models/file_file_repository_response.rb +34 -24
  73. data/lib/pulp_file_client/models/my_permissions_response.rb +32 -22
  74. data/lib/pulp_file_client/models/nested_role.rb +32 -22
  75. data/lib/pulp_file_client/models/nested_role_response.rb +32 -22
  76. data/lib/pulp_file_client/models/object_roles_response.rb +32 -22
  77. data/lib/pulp_file_client/models/paginated_repository_version_response_list.rb +34 -22
  78. data/lib/pulp_file_client/models/paginatedfile_file_alternate_content_source_response_list.rb +34 -22
  79. data/lib/pulp_file_client/models/paginatedfile_file_content_response_list.rb +34 -22
  80. data/lib/pulp_file_client/models/paginatedfile_file_distribution_response_list.rb +34 -22
  81. data/lib/pulp_file_client/models/paginatedfile_file_publication_response_list.rb +34 -22
  82. data/lib/pulp_file_client/models/paginatedfile_file_remote_response_list.rb +34 -22
  83. data/lib/pulp_file_client/models/paginatedfile_file_repository_response_list.rb +34 -22
  84. data/lib/pulp_file_client/models/patchedfile_file_alternate_content_source.rb +36 -24
  85. data/lib/pulp_file_client/models/patchedfile_file_distribution.rb +40 -24
  86. data/lib/pulp_file_client/models/patchedfile_file_remote.rb +62 -24
  87. data/lib/pulp_file_client/models/patchedfile_file_repository.rb +35 -23
  88. data/lib/pulp_file_client/models/policy_enum.rb +8 -4
  89. data/lib/pulp_file_client/models/repair.rb +30 -22
  90. data/lib/pulp_file_client/models/repository_add_remove_content.rb +30 -22
  91. data/lib/pulp_file_client/models/repository_sync_url.rb +30 -22
  92. data/lib/pulp_file_client/models/repository_version_response.rb +32 -24
  93. data/lib/pulp_file_client/models/set_label.rb +34 -22
  94. data/lib/pulp_file_client/models/set_label_response.rb +34 -22
  95. data/lib/pulp_file_client/models/task_group_operation_response.rb +32 -22
  96. data/lib/pulp_file_client/models/unset_label.rb +32 -22
  97. data/lib/pulp_file_client/models/unset_label_response.rb +32 -22
  98. data/lib/pulp_file_client/version.rb +2 -2
  99. data/lib/pulp_file_client.rb +2 -3
  100. data/pulp_file_client.gemspec +9 -6
  101. data/spec/api/acs_file_api_spec.rb +12 -12
  102. data/spec/api/content_files_api_spec.rb +4 -4
  103. data/spec/api/distributions_file_api_spec.rb +13 -13
  104. data/spec/api/publications_file_api_spec.rb +16 -15
  105. data/spec/api/remotes_file_api_spec.rb +20 -19
  106. data/spec/api/repositories_file_api_spec.rb +15 -15
  107. data/spec/api/repositories_file_versions_api_spec.rb +12 -11
  108. data/spec/models/async_operation_response_spec.rb +7 -12
  109. data/spec/models/content_summary_response_spec.rb +9 -14
  110. data/spec/models/file_file_alternate_content_source_response_spec.rb +14 -19
  111. data/spec/models/file_file_alternate_content_source_spec.rb +10 -15
  112. data/spec/models/file_file_content_response_spec.rb +18 -23
  113. data/spec/models/file_file_distribution_response_spec.rb +19 -24
  114. data/spec/models/file_file_distribution_spec.rb +13 -18
  115. data/spec/models/file_file_publication_response_spec.rb +14 -19
  116. data/spec/models/file_file_publication_spec.rb +9 -14
  117. data/spec/models/{file_file_remote_response_hidden_fields_spec.rb → file_file_remote_response_hidden_fields_inner_spec.rb} +11 -16
  118. data/spec/models/file_file_remote_response_spec.rb +27 -32
  119. data/spec/models/file_file_remote_spec.rb +27 -32
  120. data/spec/models/file_file_repository_response_spec.rb +19 -24
  121. data/spec/models/file_file_repository_spec.rb +13 -18
  122. data/spec/models/my_permissions_response_spec.rb +7 -12
  123. data/spec/models/nested_role_response_spec.rb +9 -14
  124. data/spec/models/nested_role_spec.rb +9 -14
  125. data/spec/models/object_roles_response_spec.rb +7 -12
  126. data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
  127. data/spec/models/paginatedfile_file_alternate_content_source_response_list_spec.rb +10 -15
  128. data/spec/models/paginatedfile_file_content_response_list_spec.rb +10 -15
  129. data/spec/models/paginatedfile_file_distribution_response_list_spec.rb +10 -15
  130. data/spec/models/paginatedfile_file_publication_response_list_spec.rb +10 -15
  131. data/spec/models/paginatedfile_file_remote_response_list_spec.rb +10 -15
  132. data/spec/models/paginatedfile_file_repository_response_list_spec.rb +10 -15
  133. data/spec/models/patchedfile_file_alternate_content_source_spec.rb +10 -15
  134. data/spec/models/patchedfile_file_distribution_spec.rb +13 -18
  135. data/spec/models/patchedfile_file_remote_spec.rb +27 -32
  136. data/spec/models/patchedfile_file_repository_spec.rb +13 -18
  137. data/spec/models/policy_enum_spec.rb +6 -11
  138. data/spec/models/repair_spec.rb +7 -12
  139. data/spec/models/repository_add_remove_content_spec.rb +9 -14
  140. data/spec/models/repository_sync_url_spec.rb +8 -13
  141. data/spec/models/repository_version_response_spec.rb +14 -19
  142. data/spec/models/set_label_response_spec.rb +8 -13
  143. data/spec/models/set_label_spec.rb +8 -13
  144. data/spec/models/task_group_operation_response_spec.rb +7 -12
  145. data/spec/models/unset_label_response_spec.rb +8 -13
  146. data/spec/models/unset_label_spec.rb +7 -12
  147. data/spec/spec_helper.rb +1 -1
  148. metadata +45 -25
  149. data/docs/FileFileContent.md +0 -27
  150. data/docs/FileFileRemoteResponseHiddenFields.md +0 -19
  151. data/lib/pulp_file_client/models/file_file_content.rb +0 -297
  152. data/spec/api_client_spec.rb +0 -188
  153. data/spec/configuration_spec.rb +0 -42
  154. data/spec/models/file_file_content_spec.rb +0 -71
@@ -2,35 +2,34 @@
2
2
 
3
3
  All URIs are relative to *http://localhost:24817*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**add_role**](RemotesFileApi.md#add_role) | **POST** {file_file_remote_href}add_role/ | Add a role
8
- [**create**](RemotesFileApi.md#create) | **POST** /pulp/api/v3/remotes/file/file/ | Create a file remote
9
- [**delete**](RemotesFileApi.md#delete) | **DELETE** {file_file_remote_href} | Delete a file remote
10
- [**list**](RemotesFileApi.md#list) | **GET** /pulp/api/v3/remotes/file/file/ | List file remotes
11
- [**list_roles**](RemotesFileApi.md#list_roles) | **GET** {file_file_remote_href}list_roles/ | List roles
12
- [**my_permissions**](RemotesFileApi.md#my_permissions) | **GET** {file_file_remote_href}my_permissions/ | List user permissions
13
- [**partial_update**](RemotesFileApi.md#partial_update) | **PATCH** {file_file_remote_href} | Update a file remote
14
- [**read**](RemotesFileApi.md#read) | **GET** {file_file_remote_href} | Inspect a file remote
15
- [**remove_role**](RemotesFileApi.md#remove_role) | **POST** {file_file_remote_href}remove_role/ | Remove a role
16
- [**set_label**](RemotesFileApi.md#set_label) | **POST** {file_file_remote_href}set_label/ | Set a label
17
- [**unset_label**](RemotesFileApi.md#unset_label) | **POST** {file_file_remote_href}unset_label/ | Unset a label
18
- [**update**](RemotesFileApi.md#update) | **PUT** {file_file_remote_href} | Update a file remote
19
-
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**add_role**](RemotesFileApi.md#add_role) | **POST** {file_file_remote_href}add_role/ | Add a role |
8
+ | [**create**](RemotesFileApi.md#create) | **POST** /pulp/api/v3/remotes/file/file/ | Create a file remote |
9
+ | [**delete**](RemotesFileApi.md#delete) | **DELETE** {file_file_remote_href} | Delete a file remote |
10
+ | [**list**](RemotesFileApi.md#list) | **GET** /pulp/api/v3/remotes/file/file/ | List file remotes |
11
+ | [**list_roles**](RemotesFileApi.md#list_roles) | **GET** {file_file_remote_href}list_roles/ | List roles |
12
+ | [**my_permissions**](RemotesFileApi.md#my_permissions) | **GET** {file_file_remote_href}my_permissions/ | List user permissions |
13
+ | [**partial_update**](RemotesFileApi.md#partial_update) | **PATCH** {file_file_remote_href} | Update a file remote |
14
+ | [**read**](RemotesFileApi.md#read) | **GET** {file_file_remote_href} | Inspect a file remote |
15
+ | [**remove_role**](RemotesFileApi.md#remove_role) | **POST** {file_file_remote_href}remove_role/ | Remove a role |
16
+ | [**set_label**](RemotesFileApi.md#set_label) | **POST** {file_file_remote_href}set_label/ | Set a label |
17
+ | [**unset_label**](RemotesFileApi.md#unset_label) | **POST** {file_file_remote_href}unset_label/ | Unset a label |
18
+ | [**update**](RemotesFileApi.md#update) | **PUT** {file_file_remote_href} | Update a file remote |
20
19
 
21
20
 
22
21
  ## add_role
23
22
 
24
- > NestedRoleResponse add_role(file_file_remote_href, nested_role)
23
+ > <NestedRoleResponse> add_role(file_file_remote_href, nested_role)
25
24
 
26
25
  Add a role
27
26
 
28
27
  Add a role for this object to users/groups.
29
28
 
30
- ### Example
29
+ ### Examples
31
30
 
32
31
  ```ruby
33
- # load the gem
32
+ require 'time'
34
33
  require 'pulp_file_client'
35
34
  # setup authorization
36
35
  PulpFileClient.configure do |config|
@@ -41,24 +40,41 @@ end
41
40
 
42
41
  api_instance = PulpFileClient::RemotesFileApi.new
43
42
  file_file_remote_href = 'file_file_remote_href_example' # String |
44
- nested_role = PulpFileClient::NestedRole.new # NestedRole |
43
+ nested_role = PulpFileClient::NestedRole.new({role: 'role_example'}) # NestedRole |
45
44
 
46
45
  begin
47
- #Add a role
46
+ # Add a role
48
47
  result = api_instance.add_role(file_file_remote_href, nested_role)
49
48
  p result
50
49
  rescue PulpFileClient::ApiError => e
51
- puts "Exception when calling RemotesFileApi->add_role: #{e}"
50
+ puts "Error when calling RemotesFileApi->add_role: #{e}"
52
51
  end
53
52
  ```
54
53
 
55
- ### Parameters
54
+ #### Using the add_role_with_http_info variant
55
+
56
+ This returns an Array which contains the response data, status code and headers.
57
+
58
+ > <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(file_file_remote_href, nested_role)
59
+
60
+ ```ruby
61
+ begin
62
+ # Add a role
63
+ data, status_code, headers = api_instance.add_role_with_http_info(file_file_remote_href, nested_role)
64
+ p status_code # => 2xx
65
+ p headers # => { ... }
66
+ p data # => <NestedRoleResponse>
67
+ rescue PulpFileClient::ApiError => e
68
+ puts "Error when calling RemotesFileApi->add_role_with_http_info: #{e}"
69
+ end
70
+ ```
56
71
 
72
+ ### Parameters
57
73
 
58
- Name | Type | Description | Notes
59
- ------------- | ------------- | ------------- | -------------
60
- **file_file_remote_href** | **String**| |
61
- **nested_role** | [**NestedRole**](NestedRole.md)| |
74
+ | Name | Type | Description | Notes |
75
+ | ---- | ---- | ----------- | ----- |
76
+ | **file_file_remote_href** | **String** | | |
77
+ | **nested_role** | [**NestedRole**](NestedRole.md) | | |
62
78
 
63
79
  ### Return type
64
80
 
@@ -76,16 +92,16 @@ Name | Type | Description | Notes
76
92
 
77
93
  ## create
78
94
 
79
- > FileFileRemoteResponse create(file_file_remote)
95
+ > <FileFileRemoteResponse> create(file_file_remote)
80
96
 
81
97
  Create a file remote
82
98
 
83
99
  FileRemote represents an external source of File Content. The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.
84
100
 
85
- ### Example
101
+ ### Examples
86
102
 
87
103
  ```ruby
88
- # load the gem
104
+ require 'time'
89
105
  require 'pulp_file_client'
90
106
  # setup authorization
91
107
  PulpFileClient.configure do |config|
@@ -95,23 +111,40 @@ PulpFileClient.configure do |config|
95
111
  end
96
112
 
97
113
  api_instance = PulpFileClient::RemotesFileApi.new
98
- file_file_remote = PulpFileClient::FileFileRemote.new # FileFileRemote |
114
+ file_file_remote = PulpFileClient::FileFileRemote.new({name: 'name_example', url: 'url_example'}) # FileFileRemote |
99
115
 
100
116
  begin
101
- #Create a file remote
117
+ # Create a file remote
102
118
  result = api_instance.create(file_file_remote)
103
119
  p result
104
120
  rescue PulpFileClient::ApiError => e
105
- puts "Exception when calling RemotesFileApi->create: #{e}"
121
+ puts "Error when calling RemotesFileApi->create: #{e}"
106
122
  end
107
123
  ```
108
124
 
109
- ### Parameters
125
+ #### Using the create_with_http_info variant
110
126
 
127
+ This returns an Array which contains the response data, status code and headers.
111
128
 
112
- Name | Type | Description | Notes
113
- ------------- | ------------- | ------------- | -------------
114
- **file_file_remote** | [**FileFileRemote**](FileFileRemote.md)| |
129
+ > <Array(<FileFileRemoteResponse>, Integer, Hash)> create_with_http_info(file_file_remote)
130
+
131
+ ```ruby
132
+ begin
133
+ # Create a file remote
134
+ data, status_code, headers = api_instance.create_with_http_info(file_file_remote)
135
+ p status_code # => 2xx
136
+ p headers # => { ... }
137
+ p data # => <FileFileRemoteResponse>
138
+ rescue PulpFileClient::ApiError => e
139
+ puts "Error when calling RemotesFileApi->create_with_http_info: #{e}"
140
+ end
141
+ ```
142
+
143
+ ### Parameters
144
+
145
+ | Name | Type | Description | Notes |
146
+ | ---- | ---- | ----------- | ----- |
147
+ | **file_file_remote** | [**FileFileRemote**](FileFileRemote.md) | | |
115
148
 
116
149
  ### Return type
117
150
 
@@ -129,16 +162,16 @@ Name | Type | Description | Notes
129
162
 
130
163
  ## delete
131
164
 
132
- > AsyncOperationResponse delete(file_file_remote_href)
165
+ > <AsyncOperationResponse> delete(file_file_remote_href)
133
166
 
134
167
  Delete a file remote
135
168
 
136
169
  Trigger an asynchronous delete task
137
170
 
138
- ### Example
171
+ ### Examples
139
172
 
140
173
  ```ruby
141
- # load the gem
174
+ require 'time'
142
175
  require 'pulp_file_client'
143
176
  # setup authorization
144
177
  PulpFileClient.configure do |config|
@@ -151,20 +184,37 @@ api_instance = PulpFileClient::RemotesFileApi.new
151
184
  file_file_remote_href = 'file_file_remote_href_example' # String |
152
185
 
153
186
  begin
154
- #Delete a file remote
187
+ # Delete a file remote
155
188
  result = api_instance.delete(file_file_remote_href)
156
189
  p result
157
190
  rescue PulpFileClient::ApiError => e
158
- puts "Exception when calling RemotesFileApi->delete: #{e}"
191
+ puts "Error when calling RemotesFileApi->delete: #{e}"
159
192
  end
160
193
  ```
161
194
 
162
- ### Parameters
195
+ #### Using the delete_with_http_info variant
196
+
197
+ This returns an Array which contains the response data, status code and headers.
198
+
199
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(file_file_remote_href)
163
200
 
201
+ ```ruby
202
+ begin
203
+ # Delete a file remote
204
+ data, status_code, headers = api_instance.delete_with_http_info(file_file_remote_href)
205
+ p status_code # => 2xx
206
+ p headers # => { ... }
207
+ p data # => <AsyncOperationResponse>
208
+ rescue PulpFileClient::ApiError => e
209
+ puts "Error when calling RemotesFileApi->delete_with_http_info: #{e}"
210
+ end
211
+ ```
212
+
213
+ ### Parameters
164
214
 
165
- Name | Type | Description | Notes
166
- ------------- | ------------- | ------------- | -------------
167
- **file_file_remote_href** | **String**| |
215
+ | Name | Type | Description | Notes |
216
+ | ---- | ---- | ----------- | ----- |
217
+ | **file_file_remote_href** | **String** | | |
168
218
 
169
219
  ### Return type
170
220
 
@@ -182,16 +232,16 @@ Name | Type | Description | Notes
182
232
 
183
233
  ## list
184
234
 
185
- > PaginatedfileFileRemoteResponseList list(opts)
235
+ > <PaginatedfileFileRemoteResponseList> list(opts)
186
236
 
187
237
  List file remotes
188
238
 
189
239
  FileRemote represents an external source of File Content. The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.
190
240
 
191
- ### Example
241
+ ### Examples
192
242
 
193
243
  ```ruby
194
- # load the gem
244
+ require 'time'
195
245
  require 'pulp_file_client'
196
246
  # setup authorization
197
247
  PulpFileClient.configure do |config|
@@ -207,67 +257,86 @@ opts = {
207
257
  name__contains: 'name__contains_example', # String | Filter results where name contains value
208
258
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
209
259
  name__iexact: 'name__iexact_example', # String | Filter results where name matches value
210
- name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
260
+ name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
211
261
  name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
212
262
  name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
213
263
  name__regex: 'name__regex_example', # String | Filter results where name matches regex value
214
264
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
215
265
  offset: 56, # Integer | The initial index from which to return the results.
216
- ordering: ['ordering_example'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending)
217
- prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
218
- pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
219
- pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
266
+ ordering: ['-ca_cert'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending)
267
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
268
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
269
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
220
270
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
221
- pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated matches value
222
- pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
223
- pulp_last_updated__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than or equal to value
224
- pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
225
- pulp_last_updated__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than or equal to value
226
- pulp_last_updated__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_last_updated is between two comma separated values
271
+ pulp_last_updated: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated matches value
272
+ pulp_last_updated__gt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is greater than value
273
+ pulp_last_updated__gte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is greater than or equal to value
274
+ pulp_last_updated__isnull: true, # Boolean | Filter results where pulp_last_updated has a null value
275
+ pulp_last_updated__lt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is less than value
276
+ pulp_last_updated__lte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is less than or equal to value
277
+ pulp_last_updated__range: [Time.now], # Array<Time> | Filter results where pulp_last_updated is between two comma separated values
227
278
  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
228
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
229
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
279
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
280
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
230
281
  }
231
282
 
232
283
  begin
233
- #List file remotes
284
+ # List file remotes
234
285
  result = api_instance.list(opts)
235
286
  p result
236
287
  rescue PulpFileClient::ApiError => e
237
- puts "Exception when calling RemotesFileApi->list: #{e}"
288
+ puts "Error when calling RemotesFileApi->list: #{e}"
238
289
  end
239
290
  ```
240
291
 
241
- ### Parameters
292
+ #### Using the list_with_http_info variant
293
+
294
+ This returns an Array which contains the response data, status code and headers.
242
295
 
296
+ > <Array(<PaginatedfileFileRemoteResponseList>, Integer, Hash)> list_with_http_info(opts)
243
297
 
244
- Name | Type | Description | Notes
245
- ------------- | ------------- | ------------- | -------------
246
- **limit** | **Integer**| Number of results to return per page. | [optional]
247
- **name** | **String**| Filter results where name matches value | [optional]
248
- **name__contains** | **String**| Filter results where name contains value | [optional]
249
- **name__icontains** | **String**| Filter results where name contains value | [optional]
250
- **name__iexact** | **String**| Filter results where name matches value | [optional]
251
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
252
- **name__iregex** | **String**| Filter results where name matches regex value | [optional]
253
- **name__istartswith** | **String**| Filter results where name starts with value | [optional]
254
- **name__regex** | **String**| Filter results where name matches regex value | [optional]
255
- **name__startswith** | **String**| Filter results where name starts with value | [optional]
256
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
257
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional]
258
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
259
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
260
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
261
- **pulp_label_select** | **String**| Filter labels by search string | [optional]
262
- **pulp_last_updated** | **DateTime**| Filter results where pulp_last_updated matches value | [optional]
263
- **pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional]
264
- **pulp_last_updated__gte** | **DateTime**| Filter results where pulp_last_updated is greater than or equal to value | [optional]
265
- **pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional]
266
- **pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional]
267
- **pulp_last_updated__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional]
268
- **q** | **String**| Filter results by using NOT, AND and OR operations on other filters | [optional]
269
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
270
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
298
+ ```ruby
299
+ begin
300
+ # List file remotes
301
+ data, status_code, headers = api_instance.list_with_http_info(opts)
302
+ p status_code # => 2xx
303
+ p headers # => { ... }
304
+ p data # => <PaginatedfileFileRemoteResponseList>
305
+ rescue PulpFileClient::ApiError => e
306
+ puts "Error when calling RemotesFileApi->list_with_http_info: #{e}"
307
+ end
308
+ ```
309
+
310
+ ### Parameters
311
+
312
+ | Name | Type | Description | Notes |
313
+ | ---- | ---- | ----------- | ----- |
314
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
315
+ | **name** | **String** | Filter results where name matches value | [optional] |
316
+ | **name__contains** | **String** | Filter results where name contains value | [optional] |
317
+ | **name__icontains** | **String** | Filter results where name contains value | [optional] |
318
+ | **name__iexact** | **String** | Filter results where name matches value | [optional] |
319
+ | **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
320
+ | **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
321
+ | **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
322
+ | **name__regex** | **String** | Filter results where name matches regex value | [optional] |
323
+ | **name__startswith** | **String** | Filter results where name starts with value | [optional] |
324
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
325
+ | **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
326
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
327
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
328
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
329
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
330
+ | **pulp_last_updated** | **Time** | Filter results where pulp_last_updated matches value | [optional] |
331
+ | **pulp_last_updated__gt** | **Time** | Filter results where pulp_last_updated is greater than value | [optional] |
332
+ | **pulp_last_updated__gte** | **Time** | Filter results where pulp_last_updated is greater than or equal to value | [optional] |
333
+ | **pulp_last_updated__isnull** | **Boolean** | Filter results where pulp_last_updated has a null value | [optional] |
334
+ | **pulp_last_updated__lt** | **Time** | Filter results where pulp_last_updated is less than value | [optional] |
335
+ | **pulp_last_updated__lte** | **Time** | Filter results where pulp_last_updated is less than or equal to value | [optional] |
336
+ | **pulp_last_updated__range** | [**Array&lt;Time&gt;**](Time.md) | Filter results where pulp_last_updated is between two comma separated values | [optional] |
337
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
338
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
339
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
271
340
 
272
341
  ### Return type
273
342
 
@@ -285,16 +354,16 @@ Name | Type | Description | Notes
285
354
 
286
355
  ## list_roles
287
356
 
288
- > ObjectRolesResponse list_roles(file_file_remote_href, opts)
357
+ > <ObjectRolesResponse> list_roles(file_file_remote_href, opts)
289
358
 
290
359
  List roles
291
360
 
292
361
  List roles assigned to this object.
293
362
 
294
- ### Example
363
+ ### Examples
295
364
 
296
365
  ```ruby
297
- # load the gem
366
+ require 'time'
298
367
  require 'pulp_file_client'
299
368
  # setup authorization
300
369
  PulpFileClient.configure do |config|
@@ -306,27 +375,44 @@ end
306
375
  api_instance = PulpFileClient::RemotesFileApi.new
307
376
  file_file_remote_href = 'file_file_remote_href_example' # String |
308
377
  opts = {
309
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
310
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
378
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
379
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
311
380
  }
312
381
 
313
382
  begin
314
- #List roles
383
+ # List roles
315
384
  result = api_instance.list_roles(file_file_remote_href, opts)
316
385
  p result
317
386
  rescue PulpFileClient::ApiError => e
318
- puts "Exception when calling RemotesFileApi->list_roles: #{e}"
387
+ puts "Error when calling RemotesFileApi->list_roles: #{e}"
319
388
  end
320
389
  ```
321
390
 
322
- ### Parameters
391
+ #### Using the list_roles_with_http_info variant
392
+
393
+ This returns an Array which contains the response data, status code and headers.
394
+
395
+ > <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(file_file_remote_href, opts)
396
+
397
+ ```ruby
398
+ begin
399
+ # List roles
400
+ data, status_code, headers = api_instance.list_roles_with_http_info(file_file_remote_href, opts)
401
+ p status_code # => 2xx
402
+ p headers # => { ... }
403
+ p data # => <ObjectRolesResponse>
404
+ rescue PulpFileClient::ApiError => e
405
+ puts "Error when calling RemotesFileApi->list_roles_with_http_info: #{e}"
406
+ end
407
+ ```
323
408
 
409
+ ### Parameters
324
410
 
325
- Name | Type | Description | Notes
326
- ------------- | ------------- | ------------- | -------------
327
- **file_file_remote_href** | **String**| |
328
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
329
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
411
+ | Name | Type | Description | Notes |
412
+ | ---- | ---- | ----------- | ----- |
413
+ | **file_file_remote_href** | **String** | | |
414
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
415
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
330
416
 
331
417
  ### Return type
332
418
 
@@ -344,16 +430,16 @@ Name | Type | Description | Notes
344
430
 
345
431
  ## my_permissions
346
432
 
347
- > MyPermissionsResponse my_permissions(file_file_remote_href, opts)
433
+ > <MyPermissionsResponse> my_permissions(file_file_remote_href, opts)
348
434
 
349
435
  List user permissions
350
436
 
351
437
  List permissions available to the current user on this object.
352
438
 
353
- ### Example
439
+ ### Examples
354
440
 
355
441
  ```ruby
356
- # load the gem
442
+ require 'time'
357
443
  require 'pulp_file_client'
358
444
  # setup authorization
359
445
  PulpFileClient.configure do |config|
@@ -365,27 +451,44 @@ end
365
451
  api_instance = PulpFileClient::RemotesFileApi.new
366
452
  file_file_remote_href = 'file_file_remote_href_example' # String |
367
453
  opts = {
368
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
369
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
454
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
455
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
370
456
  }
371
457
 
372
458
  begin
373
- #List user permissions
459
+ # List user permissions
374
460
  result = api_instance.my_permissions(file_file_remote_href, opts)
375
461
  p result
376
462
  rescue PulpFileClient::ApiError => e
377
- puts "Exception when calling RemotesFileApi->my_permissions: #{e}"
463
+ puts "Error when calling RemotesFileApi->my_permissions: #{e}"
378
464
  end
379
465
  ```
380
466
 
381
- ### Parameters
467
+ #### Using the my_permissions_with_http_info variant
468
+
469
+ This returns an Array which contains the response data, status code and headers.
470
+
471
+ > <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(file_file_remote_href, opts)
382
472
 
473
+ ```ruby
474
+ begin
475
+ # List user permissions
476
+ data, status_code, headers = api_instance.my_permissions_with_http_info(file_file_remote_href, opts)
477
+ p status_code # => 2xx
478
+ p headers # => { ... }
479
+ p data # => <MyPermissionsResponse>
480
+ rescue PulpFileClient::ApiError => e
481
+ puts "Error when calling RemotesFileApi->my_permissions_with_http_info: #{e}"
482
+ end
483
+ ```
484
+
485
+ ### Parameters
383
486
 
384
- Name | Type | Description | Notes
385
- ------------- | ------------- | ------------- | -------------
386
- **file_file_remote_href** | **String**| |
387
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
388
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
487
+ | Name | Type | Description | Notes |
488
+ | ---- | ---- | ----------- | ----- |
489
+ | **file_file_remote_href** | **String** | | |
490
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
491
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
389
492
 
390
493
  ### Return type
391
494
 
@@ -403,16 +506,16 @@ Name | Type | Description | Notes
403
506
 
404
507
  ## partial_update
405
508
 
406
- > AsyncOperationResponse partial_update(file_file_remote_href, patchedfile_file_remote)
509
+ > <AsyncOperationResponse> partial_update(file_file_remote_href, patchedfile_file_remote)
407
510
 
408
511
  Update a file remote
409
512
 
410
513
  Trigger an asynchronous partial update task
411
514
 
412
- ### Example
515
+ ### Examples
413
516
 
414
517
  ```ruby
415
- # load the gem
518
+ require 'time'
416
519
  require 'pulp_file_client'
417
520
  # setup authorization
418
521
  PulpFileClient.configure do |config|
@@ -426,21 +529,38 @@ file_file_remote_href = 'file_file_remote_href_example' # String |
426
529
  patchedfile_file_remote = PulpFileClient::PatchedfileFileRemote.new # PatchedfileFileRemote |
427
530
 
428
531
  begin
429
- #Update a file remote
532
+ # Update a file remote
430
533
  result = api_instance.partial_update(file_file_remote_href, patchedfile_file_remote)
431
534
  p result
432
535
  rescue PulpFileClient::ApiError => e
433
- puts "Exception when calling RemotesFileApi->partial_update: #{e}"
536
+ puts "Error when calling RemotesFileApi->partial_update: #{e}"
434
537
  end
435
538
  ```
436
539
 
437
- ### Parameters
540
+ #### Using the partial_update_with_http_info variant
541
+
542
+ This returns an Array which contains the response data, status code and headers.
438
543
 
544
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(file_file_remote_href, patchedfile_file_remote)
439
545
 
440
- Name | Type | Description | Notes
441
- ------------- | ------------- | ------------- | -------------
442
- **file_file_remote_href** | **String**| |
443
- **patchedfile_file_remote** | [**PatchedfileFileRemote**](PatchedfileFileRemote.md)| |
546
+ ```ruby
547
+ begin
548
+ # Update a file remote
549
+ data, status_code, headers = api_instance.partial_update_with_http_info(file_file_remote_href, patchedfile_file_remote)
550
+ p status_code # => 2xx
551
+ p headers # => { ... }
552
+ p data # => <AsyncOperationResponse>
553
+ rescue PulpFileClient::ApiError => e
554
+ puts "Error when calling RemotesFileApi->partial_update_with_http_info: #{e}"
555
+ end
556
+ ```
557
+
558
+ ### Parameters
559
+
560
+ | Name | Type | Description | Notes |
561
+ | ---- | ---- | ----------- | ----- |
562
+ | **file_file_remote_href** | **String** | | |
563
+ | **patchedfile_file_remote** | [**PatchedfileFileRemote**](PatchedfileFileRemote.md) | | |
444
564
 
445
565
  ### Return type
446
566
 
@@ -458,16 +578,16 @@ Name | Type | Description | Notes
458
578
 
459
579
  ## read
460
580
 
461
- > FileFileRemoteResponse read(file_file_remote_href, opts)
581
+ > <FileFileRemoteResponse> read(file_file_remote_href, opts)
462
582
 
463
583
  Inspect a file remote
464
584
 
465
585
  FileRemote represents an external source of File Content. The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.
466
586
 
467
- ### Example
587
+ ### Examples
468
588
 
469
589
  ```ruby
470
- # load the gem
590
+ require 'time'
471
591
  require 'pulp_file_client'
472
592
  # setup authorization
473
593
  PulpFileClient.configure do |config|
@@ -479,27 +599,44 @@ end
479
599
  api_instance = PulpFileClient::RemotesFileApi.new
480
600
  file_file_remote_href = 'file_file_remote_href_example' # String |
481
601
  opts = {
482
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
483
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
602
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
603
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
484
604
  }
485
605
 
486
606
  begin
487
- #Inspect a file remote
607
+ # Inspect a file remote
488
608
  result = api_instance.read(file_file_remote_href, opts)
489
609
  p result
490
610
  rescue PulpFileClient::ApiError => e
491
- puts "Exception when calling RemotesFileApi->read: #{e}"
611
+ puts "Error when calling RemotesFileApi->read: #{e}"
492
612
  end
493
613
  ```
494
614
 
495
- ### Parameters
615
+ #### Using the read_with_http_info variant
616
+
617
+ This returns an Array which contains the response data, status code and headers.
618
+
619
+ > <Array(<FileFileRemoteResponse>, Integer, Hash)> read_with_http_info(file_file_remote_href, opts)
620
+
621
+ ```ruby
622
+ begin
623
+ # Inspect a file remote
624
+ data, status_code, headers = api_instance.read_with_http_info(file_file_remote_href, opts)
625
+ p status_code # => 2xx
626
+ p headers # => { ... }
627
+ p data # => <FileFileRemoteResponse>
628
+ rescue PulpFileClient::ApiError => e
629
+ puts "Error when calling RemotesFileApi->read_with_http_info: #{e}"
630
+ end
631
+ ```
496
632
 
633
+ ### Parameters
497
634
 
498
- Name | Type | Description | Notes
499
- ------------- | ------------- | ------------- | -------------
500
- **file_file_remote_href** | **String**| |
501
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
502
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
635
+ | Name | Type | Description | Notes |
636
+ | ---- | ---- | ----------- | ----- |
637
+ | **file_file_remote_href** | **String** | | |
638
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
639
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
503
640
 
504
641
  ### Return type
505
642
 
@@ -517,16 +654,16 @@ Name | Type | Description | Notes
517
654
 
518
655
  ## remove_role
519
656
 
520
- > NestedRoleResponse remove_role(file_file_remote_href, nested_role)
657
+ > <NestedRoleResponse> remove_role(file_file_remote_href, nested_role)
521
658
 
522
659
  Remove a role
523
660
 
524
661
  Remove a role for this object from users/groups.
525
662
 
526
- ### Example
663
+ ### Examples
527
664
 
528
665
  ```ruby
529
- # load the gem
666
+ require 'time'
530
667
  require 'pulp_file_client'
531
668
  # setup authorization
532
669
  PulpFileClient.configure do |config|
@@ -537,24 +674,41 @@ end
537
674
 
538
675
  api_instance = PulpFileClient::RemotesFileApi.new
539
676
  file_file_remote_href = 'file_file_remote_href_example' # String |
540
- nested_role = PulpFileClient::NestedRole.new # NestedRole |
677
+ nested_role = PulpFileClient::NestedRole.new({role: 'role_example'}) # NestedRole |
541
678
 
542
679
  begin
543
- #Remove a role
680
+ # Remove a role
544
681
  result = api_instance.remove_role(file_file_remote_href, nested_role)
545
682
  p result
546
683
  rescue PulpFileClient::ApiError => e
547
- puts "Exception when calling RemotesFileApi->remove_role: #{e}"
684
+ puts "Error when calling RemotesFileApi->remove_role: #{e}"
548
685
  end
549
686
  ```
550
687
 
551
- ### Parameters
688
+ #### Using the remove_role_with_http_info variant
689
+
690
+ This returns an Array which contains the response data, status code and headers.
691
+
692
+ > <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(file_file_remote_href, nested_role)
552
693
 
694
+ ```ruby
695
+ begin
696
+ # Remove a role
697
+ data, status_code, headers = api_instance.remove_role_with_http_info(file_file_remote_href, nested_role)
698
+ p status_code # => 2xx
699
+ p headers # => { ... }
700
+ p data # => <NestedRoleResponse>
701
+ rescue PulpFileClient::ApiError => e
702
+ puts "Error when calling RemotesFileApi->remove_role_with_http_info: #{e}"
703
+ end
704
+ ```
705
+
706
+ ### Parameters
553
707
 
554
- Name | Type | Description | Notes
555
- ------------- | ------------- | ------------- | -------------
556
- **file_file_remote_href** | **String**| |
557
- **nested_role** | [**NestedRole**](NestedRole.md)| |
708
+ | Name | Type | Description | Notes |
709
+ | ---- | ---- | ----------- | ----- |
710
+ | **file_file_remote_href** | **String** | | |
711
+ | **nested_role** | [**NestedRole**](NestedRole.md) | | |
558
712
 
559
713
  ### Return type
560
714
 
@@ -572,16 +726,16 @@ Name | Type | Description | Notes
572
726
 
573
727
  ## set_label
574
728
 
575
- > SetLabelResponse set_label(file_file_remote_href, set_label)
729
+ > <SetLabelResponse> set_label(file_file_remote_href, set_label)
576
730
 
577
731
  Set a label
578
732
 
579
733
  Set a single pulp_label on the object to a specific value or null.
580
734
 
581
- ### Example
735
+ ### Examples
582
736
 
583
737
  ```ruby
584
- # load the gem
738
+ require 'time'
585
739
  require 'pulp_file_client'
586
740
  # setup authorization
587
741
  PulpFileClient.configure do |config|
@@ -592,24 +746,41 @@ end
592
746
 
593
747
  api_instance = PulpFileClient::RemotesFileApi.new
594
748
  file_file_remote_href = 'file_file_remote_href_example' # String |
595
- set_label = PulpFileClient::SetLabel.new # SetLabel |
749
+ set_label = PulpFileClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
596
750
 
597
751
  begin
598
- #Set a label
752
+ # Set a label
599
753
  result = api_instance.set_label(file_file_remote_href, set_label)
600
754
  p result
601
755
  rescue PulpFileClient::ApiError => e
602
- puts "Exception when calling RemotesFileApi->set_label: #{e}"
756
+ puts "Error when calling RemotesFileApi->set_label: #{e}"
603
757
  end
604
758
  ```
605
759
 
606
- ### Parameters
760
+ #### Using the set_label_with_http_info variant
761
+
762
+ This returns an Array which contains the response data, status code and headers.
607
763
 
764
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(file_file_remote_href, set_label)
608
765
 
609
- Name | Type | Description | Notes
610
- ------------- | ------------- | ------------- | -------------
611
- **file_file_remote_href** | **String**| |
612
- **set_label** | [**SetLabel**](SetLabel.md)| |
766
+ ```ruby
767
+ begin
768
+ # Set a label
769
+ data, status_code, headers = api_instance.set_label_with_http_info(file_file_remote_href, set_label)
770
+ p status_code # => 2xx
771
+ p headers # => { ... }
772
+ p data # => <SetLabelResponse>
773
+ rescue PulpFileClient::ApiError => e
774
+ puts "Error when calling RemotesFileApi->set_label_with_http_info: #{e}"
775
+ end
776
+ ```
777
+
778
+ ### Parameters
779
+
780
+ | Name | Type | Description | Notes |
781
+ | ---- | ---- | ----------- | ----- |
782
+ | **file_file_remote_href** | **String** | | |
783
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
613
784
 
614
785
  ### Return type
615
786
 
@@ -627,16 +798,16 @@ Name | Type | Description | Notes
627
798
 
628
799
  ## unset_label
629
800
 
630
- > UnsetLabelResponse unset_label(file_file_remote_href, unset_label)
801
+ > <UnsetLabelResponse> unset_label(file_file_remote_href, unset_label)
631
802
 
632
803
  Unset a label
633
804
 
634
805
  Unset a single pulp_label on the object.
635
806
 
636
- ### Example
807
+ ### Examples
637
808
 
638
809
  ```ruby
639
- # load the gem
810
+ require 'time'
640
811
  require 'pulp_file_client'
641
812
  # setup authorization
642
813
  PulpFileClient.configure do |config|
@@ -647,24 +818,41 @@ end
647
818
 
648
819
  api_instance = PulpFileClient::RemotesFileApi.new
649
820
  file_file_remote_href = 'file_file_remote_href_example' # String |
650
- unset_label = PulpFileClient::UnsetLabel.new # UnsetLabel |
821
+ unset_label = PulpFileClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
651
822
 
652
823
  begin
653
- #Unset a label
824
+ # Unset a label
654
825
  result = api_instance.unset_label(file_file_remote_href, unset_label)
655
826
  p result
656
827
  rescue PulpFileClient::ApiError => e
657
- puts "Exception when calling RemotesFileApi->unset_label: #{e}"
828
+ puts "Error when calling RemotesFileApi->unset_label: #{e}"
658
829
  end
659
830
  ```
660
831
 
661
- ### Parameters
832
+ #### Using the unset_label_with_http_info variant
833
+
834
+ This returns an Array which contains the response data, status code and headers.
835
+
836
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(file_file_remote_href, unset_label)
837
+
838
+ ```ruby
839
+ begin
840
+ # Unset a label
841
+ data, status_code, headers = api_instance.unset_label_with_http_info(file_file_remote_href, unset_label)
842
+ p status_code # => 2xx
843
+ p headers # => { ... }
844
+ p data # => <UnsetLabelResponse>
845
+ rescue PulpFileClient::ApiError => e
846
+ puts "Error when calling RemotesFileApi->unset_label_with_http_info: #{e}"
847
+ end
848
+ ```
662
849
 
850
+ ### Parameters
663
851
 
664
- Name | Type | Description | Notes
665
- ------------- | ------------- | ------------- | -------------
666
- **file_file_remote_href** | **String**| |
667
- **unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
852
+ | Name | Type | Description | Notes |
853
+ | ---- | ---- | ----------- | ----- |
854
+ | **file_file_remote_href** | **String** | | |
855
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
668
856
 
669
857
  ### Return type
670
858
 
@@ -682,16 +870,16 @@ Name | Type | Description | Notes
682
870
 
683
871
  ## update
684
872
 
685
- > AsyncOperationResponse update(file_file_remote_href, file_file_remote)
873
+ > <AsyncOperationResponse> update(file_file_remote_href, file_file_remote)
686
874
 
687
875
  Update a file remote
688
876
 
689
877
  Trigger an asynchronous update task
690
878
 
691
- ### Example
879
+ ### Examples
692
880
 
693
881
  ```ruby
694
- # load the gem
882
+ require 'time'
695
883
  require 'pulp_file_client'
696
884
  # setup authorization
697
885
  PulpFileClient.configure do |config|
@@ -702,24 +890,41 @@ end
702
890
 
703
891
  api_instance = PulpFileClient::RemotesFileApi.new
704
892
  file_file_remote_href = 'file_file_remote_href_example' # String |
705
- file_file_remote = PulpFileClient::FileFileRemote.new # FileFileRemote |
893
+ file_file_remote = PulpFileClient::FileFileRemote.new({name: 'name_example', url: 'url_example'}) # FileFileRemote |
706
894
 
707
895
  begin
708
- #Update a file remote
896
+ # Update a file remote
709
897
  result = api_instance.update(file_file_remote_href, file_file_remote)
710
898
  p result
711
899
  rescue PulpFileClient::ApiError => e
712
- puts "Exception when calling RemotesFileApi->update: #{e}"
900
+ puts "Error when calling RemotesFileApi->update: #{e}"
713
901
  end
714
902
  ```
715
903
 
716
- ### Parameters
904
+ #### Using the update_with_http_info variant
905
+
906
+ This returns an Array which contains the response data, status code and headers.
907
+
908
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(file_file_remote_href, file_file_remote)
717
909
 
910
+ ```ruby
911
+ begin
912
+ # Update a file remote
913
+ data, status_code, headers = api_instance.update_with_http_info(file_file_remote_href, file_file_remote)
914
+ p status_code # => 2xx
915
+ p headers # => { ... }
916
+ p data # => <AsyncOperationResponse>
917
+ rescue PulpFileClient::ApiError => e
918
+ puts "Error when calling RemotesFileApi->update_with_http_info: #{e}"
919
+ end
920
+ ```
921
+
922
+ ### Parameters
718
923
 
719
- Name | Type | Description | Notes
720
- ------------- | ------------- | ------------- | -------------
721
- **file_file_remote_href** | **String**| |
722
- **file_file_remote** | [**FileFileRemote**](FileFileRemote.md)| |
924
+ | Name | Type | Description | Notes |
925
+ | ---- | ---- | ----------- | ----- |
926
+ | **file_file_remote_href** | **String** | | |
927
+ | **file_file_remote** | [**FileFileRemote**](FileFileRemote.md) | | |
723
928
 
724
929
  ### Return type
725
930