pulpcore_client 3.118.1 → 3.119.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -4
  3. data/docs/ArtifactDistributionResponse.md +17 -17
  4. data/docs/ContentguardsApi.md +4 -4
  5. data/docs/ContentguardsEnvvarHeaderApi.md +810 -0
  6. data/docs/EnvVarHeaderContentGuard.md +24 -0
  7. data/docs/EnvVarHeaderContentGuardResponse.md +32 -0
  8. data/docs/PaginatedEnvVarHeaderContentGuardResponseList.md +24 -0
  9. data/docs/PatchedEnvVarHeaderContentGuard.md +24 -0
  10. data/docs/Purge.md +1 -1
  11. data/lib/pulpcore_client/api/contentguards_api.rb +6 -6
  12. data/lib/pulpcore_client/api/contentguards_envvar_header_api.rb +799 -0
  13. data/lib/pulpcore_client/models/artifact_distribution_response.rb +85 -85
  14. data/lib/pulpcore_client/models/env_var_header_content_guard.rb +340 -0
  15. data/lib/pulpcore_client/models/env_var_header_content_guard_response.rb +307 -0
  16. data/lib/pulpcore_client/models/paginated_env_var_header_content_guard_response_list.rb +257 -0
  17. data/lib/pulpcore_client/models/patched_env_var_header_content_guard.rb +319 -0
  18. data/lib/pulpcore_client/models/purge.rb +1 -1
  19. data/lib/pulpcore_client/version.rb +1 -1
  20. data/lib/pulpcore_client.rb +5 -0
  21. data/spec/api/contentguards_api_spec.rb +2 -2
  22. data/spec/api/contentguards_envvar_header_api_spec.rb +192 -0
  23. data/spec/models/artifact_distribution_response_spec.rb +13 -13
  24. data/spec/models/env_var_header_content_guard_response_spec.rb +78 -0
  25. data/spec/models/env_var_header_content_guard_spec.rb +54 -0
  26. data/spec/models/paginated_env_var_header_content_guard_response_list_spec.rb +54 -0
  27. data/spec/models/patched_env_var_header_content_guard_spec.rb +54 -0
  28. metadata +22 -2
