pulp_file_client 1.6.0.post0 → 1.7.0.dev1615260987

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of pulp_file_client might be problematic. Click here for more details.

Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/docs/ContentFilesApi.md +10 -10
  4. data/docs/DistributionsFileApi.md +20 -20
  5. data/docs/ExportersFilesystemApi.md +10 -10
  6. data/docs/FileFileRemote.md +7 -1
  7. data/docs/FileFileRemoteResponse.md +3 -7
  8. data/docs/PatchedfileFileRemote.md +7 -1
  9. data/docs/PublicationsFileApi.md +14 -14
  10. data/docs/RemotesFileApi.md +24 -24
  11. data/docs/RepositoriesFileApi.md +12 -12
  12. data/docs/RepositoriesFileVersionsApi.md +28 -28
  13. data/lib/pulp_file_client/api/content_files_api.rb +10 -10
  14. data/lib/pulp_file_client/api/distributions_file_api.rb +22 -22
  15. data/lib/pulp_file_client/api/exporters_filesystem_api.rb +11 -11
  16. data/lib/pulp_file_client/api/publications_file_api.rb +15 -15
  17. data/lib/pulp_file_client/api/remotes_file_api.rb +26 -26
  18. data/lib/pulp_file_client/api/repositories_file_api.rb +13 -13
  19. data/lib/pulp_file_client/api/repositories_file_versions_api.rb +50 -30
  20. data/lib/pulp_file_client/models/file_file_remote.rb +36 -2
  21. data/lib/pulp_file_client/models/file_file_remote_response.rb +14 -35
  22. data/lib/pulp_file_client/models/patchedfile_file_remote.rb +36 -2
  23. data/lib/pulp_file_client/version.rb +1 -1
  24. data/spec/api/content_files_api_spec.rb +5 -5
  25. data/spec/api/distributions_file_api_spec.rb +10 -10
  26. data/spec/api/exporters_filesystem_api_spec.rb +5 -5
  27. data/spec/api/publications_file_api_spec.rb +7 -7
  28. data/spec/api/remotes_file_api_spec.rb +12 -12
  29. data/spec/api/repositories_file_api_spec.rb +6 -6
  30. data/spec/api/repositories_file_versions_api_spec.rb +14 -14
  31. data/spec/models/file_file_remote_response_spec.rb +6 -18
  32. data/spec/models/file_file_remote_spec.rb +18 -0
  33. data/spec/models/patchedfile_file_remote_spec.rb +18 -0
  34. metadata +2 -2
@@ -33,9 +33,15 @@ module PulpFileClient
33
33
  # If True, TLS peer validation must be performed.
34
34
  attr_accessor :tls_validation
35
35
 
36
- # The proxy URL. Format: scheme://user:password@host:port
36
+ # The proxy URL. Format: scheme://host:port
37
37
  attr_accessor :proxy_url
38
38
 
39
+ # The username to authenticte to the proxy.
40
+ attr_accessor :proxy_username
41
+
42
+ # The password to authenticte to the proxy.
43
+ attr_accessor :proxy_password
44
+
39
45
  # The username to be used for authentication when syncing.
40
46
  attr_accessor :username
41
47
 
@@ -62,6 +68,9 @@ module PulpFileClient
62
68
  # aiohttp.ClientTimeout.sock_read (q.v.) for download-connections.
63
69
  attr_accessor :sock_read_timeout
64
70
 
71
+ # Headers for aiohttp.Clientsession
72
+ attr_accessor :headers
73
+
65
74
  # Limits total download rate in requests per second
66
75
  attr_accessor :rate_limit
67
76
 
@@ -75,6 +84,8 @@ module PulpFileClient
75
84
  :'client_key' => :'client_key',
76
85
  :'tls_validation' => :'tls_validation',
77
86
  :'proxy_url' => :'proxy_url',
87
+ :'proxy_username' => :'proxy_username',
88
+ :'proxy_password' => :'proxy_password',
78
89
  :'username' => :'username',
79
90
  :'password' => :'password',
80
91
  :'pulp_labels' => :'pulp_labels',
@@ -84,6 +95,7 @@ module PulpFileClient
84
95
  :'connect_timeout' => :'connect_timeout',
85
96
  :'sock_connect_timeout' => :'sock_connect_timeout',
86
97
  :'sock_read_timeout' => :'sock_read_timeout',
98
+ :'headers' => :'headers',
87
99
  :'rate_limit' => :'rate_limit'
88
100
  }
89
101
  end
@@ -98,6 +110,8 @@ module PulpFileClient
98
110
  :'client_key' => :'String',
99
111
  :'tls_validation' => :'Boolean',
100
112
  :'proxy_url' => :'String',
113
+ :'proxy_username' => :'String',
114
+ :'proxy_password' => :'String',
101
115
  :'username' => :'String',
102
116
  :'password' => :'String',
103
117
  :'pulp_labels' => :'Object',
@@ -107,6 +121,7 @@ module PulpFileClient
107
121
  :'connect_timeout' => :'Float',
108
122
  :'sock_connect_timeout' => :'Float',
109
123
  :'sock_read_timeout' => :'Float',
124
+ :'headers' => :'Array<Object>',
110
125
  :'rate_limit' => :'Integer'
111
126
  }
112
127
  end
@@ -118,6 +133,8 @@ module PulpFileClient
118
133
  :'client_cert',
119
134
  :'client_key',
120
135
  :'proxy_url',
136
+ :'proxy_username',
137
+ :'proxy_password',
121
138
  :'username',
122
139
  :'password',
123
140
  :'total_timeout',
@@ -171,6 +188,14 @@ module PulpFileClient
171
188
  self.proxy_url = attributes[:'proxy_url']
172
189
  end
173
190
 
191
+ if attributes.key?(:'proxy_username')
192
+ self.proxy_username = attributes[:'proxy_username']
193
+ end
194
+
195
+ if attributes.key?(:'proxy_password')
196
+ self.proxy_password = attributes[:'proxy_password']
197
+ end
198
+
174
199
  if attributes.key?(:'username')
175
200
  self.username = attributes[:'username']
176
201
  end
@@ -207,6 +232,12 @@ module PulpFileClient
207
232
  self.sock_read_timeout = attributes[:'sock_read_timeout']
208
233
  end
209
234
 
235
+ if attributes.key?(:'headers')
236
+ if (value = attributes[:'headers']).is_a?(Array)
237
+ self.headers = value
238
+ end
239
+ end
240
+
210
241
  if attributes.key?(:'rate_limit')
211
242
  self.rate_limit = attributes[:'rate_limit']
212
243
  end
@@ -322,6 +353,8 @@ module PulpFileClient
322
353
  client_key == o.client_key &&
323
354
  tls_validation == o.tls_validation &&
324
355
  proxy_url == o.proxy_url &&
356
+ proxy_username == o.proxy_username &&
357
+ proxy_password == o.proxy_password &&
325
358
  username == o.username &&
326
359
  password == o.password &&
327
360
  pulp_labels == o.pulp_labels &&
@@ -331,6 +364,7 @@ module PulpFileClient
331
364
  connect_timeout == o.connect_timeout &&
332
365
  sock_connect_timeout == o.sock_connect_timeout &&
333
366
  sock_read_timeout == o.sock_read_timeout &&
367
+ headers == o.headers &&
334
368
  rate_limit == o.rate_limit
335
369
  end
336
370
 
@@ -343,7 +377,7 @@ module PulpFileClient
343
377
  # Calculates hash code according to all attributes.
344
378
  # @return [Integer] Hash code
345
379
  def hash
346
- [name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, username, password, pulp_labels, download_concurrency, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, rate_limit].hash
380
+ [name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, proxy_username, proxy_password, username, password, pulp_labels, download_concurrency, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, headers, rate_limit].hash
347
381
  end
348
382
 
349
383
  # Builds the object from hash
@@ -32,21 +32,12 @@ module PulpFileClient
32
32
  # A PEM encoded client certificate used for authentication.
33
33
  attr_accessor :client_cert
34
34
 