@@ -0,0 +1,799 @@
1
+ =begin
2
+ #Pulp 3 API
3
+
4
+ #Fetch, Upload, Organize, and Distribute Software Packages
5
+
6
+ The version of the OpenAPI document: v3
7
+ Contact: pulp-list@redhat.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.10.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module PulpcoreClient
16
+ class ContentguardsEnvvarHeaderApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Add a role
23
+ # Add a role for this object to users/groups.
24
+ # @param env_var_header_content_guard_href [String]
25
+ # @param nested_role [NestedRole]
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
28
+ # @return [NestedRoleResponse]
29
+ def add_role(env_var_header_content_guard_href, nested_role, opts = {})
30
+ data, _status_code, _headers = add_role_with_http_info(env_var_header_content_guard_href, nested_role, opts)
31
+ data
32
+ end
33
+
34
+ # Add a role
35
+ # Add a role for this object to users/groups.
36
+ # @param env_var_header_content_guard_href [String]
37
+ # @param nested_role [NestedRole]
38
+ # @param [Hash] opts the optional parameters
39
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
40
+ # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers
41
+ def add_role_with_http_info(env_var_header_content_guard_href, nested_role, opts = {})
42
+ if @api_client.config.debugging
43
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.add_role ...'
44
+ end
45
+ # verify the required parameter 'env_var_header_content_guard_href' is set
46
+ if @api_client.config.client_side_validation && env_var_header_content_guard_href.nil?
47
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard_href' when calling ContentguardsEnvvarHeaderApi.add_role"
48
+ end
49
+ # verify the required parameter 'nested_role' is set
50
+ if @api_client.config.client_side_validation && nested_role.nil?
51
+ fail ArgumentError, "Missing the required parameter 'nested_role' when calling ContentguardsEnvvarHeaderApi.add_role"
52
+ end
53
+ # resource path
54
+ local_var_path = '{env_var_header_content_guard_href}add_role/'.sub('{' + 'env_var_header_content_guard_href' + '}', CGI.escape(env_var_header_content_guard_href.to_s).gsub('%2F', '/'))
55
+
56
+ # query parameters
57
+ query_params = opts[:query_params] || {}
58
+
59
+ # header parameters
60
+ header_params = opts[:header_params] || {}
61
+ # HTTP header 'Accept' (if needed)
62
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
63
+ # HTTP header 'Content-Type'
64
+ content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
65
+ if !content_type.nil?
66
+ header_params['Content-Type'] = content_type
67
+ end
68
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
69
+
70
+ # form parameters
71
+ form_params = opts[:form_params] || {}
72
+
73
+ # http body (model)
74
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(nested_role)
75
+
76
+ # return_type
77
+ return_type = opts[:debug_return_type] || 'NestedRoleResponse'
78
+
79
+ # auth_names
80
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
81
+
82
+ new_options = opts.merge(
83
+ :operation => :"ContentguardsEnvvarHeaderApi.add_role",
84
+ :header_params => header_params,
85
+ :query_params => query_params,
86
+ :form_params => form_params,
87
+ :body => post_body,
88
+ :auth_names => auth_names,
89
+ :return_type => return_type
90
+ )
91
+
92
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
93
+ if @api_client.config.debugging
94
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
95
+ end
96
+ return data, status_code, headers
97
+ end
98
+
99
+ # Create an env var header content guard
100
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
101
+ # @param env_var_header_content_guard [EnvVarHeaderContentGuard]
102
+ # @param [Hash] opts the optional parameters
103
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
104
+ # @return [EnvVarHeaderContentGuardResponse]
105
+ def create(env_var_header_content_guard, opts = {})
106
+ data, _status_code, _headers = create_with_http_info(env_var_header_content_guard, opts)
107
+ data
108
+ end
109
+
110
+ # Create an env var header content guard
111
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
112
+ # @param env_var_header_content_guard [EnvVarHeaderContentGuard]
113
+ # @param [Hash] opts the optional parameters
114
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
115
+ # @return [Array<(EnvVarHeaderContentGuardResponse, Integer, Hash)>] EnvVarHeaderContentGuardResponse data, response status code and response headers
116
+ def create_with_http_info(env_var_header_content_guard, opts = {})
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.create ...'
119
+ end
120
+ # verify the required parameter 'env_var_header_content_guard' is set
121
+ if @api_client.config.client_side_validation && env_var_header_content_guard.nil?
122
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard' when calling ContentguardsEnvvarHeaderApi.create"
123
+ end
124
+ # resource path
125
+ local_var_path = '/pulp/api/v3/contentguards/core/envvar_header/'
126
+
127
+ # query parameters
128
+ query_params = opts[:query_params] || {}
129
+
130
+ # header parameters
131
+ header_params = opts[:header_params] || {}
132
+ # HTTP header 'Accept' (if needed)
133
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
134
+ # HTTP header 'Content-Type'
135
+ content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
136
+ if !content_type.nil?
137
+ header_params['Content-Type'] = content_type
138
+ end
139
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
140
+
141
+ # form parameters
142
+ form_params = opts[:form_params] || {}
143
+
144
+ # http body (model)
145
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(env_var_header_content_guard)
146
+
147
+ # return_type
148
+ return_type = opts[:debug_return_type] || 'EnvVarHeaderContentGuardResponse'
149
+
150
+ # auth_names
151
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
152
+
153
+ new_options = opts.merge(
154
+ :operation => :"ContentguardsEnvvarHeaderApi.create",
155
+ :header_params => header_params,
156
+ :query_params => query_params,
157
+ :form_params => form_params,
158
+ :body => post_body,
159
+ :auth_names => auth_names,
160
+ :return_type => return_type
161
+ )
162
+
163
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
164
+ if @api_client.config.debugging
165
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
166
+ end
167
+ return data, status_code, headers
168
+ end
169
+
170
+ # Delete an env var header content guard
171
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
172
+ # @param env_var_header_content_guard_href [String]
173
+ # @param [Hash] opts the optional parameters
174
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
175
+ # @return [nil]
176
+ def delete(env_var_header_content_guard_href, opts = {})
177
+ delete_with_http_info(env_var_header_content_guard_href, opts)
178
+ nil
179
+ end
180
+
181
+ # Delete an env var header content guard
182
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
183
+ # @param env_var_header_content_guard_href [String]
184
+ # @param [Hash] opts the optional parameters
185
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
186
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
187
+ def delete_with_http_info(env_var_header_content_guard_href, opts = {})
188
+ if @api_client.config.debugging
189
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.delete ...'
190
+ end
191
+ # verify the required parameter 'env_var_header_content_guard_href' is set
192
+ if @api_client.config.client_side_validation && env_var_header_content_guard_href.nil?
193
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard_href' when calling ContentguardsEnvvarHeaderApi.delete"
194
+ end
195
+ # resource path
196
+ local_var_path = '{env_var_header_content_guard_href}'.sub('{' + 'env_var_header_content_guard_href' + '}', CGI.escape(env_var_header_content_guard_href.to_s).gsub('%2F', '/'))
197
+
198
+ # query parameters
199
+ query_params = opts[:query_params] || {}
200
+
201
+ # header parameters
202
+ header_params = opts[:header_params] || {}
203
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
204
+
205
+ # form parameters
206
+ form_params = opts[:form_params] || {}
207
+
208
+ # http body (model)
209
+ post_body = opts[:debug_body]
210
+
211
+ # return_type
212
+ return_type = opts[:debug_return_type]
213
+
214
+ # auth_names
215
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
216
+
217
+ new_options = opts.merge(
218
+ :operation => :"ContentguardsEnvvarHeaderApi.delete",
219
+ :header_params => header_params,
220
+ :query_params => query_params,
221
+ :form_params => form_params,
222
+ :body => post_body,
223
+ :auth_names => auth_names,
224
+ :return_type => return_type
225
+ )
226
+
227
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
228
+ if @api_client.config.debugging
229
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
230
+ end
231
+ return data, status_code, headers
232
+ end
233
+
234
+ # List env var header content guards
235
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
236
+ # @param [Hash] opts the optional parameters
237
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
238
+ # @option opts [Integer] :limit Number of results to return per page.
239
+ # @option opts [String] :name Filter results where name matches value
240
+ # @option opts [String] :name__contains Filter results where name contains value
241
+ # @option opts [String] :name__icontains Filter results where name contains value
242
+ # @option opts [String] :name__iexact Filter results where name matches value
243
+ # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
244
+ # @option opts [String] :name__iregex Filter results where name matches regex value
245
+ # @option opts [String] :name__istartswith Filter results where name starts with value
246
+ # @option opts [String] :name__regex Filter results where name matches regex value
247
+ # @option opts [String] :name__startswith Filter results where name starts with value
248
+ # @option opts [Integer] :offset The initial index from which to return the results.
249
+ # @option opts [Array<String>] :ordering 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;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
250
+ # @option opts [Array<String>] :prn__in Multiple values may be separated by commas.
251
+ # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
252
+ # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
253
+ # @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters
254
+ # @option opts [Array<String>] :fields A list of fields to include in the response.
255
+ # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
256
+ # @return [PaginatedEnvVarHeaderContentGuardResponseList]
257
+ def list(opts = {})
258
+ data, _status_code, _headers = list_with_http_info(opts)
259
+ data
260
+ end
261
+
262
+ # List env var header content guards
263
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
264
+ # @param [Hash] opts the optional parameters
265
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
266
+ # @option opts [Integer] :limit Number of results to return per page.
267
+ # @option opts [String] :name Filter results where name matches value
268
+ # @option opts [String] :name__contains Filter results where name contains value
269
+ # @option opts [String] :name__icontains Filter results where name contains value
270
+ # @option opts [String] :name__iexact Filter results where name matches value
271
+ # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
272
+ # @option opts [String] :name__iregex Filter results where name matches regex value
273
+ # @option opts [String] :name__istartswith Filter results where name starts with value
274
+ # @option opts [String] :name__regex Filter results where name matches regex value
275
+ # @option opts [String] :name__startswith Filter results where name starts with value
276
+ # @option opts [Integer] :offset The initial index from which to return the results.
277
+ # @option opts [Array<String>] :ordering 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;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
278
+ # @option opts [Array<String>] :prn__in Multiple values may be separated by commas.
279
+ # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
280
+ # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
281
+ # @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters
282
+ # @option opts [Array<String>] :fields A list of fields to include in the response.
283
+ # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
284
+ # @return [Array<(PaginatedEnvVarHeaderContentGuardResponseList, Integer, Hash)>] PaginatedEnvVarHeaderContentGuardResponseList data, response status code and response headers
285
+ def list_with_http_info(opts = {})
286
+ if @api_client.config.debugging
287
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.list ...'
288
+ end
289
+ allowable_values = ["-description", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "description", "name", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type"]
290
+ if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
291
+ fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
292
+ end
293
+ # resource path
294
+ local_var_path = '/pulp/api/v3/contentguards/core/envvar_header/'
295
+
296
+ # query parameters
297
+ query_params = opts[:query_params] || {}
298
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
299
+ query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
300
+ query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
301
+ query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
302
+ query_params[:'name__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil?
303
+ query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
304
+ query_params[:'name__iregex'] = opts[:'name__iregex'] if !opts[:'name__iregex'].nil?
305
+ query_params[:'name__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].nil?
306
+ query_params[:'name__regex'] = opts[:'name__regex'] if !opts[:'name__regex'].nil?
307
+ query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
308
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
309
+ query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
310
+ query_params[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].nil?
311
+ query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
312
+ query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
313
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
314
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
315
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?
316
+
317
+ # header parameters
318
+ header_params = opts[:header_params] || {}
319
+ # HTTP header 'Accept' (if needed)
320
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
321
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
322
+
323
+ # form parameters
324
+ form_params = opts[:form_params] || {}
325
+
326
+ # http body (model)
327
+ post_body = opts[:debug_body]
328
+
329
+ # return_type
330
+ return_type = opts[:debug_return_type] || 'PaginatedEnvVarHeaderContentGuardResponseList'
331
+
332
+ # auth_names
333
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
334
+
335
+ new_options = opts.merge(
336
+ :operation => :"ContentguardsEnvvarHeaderApi.list",
337
+ :header_params => header_params,
338
+ :query_params => query_params,
339
+ :form_params => form_params,
340
+ :body => post_body,
341
+ :auth_names => auth_names,
342
+ :return_type => return_type
343
+ )
344
+
345
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
346
+ if @api_client.config.debugging
347
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
348
+ end
349
+ return data, status_code, headers
350
+ end
351
+
352
+ # List roles
353
+ # List roles assigned to this object.
354
+ # @param env_var_header_content_guard_href [String]
355
+ # @param [Hash] opts the optional parameters
356
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
357
+ # @option opts [Array<String>] :fields A list of fields to include in the response.
358
+ # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
359
+ # @return [ObjectRolesResponse]
360
+ def list_roles(env_var_header_content_guard_href, opts = {})
361
+ data, _status_code, _headers = list_roles_with_http_info(env_var_header_content_guard_href, opts)
362
+ data
363
+ end
364
+
365
+ # List roles
366
+ # List roles assigned to this object.
367
+ # @param env_var_header_content_guard_href [String]
368
+ # @param [Hash] opts the optional parameters
369
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
370
+ # @option opts [Array<String>] :fields A list of fields to include in the response.
371
+ # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
372
+ # @return [Array<(ObjectRolesResponse, Integer, Hash)>] ObjectRolesResponse data, response status code and response headers
373
+ def list_roles_with_http_info(env_var_header_content_guard_href, opts = {})
374
+ if @api_client.config.debugging
375
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.list_roles ...'
376
+ end
377
+ # verify the required parameter 'env_var_header_content_guard_href' is set
378
+ if @api_client.config.client_side_validation && env_var_header_content_guard_href.nil?
379
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard_href' when calling ContentguardsEnvvarHeaderApi.list_roles"
380
+ end
381
+ # resource path
382
+ local_var_path = '{env_var_header_content_guard_href}list_roles/'.sub('{' + 'env_var_header_content_guard_href' + '}', CGI.escape(env_var_header_content_guard_href.to_s).gsub('%2F', '/'))
383
+
384
+ # query parameters
385
+ query_params = opts[:query_params] || {}
386
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
387
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?
388
+
389
+ # header parameters
390
+ header_params = opts[:header_params] || {}
391
+ # HTTP header 'Accept' (if needed)
392
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
393
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
394
+
395
+ # form parameters
396
+ form_params = opts[:form_params] || {}
397
+
398
+ # http body (model)
399
+ post_body = opts[:debug_body]
400
+
401
+ # return_type
402
+ return_type = opts[:debug_return_type] || 'ObjectRolesResponse'
403
+
404
+ # auth_names
405
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
406
+
407
+ new_options = opts.merge(
408
+ :operation => :"ContentguardsEnvvarHeaderApi.list_roles",
409
+ :header_params => header_params,
410
+ :query_params => query_params,
411
+ :form_params => form_params,
412
+ :body => post_body,
413
+ :auth_names => auth_names,
414
+ :return_type => return_type
415
+ )
416
+
417
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
418
+ if @api_client.config.debugging
419
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
420
+ end
421
+ return data, status_code, headers
422
+ end
423
+
424
+ # List user permissions
425
+ # List permissions available to the current user on this object.
426
+ # @param env_var_header_content_guard_href [String]
427
+ # @param [Hash] opts the optional parameters
428
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
429
+ # @option opts [Array<String>] :fields A list of fields to include in the response.
430
+ # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
431
+ # @return [MyPermissionsResponse]
432
+ def my_permissions(env_var_header_content_guard_href, opts = {})
433
+ data, _status_code, _headers = my_permissions_with_http_info(env_var_header_content_guard_href, opts)
434
+ data
435
+ end
436
+
437
+ # List user permissions
438
+ # List permissions available to the current user on this object.
439
+ # @param env_var_header_content_guard_href [String]
440
+ # @param [Hash] opts the optional parameters
441
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
442
+ # @option opts [Array<String>] :fields A list of fields to include in the response.
443
+ # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
444
+ # @return [Array<(MyPermissionsResponse, Integer, Hash)>] MyPermissionsResponse data, response status code and response headers
445
+ def my_permissions_with_http_info(env_var_header_content_guard_href, opts = {})
446
+ if @api_client.config.debugging
447
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.my_permissions ...'
448
+ end
449
+ # verify the required parameter 'env_var_header_content_guard_href' is set
450
+ if @api_client.config.client_side_validation && env_var_header_content_guard_href.nil?
451
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard_href' when calling ContentguardsEnvvarHeaderApi.my_permissions"
452
+ end
453
+ # resource path
454
+ local_var_path = '{env_var_header_content_guard_href}my_permissions/'.sub('{' + 'env_var_header_content_guard_href' + '}', CGI.escape(env_var_header_content_guard_href.to_s).gsub('%2F', '/'))
455
+
456
+ # query parameters
457
+ query_params = opts[:query_params] || {}
458
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
459
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?
460
+
461
+ # header parameters
462
+ header_params = opts[:header_params] || {}
463
+ # HTTP header 'Accept' (if needed)
464
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
465
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
466
+
467
+ # form parameters
468
+ form_params = opts[:form_params] || {}
469
+
470
+ # http body (model)
471
+ post_body = opts[:debug_body]
472
+
473
+ # return_type
474
+ return_type = opts[:debug_return_type] || 'MyPermissionsResponse'
475
+
476
+ # auth_names
477
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
478
+
479
+ new_options = opts.merge(
480
+ :operation => :"ContentguardsEnvvarHeaderApi.my_permissions",
481
+ :header_params => header_params,
482
+ :query_params => query_params,
483
+ :form_params => form_params,
484
+ :body => post_body,
485
+ :auth_names => auth_names,
486
+ :return_type => return_type
487
+ )
488
+
489
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
490
+ if @api_client.config.debugging
491
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
492
+ end
493
+ return data, status_code, headers
494
+ end
495
+
496
+ # Update an env var header content guard
497
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
498
+ # @param env_var_header_content_guard_href [String]
499
+ # @param patched_env_var_header_content_guard [PatchedEnvVarHeaderContentGuard]
500
+ # @param [Hash] opts the optional parameters
501
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
502
+ # @return [EnvVarHeaderContentGuardResponse]
503
+ def partial_update(env_var_header_content_guard_href, patched_env_var_header_content_guard, opts = {})
504
+ data, _status_code, _headers = partial_update_with_http_info(env_var_header_content_guard_href, patched_env_var_header_content_guard, opts)
505
+ data
506
+ end
507
+
508
+ # Update an env var header content guard
509
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
510
+ # @param env_var_header_content_guard_href [String]
511
+ # @param patched_env_var_header_content_guard [PatchedEnvVarHeaderContentGuard]
512
+ # @param [Hash] opts the optional parameters
513
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
514
+ # @return [Array<(EnvVarHeaderContentGuardResponse, Integer, Hash)>] EnvVarHeaderContentGuardResponse data, response status code and response headers
515
+ def partial_update_with_http_info(env_var_header_content_guard_href, patched_env_var_header_content_guard, opts = {})
516
+ if @api_client.config.debugging
517
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.partial_update ...'
518
+ end
519
+ # verify the required parameter 'env_var_header_content_guard_href' is set
520
+ if @api_client.config.client_side_validation && env_var_header_content_guard_href.nil?
521
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard_href' when calling ContentguardsEnvvarHeaderApi.partial_update"
522
+ end
523
+ # verify the required parameter 'patched_env_var_header_content_guard' is set
524
+ if @api_client.config.client_side_validation && patched_env_var_header_content_guard.nil?
525
+ fail ArgumentError, "Missing the required parameter 'patched_env_var_header_content_guard' when calling ContentguardsEnvvarHeaderApi.partial_update"
526
+ end
527
+ # resource path
528
+ local_var_path = '{env_var_header_content_guard_href}'.sub('{' + 'env_var_header_content_guard_href' + '}', CGI.escape(env_var_header_content_guard_href.to_s).gsub('%2F', '/'))
529
+
530
+ # query parameters
531
+ query_params = opts[:query_params] || {}
532
+
533
+ # header parameters
534
+ header_params = opts[:header_params] || {}
535
+ # HTTP header 'Accept' (if needed)
536
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
537
+ # HTTP header 'Content-Type'
538
+ content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
539
+ if !content_type.nil?
540
+ header_params['Content-Type'] = content_type
541
+ end
542
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
543
+
544
+ # form parameters
545
+ form_params = opts[:form_params] || {}
546
+
547
+ # http body (model)
548
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patched_env_var_header_content_guard)
549
+
550
+ # return_type
551
+ return_type = opts[:debug_return_type] || 'EnvVarHeaderContentGuardResponse'
552
+
553
+ # auth_names
554
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
555
+
556
+ new_options = opts.merge(
557
+ :operation => :"ContentguardsEnvvarHeaderApi.partial_update",
558
+ :header_params => header_params,
559
+ :query_params => query_params,
560
+ :form_params => form_params,
561
+ :body => post_body,
562
+ :auth_names => auth_names,
563
+ :return_type => return_type
564
+ )
565
+
566
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
567
+ if @api_client.config.debugging
568
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
569
+ end
570
+ return data, status_code, headers
571
+ end
572
+
573
+ # Inspect an env var header content guard
574
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
575
+ # @param env_var_header_content_guard_href [String]
576
+ # @param [Hash] opts the optional parameters
577
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
578
+ # @option opts [Array<String>] :fields A list of fields to include in the response.
579
+ # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
580
+ # @return [EnvVarHeaderContentGuardResponse]
581
+ def read(env_var_header_content_guard_href, opts = {})
582
+ data, _status_code, _headers = read_with_http_info(env_var_header_content_guard_href, opts)
583
+ data
584
+ end
585
+
586
+ # Inspect an env var header content guard
587
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
588
+ # @param env_var_header_content_guard_href [String]
589
+ # @param [Hash] opts the optional parameters
590
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
591
+ # @option opts [Array<String>] :fields A list of fields to include in the response.
592
+ # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
593
+ # @return [Array<(EnvVarHeaderContentGuardResponse, Integer, Hash)>] EnvVarHeaderContentGuardResponse data, response status code and response headers
594
+ def read_with_http_info(env_var_header_content_guard_href, opts = {})
595
+ if @api_client.config.debugging
596
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.read ...'
597
+ end
598
+ # verify the required parameter 'env_var_header_content_guard_href' is set
599
+ if @api_client.config.client_side_validation && env_var_header_content_guard_href.nil?
600
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard_href' when calling ContentguardsEnvvarHeaderApi.read"
601
+ end
602
+ # resource path
603
+ local_var_path = '{env_var_header_content_guard_href}'.sub('{' + 'env_var_header_content_guard_href' + '}', CGI.escape(env_var_header_content_guard_href.to_s).gsub('%2F', '/'))
604
+
605
+ # query parameters
606
+ query_params = opts[:query_params] || {}
607
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
608
+ query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?
609
+
610
+ # header parameters
611
+ header_params = opts[:header_params] || {}
612
+ # HTTP header 'Accept' (if needed)
613
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
614
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
615
+
616
+ # form parameters
617
+ form_params = opts[:form_params] || {}
618
+
619
+ # http body (model)
620
+ post_body = opts[:debug_body]
621
+
622
+ # return_type
623
+ return_type = opts[:debug_return_type] || 'EnvVarHeaderContentGuardResponse'
624
+
625
+ # auth_names
626
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
627
+
628
+ new_options = opts.merge(
629
+ :operation => :"ContentguardsEnvvarHeaderApi.read",
630
+ :header_params => header_params,
631
+ :query_params => query_params,
632
+ :form_params => form_params,
633
+ :body => post_body,
634
+ :auth_names => auth_names,
635
+ :return_type => return_type
636
+ )
637
+
638
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
639
+ if @api_client.config.debugging
640
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
641
+ end
642
+ return data, status_code, headers
643
+ end
644
+
645
+ # Remove a role
646
+ # Remove a role for this object from users/groups.
647
+ # @param env_var_header_content_guard_href [String]
648
+ # @param nested_role [NestedRole]
649
+ # @param [Hash] opts the optional parameters
650
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
651
+ # @return [NestedRoleResponse]
652
+ def remove_role(env_var_header_content_guard_href, nested_role, opts = {})
653
+ data, _status_code, _headers = remove_role_with_http_info(env_var_header_content_guard_href, nested_role, opts)
654
+ data
655
+ end
656
+
657
+ # Remove a role
658
+ # Remove a role for this object from users/groups.
659
+ # @param env_var_header_content_guard_href [String]
660
+ # @param nested_role [NestedRole]
661
+ # @param [Hash] opts the optional parameters
662
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
663
+ # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers
664
+ def remove_role_with_http_info(env_var_header_content_guard_href, nested_role, opts = {})
665
+ if @api_client.config.debugging
666
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.remove_role ...'
667
+ end
668
+ # verify the required parameter 'env_var_header_content_guard_href' is set
669
+ if @api_client.config.client_side_validation && env_var_header_content_guard_href.nil?
670
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard_href' when calling ContentguardsEnvvarHeaderApi.remove_role"
671
+ end
672
+ # verify the required parameter 'nested_role' is set
673
+ if @api_client.config.client_side_validation && nested_role.nil?
674
+ fail ArgumentError, "Missing the required parameter 'nested_role' when calling ContentguardsEnvvarHeaderApi.remove_role"
675
+ end
676
+ # resource path
677
+ local_var_path = '{env_var_header_content_guard_href}remove_role/'.sub('{' + 'env_var_header_content_guard_href' + '}', CGI.escape(env_var_header_content_guard_href.to_s).gsub('%2F', '/'))
678
+
679
+ # query parameters
680
+ query_params = opts[:query_params] || {}
681
+
682
+ # header parameters
683
+ header_params = opts[:header_params] || {}
684
+ # HTTP header 'Accept' (if needed)
685
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
686
+ # HTTP header 'Content-Type'
687
+ content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
688
+ if !content_type.nil?
689
+ header_params['Content-Type'] = content_type
690
+ end
691
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
692
+
693
+ # form parameters
694
+ form_params = opts[:form_params] || {}
695
+
696
+ # http body (model)
697
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(nested_role)
698
+
699
+ # return_type
700
+ return_type = opts[:debug_return_type] || 'NestedRoleResponse'
701
+
702
+ # auth_names
703
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
704
+
705
+ new_options = opts.merge(
706
+ :operation => :"ContentguardsEnvvarHeaderApi.remove_role",
707
+ :header_params => header_params,
708
+ :query_params => query_params,
709
+ :form_params => form_params,
710
+ :body => post_body,
711
+ :auth_names => auth_names,
712
+ :return_type => return_type
713
+ )
714
+
715
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
716
+ if @api_client.config.debugging
717
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
718
+ end
719
+ return data, status_code, headers
720
+ end
721
+
722
+ # Update an env var header content guard
723
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
724
+ # @param env_var_header_content_guard_href [String]
725
+ # @param env_var_header_content_guard [EnvVarHeaderContentGuard]
726
+ # @param [Hash] opts the optional parameters
727
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
728
+ # @return [EnvVarHeaderContentGuardResponse]
729
+ def update(env_var_header_content_guard_href, env_var_header_content_guard, opts = {})
730
+ data, _status_code, _headers = update_with_http_info(env_var_header_content_guard_href, env_var_header_content_guard, opts)
731
+ data
732
+ end
733
+
734
+ # Update an env var header content guard
735
+ # Content guard that validates a Base64-encoded header against a server-side environment variable.
736
+ # @param env_var_header_content_guard_href [String]
737
+ # @param env_var_header_content_guard [EnvVarHeaderContentGuard]
738
+ # @param [Hash] opts the optional parameters
739
+ # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
740
+ # @return [Array<(EnvVarHeaderContentGuardResponse, Integer, Hash)>] EnvVarHeaderContentGuardResponse data, response status code and response headers
741
+ def update_with_http_info(env_var_header_content_guard_href, env_var_header_content_guard, opts = {})
742
+ if @api_client.config.debugging
743
+ @api_client.config.logger.debug 'Calling API: ContentguardsEnvvarHeaderApi.update ...'
744
+ end
745
+ # verify the required parameter 'env_var_header_content_guard_href' is set
746
+ if @api_client.config.client_side_validation && env_var_header_content_guard_href.nil?
747
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard_href' when calling ContentguardsEnvvarHeaderApi.update"
748
+ end
749
+ # verify the required parameter 'env_var_header_content_guard' is set
750
+ if @api_client.config.client_side_validation && env_var_header_content_guard.nil?
751
+ fail ArgumentError, "Missing the required parameter 'env_var_header_content_guard' when calling ContentguardsEnvvarHeaderApi.update"
752
+ end
753
+ # resource path
754
+ local_var_path = '{env_var_header_content_guard_href}'.sub('{' + 'env_var_header_content_guard_href' + '}', CGI.escape(env_var_header_content_guard_href.to_s).gsub('%2F', '/'))
755
+
756
+ # query parameters
757
+ query_params = opts[:query_params] || {}
758
+
759
+ # header parameters
760
+ header_params = opts[:header_params] || {}
761
+ # HTTP header 'Accept' (if needed)
762
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
763
+ # HTTP header 'Content-Type'
764
+ content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
765
+ if !content_type.nil?
766
+ header_params['Content-Type'] = content_type
767
+ end
768
+ header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
769
+
770
+ # form parameters
771
+ form_params = opts[:form_params] || {}
772
+
773
+ # http body (model)
774
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(env_var_header_content_guard)
775
+
776
+ # return_type
777
+ return_type = opts[:debug_return_type] || 'EnvVarHeaderContentGuardResponse'
778
+
779
+ # auth_names
780
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
781
+
782
+ new_options = opts.merge(
783
+ :operation => :"ContentguardsEnvvarHeaderApi.update",
784
+ :header_params => header_params,
785
+ :query_params => query_params,
786
+ :form_params => form_params,
787
+ :body => post_body,
788
+ :auth_names => auth_names,
789
+ :return_type => return_type
790
+ )
791
+
792
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
793
+ if @api_client.config.debugging
794
+ @api_client.config.logger.debug "API called: ContentguardsEnvvarHeaderApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
795
+ end
796
+ return data, status_code, headers
797
+ end
798
+ end
799
+ end