35
- # A PEM encoded private key used for authentication.
36
- attr_accessor :client_key
37
-
38
35
  # If True, TLS peer validation must be performed.
39
36
  attr_accessor :tls_validation
40
37
 
41
- # The proxy URL. Format: scheme://user:password@host:port
38
+ # The proxy URL. Format: scheme://host:port
42
39
  attr_accessor :proxy_url
43
40
 
44
- # The username to be used for authentication when syncing.
45
- attr_accessor :username
46
-
47
- # The password to be used for authentication when syncing.
48
- attr_accessor :password
49
-
50
41
  attr_accessor :pulp_labels
51
42
 
52
43
  # Timestamp of the most recent update of the remote.
@@ -70,6 +61,9 @@ module PulpFileClient
70
61
  # aiohttp.ClientTimeout.sock_read (q.v.) for download-connections.
71
62
  attr_accessor :sock_read_timeout
72
63
 
64
+ # Headers for aiohttp.Clientsession
65
+ attr_accessor :headers
66
+
73
67
  # Limits total download rate in requests per second
74
68
  attr_accessor :rate_limit
75
69
 
@@ -82,11 +76,8 @@ module PulpFileClient
82
76
  :'url' => :'url',
83
77
  :'ca_cert' => :'ca_cert',
84
78
  :'client_cert' => :'client_cert',
85
- :'client_key' => :'client_key',
86
79
  :'tls_validation' => :'tls_validation',
87
80
  :'proxy_url' => :'proxy_url',
88
- :'username' => :'username',
89
- :'password' => :'password',
90
81
  :'pulp_labels' => :'pulp_labels',
91
82
  :'pulp_last_updated' => :'pulp_last_updated',
92
83
  :'download_concurrency' => :'download_concurrency',
@@ -95,6 +86,7 @@ module PulpFileClient
95
86
  :'connect_timeout' => :'connect_timeout',
96
87
  :'sock_connect_timeout' => :'sock_connect_timeout',
97
88
  :'sock_read_timeout' => :'sock_read_timeout',
89
+ :'headers' => :'headers',
98
90
  :'rate_limit' => :'rate_limit'
99
91
  }
100
92
  end
@@ -108,11 +100,8 @@ module PulpFileClient
108
100
  :'url' => :'String',
109
101
  :'ca_cert' => :'String',
110
102
  :'client_cert' => :'String',
111
- :'client_key' => :'String',
112
103
  :'tls_validation' => :'Boolean',
113
104
  :'proxy_url' => :'String',
114
- :'username' => :'String',
115
- :'password' => :'String',
116
105
  :'pulp_labels' => :'Object',
117
106
  :'pulp_last_updated' => :'DateTime',
118
107
  :'download_concurrency' => :'Integer',
@@ -121,6 +110,7 @@ module PulpFileClient
121
110
  :'connect_timeout' => :'Float',
122
111
  :'sock_connect_timeout' => :'Float',
123
112
  :'sock_read_timeout' => :'Float',
113
+ :'headers' => :'Array<Object>',
124
114
  :'rate_limit' => :'Integer'
125
115
  }
126
116
  end
@@ -130,10 +120,7 @@ module PulpFileClient
130
120
  Set.new([
131
121
  :'ca_cert',
132
122
  :'client_cert',
133
- :'client_key',
134
123
  :'proxy_url',
135
- :'username',
136
- :'password',
137
124
  :'total_timeout',
138
125
  :'connect_timeout',
139
126
  :'sock_connect_timeout',
@@ -181,10 +168,6 @@ module PulpFileClient
181
168
  self.client_cert = attributes[:'client_cert']
182
169
  end
183
170
 
184
- if attributes.key?(:'client_key')
185
- self.client_key = attributes[:'client_key']
186
- end
187
-
188
171
  if attributes.key?(:'tls_validation')
189
172
  self.tls_validation = attributes[:'tls_validation']
190
173
  end
@@ -193,14 +176,6 @@ module PulpFileClient
193
176
  self.proxy_url = attributes[:'proxy_url']
194
177
  end
195
178
 
196
- if attributes.key?(:'username')
197
- self.username = attributes[:'username']
198
- end
199
-
200
- if attributes.key?(:'password')
201
- self.password = attributes[:'password']
202
- end
203
-
204
179
  if attributes.key?(:'pulp_labels')
205
180
  self.pulp_labels = attributes[:'pulp_labels']
206
181
  end
@@ -233,6 +208,12 @@ module PulpFileClient
233
208
  self.sock_read_timeout = attributes[:'sock_read_timeout']
234
209
  end
235
210
 
211
+ if attributes.key?(:'headers')
212
+ if (value = attributes[:'headers']).is_a?(Array)
213
+ self.headers = value
214
+ end
215
+ end
216
+
236
217
  if attributes.key?(:'rate_limit')
237
218
  self.rate_limit = attributes[:'rate_limit']
238
219
  end
@@ -347,11 +328,8 @@ module PulpFileClient
347
328
  url == o.url &&
348
329
  ca_cert == o.ca_cert &&
349
330
  client_cert == o.client_cert &&
350
- client_key == o.client_key &&
351
331
  tls_validation == o.tls_validation &&
352
332
  proxy_url == o.proxy_url &&
353
- username == o.username &&
354
- password == o.password &&
355
333
  pulp_labels == o.pulp_labels &&
356
334
  pulp_last_updated == o.pulp_last_updated &&
357
335
  download_concurrency == o.download_concurrency &&
@@ -360,6 +338,7 @@ module PulpFileClient
360
338
  connect_timeout == o.connect_timeout &&
361
339
  sock_connect_timeout == o.sock_connect_timeout &&
362
340
  sock_read_timeout == o.sock_read_timeout &&
341
+ headers == o.headers &&
363
342
  rate_limit == o.rate_limit
364
343
  end
365
344
 
@@ -372,7 +351,7 @@ module PulpFileClient
372
351
  # Calculates hash code according to all attributes.
373
352
  # @return [Integer] Hash code
374
353
  def hash
375
- [pulp_href, pulp_created, name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, username, password, pulp_labels, pulp_last_updated, download_concurrency, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, rate_limit].hash
354
+ [pulp_href, pulp_created, name, url, ca_cert, client_cert, tls_validation, proxy_url, pulp_labels, pulp_last_updated, download_concurrency, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, headers, rate_limit].hash
376
355
  end
377
356
 
378
357
  # Builds the object from hash
@@ -33,9 +33,15 @@ module PulpFileClient
33
33
  # If True, TLS peer validation must be performed.
34
34
  attr_accessor :tls_validation
35
35
 
36
- # The proxy URL. Format: scheme://user:password@host:port
36
+ # The proxy URL. Format: scheme://host:port
37
37
  attr_accessor :proxy_url
38
38
 
39
+ # The username to authenticte to the proxy.
40
+ attr_accessor :proxy_username
41
+
42
+ # The password to authenticte to the proxy.
43
+ attr_accessor :proxy_password
44
+
39
45
  # The username to be used for authentication when syncing.
40
46
  attr_accessor :username
41
47
 
@@ -62,6 +68,9 @@ module PulpFileClient
62
68
  # aiohttp.ClientTimeout.sock_read (q.v.) for download-connections.
63
69
  attr_accessor :sock_read_timeout
64
70
 
71
+ # Headers for aiohttp.Clientsession
72
+ attr_accessor :headers
73
+
65
74
  # Limits total download rate in requests per second
66
75
  attr_accessor :rate_limit
67
76
 
@@ -75,6 +84,8 @@ module PulpFileClient
75
84
  :'client_key' => :'client_key',
76
85
  :'tls_validation' => :'tls_validation',
77
86
  :'proxy_url' => :'proxy_url',
87
+ :'proxy_username' => :'proxy_username',
88
+ :'proxy_password' => :'proxy_password',
78
89
  :'username' => :'username',
79
90
  :'password' => :'password',
80
91
  :'pulp_labels' => :'pulp_labels',
@@ -84,6 +95,7 @@ module PulpFileClient
84
95
  :'connect_timeout' => :'connect_timeout',
85
96
  :'sock_connect_timeout' => :'sock_connect_timeout',
86
97
  :'sock_read_timeout' => :'sock_read_timeout',
98
+ :'headers' => :'headers',
87
99
  :'rate_limit' => :'rate_limit'
88
100
  }
89
101
  end
@@ -98,6 +110,8 @@ module PulpFileClient
98
110
  :'client_key' => :'String',
99
111
  :'tls_validation' => :'Boolean',
100
112
  :'proxy_url' => :'String',
113
+ :'proxy_username' => :'String',
114
+ :'proxy_password' => :'String',
101
115
  :'username' => :'String',
102
116
  :'password' => :'String',
103
117
  :'pulp_labels' => :'Object',
@@ -107,6 +121,7 @@ module PulpFileClient
107
121
  :'connect_timeout' => :'Float',
108
122
  :'sock_connect_timeout' => :'Float',
109
123
  :'sock_read_timeout' => :'Float',
124
+ :'headers' => :'Array<Object>',
110
125
  :'rate_limit' => :'Integer'
111
126
  }
112
127
  end
@@ -118,6 +133,8 @@ module PulpFileClient
118
133
  :'client_cert',
119
134
  :'client_key',
120
135
  :'proxy_url',
136
+ :'proxy_username',
137
+ :'proxy_password',
121
138
  :'username',
122
139
  :'password',
123
140
  :'total_timeout',
@@ -171,6 +188,14 @@ module PulpFileClient
171
188
  self.proxy_url = attributes[:'proxy_url']
172
189
  end
173
190
 
191
+ if attributes.key?(:'proxy_username')
192
+ self.proxy_username = attributes[:'proxy_username']
193
+ end
194
+
195
+ if attributes.key?(:'proxy_password')
196
+ self.proxy_password = attributes[:'proxy_password']
197
+ end
198
+
174
199
  if attributes.key?(:'username')
175
200
  self.username = attributes[:'username']
176
201
  end
@@ -207,6 +232,12 @@ module PulpFileClient
207
232
  self.sock_read_timeout = attributes[:'sock_read_timeout']
208
233
  end
209
234
 
235
+ if attributes.key?(:'headers')
236
+ if (value = attributes[:'headers']).is_a?(Array)
237
+ self.headers = value
238
+ end
239
+ end
240
+
210
241
  if attributes.key?(:'rate_limit')
211
242
  self.rate_limit = attributes[:'rate_limit']
212
243
  end
@@ -312,6 +343,8 @@ module PulpFileClient
312
343
  client_key == o.client_key &&
313
344
  tls_validation == o.tls_validation &&
314
345
  proxy_url == o.proxy_url &&
346
+ proxy_username == o.proxy_username &&
347
+ proxy_password == o.proxy_password &&
315
348
  username == o.username &&
316
349
  password == o.password &&
317
350
  pulp_labels == o.pulp_labels &&
@@ -321,6 +354,7 @@ module PulpFileClient
321
354
  connect_timeout == o.connect_timeout &&
322
355
  sock_connect_timeout == o.sock_connect_timeout &&
323
356
  sock_read_timeout == o.sock_read_timeout &&
357
+ headers == o.headers &&
324
358
  rate_limit == o.rate_limit
325
359
  end
326
360
 
@@ -333,7 +367,7 @@ module PulpFileClient
333
367
  # Calculates hash code according to all attributes.
334
368
  # @return [Integer] Hash code
335
369
  def hash
336
- [name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, username, password, pulp_labels, download_concurrency, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, rate_limit].hash
370
+ [name, url, ca_cert, client_cert, client_key, tls_validation, proxy_url, proxy_username, proxy_password, username, password, pulp_labels, download_concurrency, policy, total_timeout, connect_timeout, sock_connect_timeout, sock_read_timeout, headers, rate_limit].hash
337
371
  end
338
372
 
339
373
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.2.3
11
11
  =end
12
12
 
13
13
  module PulpFileClient
14
- VERSION = '1.6.0.post0'
14
+ VERSION = '1.7.0.dev1615260987'
15
15
  end
@@ -54,11 +54,11 @@ describe 'ContentFilesApi' do
54
54
  # @option opts [Integer] :limit Number of results to return per page.
55
55
  # @option opts [Integer] :offset The initial index from which to return the results.
56
56
  # @option opts [String] :ordering Which field to use when ordering the results.
57
- # @option opts [String] :relative_path relative_path
58
- # @option opts [String] :repository_version repository_version
59
- # @option opts [String] :repository_version_added repository_version_added
60
- # @option opts [String] :repository_version_removed repository_version_removed
61
- # @option opts [String] :sha256 sha256
57
+ # @option opts [String] :relative_path Filter results where relative_path matches value
58
+ # @option opts [String] :repository_version Repository Version referenced by HREF
59
+ # @option opts [String] :repository_version_added Repository Version referenced by HREF
60
+ # @option opts [String] :repository_version_removed Repository Version referenced by HREF
61
+ # @option opts [String] :sha256
62
62
  # @option opts [String] :fields A list of fields to include in the response.
63
63
  # @option opts [String] :exclude_fields A list of fields to exclude from the response.
64
64
  # @return [PaginatedfileFileContentResponseList]
@@ -60,19 +60,19 @@ describe 'DistributionsFileApi' do
60
60
  # List file distributions
61
61
  # FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.
62
62
  # @param [Hash] opts the optional parameters
63
- # @option opts [String] :base_path base_path
64
- # @option opts [String] :base_path__contains base_path__contains
65
- # @option opts [String] :base_path__icontains base_path__icontains
66
- # @option opts [String] :base_path__in base_path__in
63
+ # @option opts [String] :base_path
64
+ # @option opts [String] :base_path__contains Filter results where base_path contains value
65
+ # @option opts [String] :base_path__icontains Filter results where base_path contains value
66
+ # @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values
67
67
  # @option opts [Integer] :limit Number of results to return per page.
68
- # @option opts [String] :name name
69
- # @option opts [String] :name__contains name__contains
70
- # @option opts [String] :name__icontains name__icontains
71
- # @option opts [String] :name__in name__in
72
- # @option opts [String] :name__startswith name__startswith
68
+ # @option opts [String] :name
69
+ # @option opts [String] :name__contains Filter results where name contains value
70
+ # @option opts [String] :name__icontains Filter results where name contains value
71
+ # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
72
+ # @option opts [String] :name__startswith Filter results where name starts with value
73
73
  # @option opts [Integer] :offset The initial index from which to return the results.
74
74
  # @option opts [String] :ordering Which field to use when ordering the results.
75
- # @option opts [String] :pulp_label_select pulp_label_select
75
+ # @option opts [String] :pulp_label_select Filter labels by search string
76
76
  # @option opts [String] :fields A list of fields to include in the response.
77
77
  # @option opts [String] :exclude_fields A list of fields to exclude from the response.
78
78
  # @return [PaginatedfileFileDistributionResponseList]
@@ -61,11 +61,11 @@ describe 'ExportersFilesystemApi' do
61
61
  # FilesystemExporters export content from a publication to a path on the file system. WARNING: This feature is provided as a tech preview and may change in the future. Backwards compatibility is not guaranteed.
62
62
  # @param [Hash] opts the optional parameters
63
63
  # @option opts [Integer] :limit Number of results to return per page.
64
- # @option opts [String] :name name
65
- # @option opts [String] :name__contains name__contains
66
- # @option opts [String] :name__icontains name__icontains
67
- # @option opts [String] :name__in name__in
68
- # @option opts [String] :name__startswith name__startswith
64
+ # @option opts [String] :name
65
+ # @option opts [String] :name__contains Filter results where name contains value
66
+ # @option opts [String] :name__icontains Filter results where name contains value
67
+ # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
68
+ # @option opts [String] :name__startswith Filter results where name starts with value
69
69
  # @option opts [Integer] :offset The initial index from which to return the results.
70
70
  # @option opts [String] :ordering Which field to use when ordering the results.
71
71
  # @option opts [String] :fields A list of fields to include in the response.