rokka_client_codegen 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/LICENSE +21 -0
  4. data/README.md +123 -0
  5. data/Rakefile +8 -0
  6. data/config.json +5 -0
  7. data/docs/AdminApi.md +398 -0
  8. data/docs/ListSourceImagesResponse.md +11 -0
  9. data/docs/ListStacksResponse.md +8 -0
  10. data/docs/Membership.md +11 -0
  11. data/docs/Organization.md +14 -0
  12. data/docs/OrganizationDefinition.md +10 -0
  13. data/docs/OrganizationOptions.md +10 -0
  14. data/docs/Role.md +8 -0
  15. data/docs/SourceImage.md +24 -0
  16. data/docs/SourceimagesApi.md +1032 -0
  17. data/docs/Stack.md +14 -0
  18. data/docs/StackDefinition.md +10 -0
  19. data/docs/StackExpression.md +9 -0
  20. data/docs/StackExpressionOverrides.md +8 -0
  21. data/docs/StackOperation.md +9 -0
  22. data/docs/StackOperationDescription.md +11 -0
  23. data/docs/StackOptions.md +8 -0
  24. data/docs/StacksApi.md +329 -0
  25. data/docs/User.md +11 -0
  26. data/docs/UserDefinition.md +9 -0
  27. data/examples/createstack.rb +33 -0
  28. data/examples/liststacks.rb +19 -0
  29. data/examples/setsubjectarea.rb +37 -0
  30. data/examples/uploadimage.rb +28 -0
  31. data/generate.sh +3 -0
  32. data/git_push.sh +55 -0
  33. data/lib/rokka_client_codegen.rb +59 -0
  34. data/lib/rokka_client_codegen/api/admin_api.rb +439 -0
  35. data/lib/rokka_client_codegen/api/sourceimages_api.rb +1225 -0
  36. data/lib/rokka_client_codegen/api/stacks_api.rb +371 -0
  37. data/lib/rokka_client_codegen/api_client.rb +389 -0
  38. data/lib/rokka_client_codegen/api_error.rb +38 -0
  39. data/lib/rokka_client_codegen/configuration.rb +209 -0
  40. data/lib/rokka_client_codegen/models/list_source_images_response.rb +217 -0
  41. data/lib/rokka_client_codegen/models/list_stacks_response.rb +190 -0
  42. data/lib/rokka_client_codegen/models/membership.rb +215 -0
  43. data/lib/rokka_client_codegen/models/organization.rb +264 -0
  44. data/lib/rokka_client_codegen/models/organization_definition.rb +211 -0
  45. data/lib/rokka_client_codegen/models/organization_options.rb +208 -0
  46. data/lib/rokka_client_codegen/models/role.rb +194 -0
  47. data/lib/rokka_client_codegen/models/source_image.rb +333 -0
  48. data/lib/rokka_client_codegen/models/stack.rb +246 -0
  49. data/lib/rokka_client_codegen/models/stack_definition.rb +217 -0
  50. data/lib/rokka_client_codegen/models/stack_expression.rb +207 -0
  51. data/lib/rokka_client_codegen/models/stack_expression_overrides.rb +188 -0
  52. data/lib/rokka_client_codegen/models/stack_operation.rb +203 -0
  53. data/lib/rokka_client_codegen/models/stack_operation_description.rb +231 -0
  54. data/lib/rokka_client_codegen/models/stack_options.rb +193 -0
  55. data/lib/rokka_client_codegen/models/user.rb +216 -0
  56. data/lib/rokka_client_codegen/models/user_definition.rb +204 -0
  57. data/lib/rokka_client_codegen/version.rb +15 -0
  58. data/patches/README.patch +59 -0
  59. data/patches/sourceimage_hash_long_hash.patch +62 -0
  60. data/rokka_client_codegen.gemspec +45 -0
  61. data/spec/api/admin_api_spec.rb +125 -0
  62. data/spec/api/sourceimages_api_spec.rb +274 -0
  63. data/spec/api/stacks_api_spec.rb +110 -0
  64. data/spec/api_client_spec.rb +226 -0
  65. data/spec/configuration_spec.rb +42 -0
  66. data/spec/models/list_source_images_response_spec.rb +60 -0
  67. data/spec/models/list_stacks_response_spec.rb +42 -0
  68. data/spec/models/membership_spec.rb +60 -0
  69. data/spec/models/organization_definition_spec.rb +54 -0
  70. data/spec/models/organization_options_spec.rb +54 -0
  71. data/spec/models/organization_spec.rb +78 -0
  72. data/spec/models/role_spec.rb +42 -0
  73. data/spec/models/source_image_spec.rb +138 -0
  74. data/spec/models/stack_definition_spec.rb +54 -0
  75. data/spec/models/stack_expression_overrides_spec.rb +42 -0
  76. data/spec/models/stack_expression_spec.rb +48 -0
  77. data/spec/models/stack_operation_description_spec.rb +60 -0
  78. data/spec/models/stack_operation_spec.rb +48 -0
  79. data/spec/models/stack_options_spec.rb +42 -0
  80. data/spec/models/stack_spec.rb +78 -0
  81. data/spec/models/user_definition_spec.rb +48 -0
  82. data/spec/models/user_spec.rb +60 -0
  83. data/spec/spec_helper.rb +111 -0
  84. metadata +330 -0
@@ -0,0 +1,11 @@
1
+ # RokkaClientCodegen::ListSourceImagesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **total** | **Integer** | | [optional]
7
+ **items** | [**Array<SourceImage>**](SourceImage.md) | | [optional]
8
+ **cursor** | **String** | | [optional]
9
+ **links** | **Object** | | [optional]
10
+
11
+
@@ -0,0 +1,8 @@
1
+ # RokkaClientCodegen::ListStacksResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **items** | [**Array<Stack>**](Stack.md) | | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # RokkaClientCodegen::Membership
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **user_id** | **String** | | [optional]
7
+ **organization_id** | **String** | | [optional]
8
+ **role** | **String** | | [optional]
9
+ **active** | **BOOLEAN** | | [optional]
10
+
11
+
@@ -0,0 +1,14 @@
1
+ # RokkaClientCodegen::Organization
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | |
7
+ **display_name** | **String** | |
8
+ **name** | **String** | Web safe, using in routes and api calls |
9
+ **billing_email** | **String** | |
10
+ **options** | [**OrganizationOptions**](OrganizationOptions.md) | | [optional]
11
+ **created** | **DateTime** | | [optional]
12
+ **master_organization** | **String** | Billing will agregate all sub organizations and bill the master organization. | [optional]
13
+
14
+
@@ -0,0 +1,10 @@
1
+ # RokkaClientCodegen::OrganizationDefinition
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **billing_email** | **String** | |
7
+ **display_name** | **String** | | [optional]
8
+ **master_organization** | **String** | | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # RokkaClientCodegen::OrganizationOptions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **remote_basepath** | **String** | | [optional]
7
+ **remote_fullurl_allow** | **BOOLEAN** | | [optional]
8
+ **remote_fullurl_whitelist** | **Array<String>** | | [optional]
9
+
10
+
data/docs/Role.md ADDED
@@ -0,0 +1,8 @@
1
+ # RokkaClientCodegen::Role
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **role** | **String** | One of admin, read, write or upload |
7
+
8
+
@@ -0,0 +1,24 @@
1
+ # RokkaClientCodegen::SourceImage
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **long_hash** | **String** | | [optional]
7
+ **short_hash** | **String** | | [optional]
8
+ **binary_hash** | **String** | | [optional]
9
+ **created** | **DateTime** | | [optional]
10
+ **name** | **String** | | [optional]
11
+ **mimetype** | **String** | | [optional]
12
+ **format** | **String** | | [optional]
13
+ **size** | **Integer** | | [optional]
14
+ **width** | **Integer** | | [optional]
15
+ **height** | **Integer** | | [optional]
16
+ **organization** | **String** | | [optional]
17
+ **link** | **String** | | [optional]
18
+ **dynamic_metadata** | **Object** | | [optional]
19
+ **static_metadata** | **Object** | | [optional]
20
+ **user_metadata** | **Object** | | [optional]
21
+ **deleted** | **BOOLEAN** | Null as default (means false) | [optional]
22
+ **deleted_date** | **DateTime** | | [optional]
23
+
24
+
@@ -0,0 +1,1032 @@
1
+ # RokkaClientCodegen::SourceimagesApi
2
+
3
+ All URIs are relative to *https://api.rokka.io*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**copy_source_image**](SourceimagesApi.md#copy_source_image) | **POST** /sourceimages/{organization}/{hash}/copy | Copy a single source image to another org.
8
+ [**create_source_image**](SourceimagesApi.md#create_source_image) | **POST** /sourceimages/{organization} | Upload new source images.
9
+ [**create_source_image_meta_dynamic_with_name**](SourceimagesApi.md#create_source_image_meta_dynamic_with_name) | **PUT** /sourceimages/{organization}/{hash}/meta/dynamic/{metaName} | Adds or updates a specific dynamic meta data for an image.
10
+ [**create_source_image_meta_user**](SourceimagesApi.md#create_source_image_meta_user) | **PUT** /sourceimages/{organization}/{hash}/meta/user | Replace the image meta data with new information.
11
+ [**create_source_image_meta_user_wth_name**](SourceimagesApi.md#create_source_image_meta_user_wth_name) | **PUT** /sourceimages/{organization}/{hash}/meta/user/{metaName} | Adds or updates one user meta data field for an image.
12
+ [**delete_source_image**](SourceimagesApi.md#delete_source_image) | **DELETE** /sourceimages/{organization}/{hash} | Delete a single source image.
13
+ [**delete_source_image_meta_dynamic_with_name**](SourceimagesApi.md#delete_source_image_meta_dynamic_with_name) | **DELETE** /sourceimages/{organization}/{hash}/meta/dynamic/{metaName} | Deletes a specific dynamic meta data.
14
+ [**delete_source_image_meta_user**](SourceimagesApi.md#delete_source_image_meta_user) | **DELETE** /sourceimages/{organization}/{hash}/meta/user | Deletes all user meta data.
15
+ [**delete_source_image_meta_user_with_name**](SourceimagesApi.md#delete_source_image_meta_user_with_name) | **DELETE** /sourceimages/{organization}/{hash}/meta/user/{metaName} | Deletes user meta data for a specified field.
16
+ [**download_source_image**](SourceimagesApi.md#download_source_image) | **GET** /sourceimages/{organization}/{hash}/download | Download original source image binary.
17
+ [**get_source_image**](SourceimagesApi.md#get_source_image) | **GET** /sourceimages/{organization}/{hash} | Get information about a source image.
18
+ [**get_source_image_meta_user**](SourceimagesApi.md#get_source_image_meta_user) | **GET** /sourceimages/{organization}/{hash}/meta/user | Get all user meta data.
19
+ [**get_source_image_meta_user_with_name**](SourceimagesApi.md#get_source_image_meta_user_with_name) | **GET** /sourceimages/{organization}/{hash}/meta/user/{metaName} | Get user meta for a specific field.
20
+ [**list_source_images**](SourceimagesApi.md#list_source_images) | **GET** /sourceimages/{organization} | Get all images of an organization, with paging.
21
+ [**list_source_images_by_binary_hash**](SourceimagesApi.md#list_source_images_by_binary_hash) | **GET** /sourceimages/{organization}/binaryhash/{binaryHash} | Get all images in this organization that match a binaryhash.
22
+ [**patch_source_image_meta_user**](SourceimagesApi.md#patch_source_image_meta_user) | **PATCH** /sourceimages/{organization}/{hash}/meta/user | Update the specified meta data fields for an image.
23
+ [**restore_source_image**](SourceimagesApi.md#restore_source_image) | **POST** /sourceimages/{organization}/{hash}/restore | Restore source image including previously set metadata.
24
+
25
+
26
+ # **copy_source_image**
27
+ > copy_source_image(destination, organization, hash, opts)
28
+
29
+ Copy a single source image to another org.
30
+
31
+ The metadata is copied as well. After copying, changes to either image metadata are not reflected in the other image metadata. This is a proxy method for COPY on /sourceimages/{organization}/{hash}. It allows to copy images with a POST request, to work around restrictive firewalls and allows to produce a swagger specification for this operation.
32
+
33
+ ### Example
34
+ ```ruby
35
+ # load the gem
36
+ require 'rokka_client_codegen'
37
+ # setup authorization
38
+ RokkaClientCodegen.configure do |config|
39
+ # Configure API key authorization: ApiKeyAuth
40
+ config.api_key['api-key'] = 'YOUR API KEY'
41
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
42
+ #config.api_key_prefix['api-key'] = 'Bearer'
43
+ end
44
+
45
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
46
+
47
+ destination = "destination_example" # String | The destination organization
48
+
49
+ organization = "organization_example" # String |
50
+
51
+ hash = "hash_example" # String |
52
+
53
+ opts = {
54
+ overwrite: "overwrite_example" # String | If set to 'F', existing images won't be overwritten.
55
+ }
56
+
57
+ begin
58
+ #Copy a single source image to another org.
59
+ api_instance.copy_source_image(destination, organization, hash, opts)
60
+ rescue RokkaClientCodegen::ApiError => e
61
+ puts "Exception when calling SourceimagesApi->copy_source_image: #{e}"
62
+ end
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ Name | Type | Description | Notes
68
+ ------------- | ------------- | ------------- | -------------
69
+ **destination** | **String**| The destination organization |
70
+ **organization** | **String**| |
71
+ **hash** | **String**| |
72
+ **overwrite** | **String**| If set to 'F', existing images won't be overwritten. | [optional]
73
+
74
+ ### Return type
75
+
76
+ nil (empty response body)
77
+
78
+ ### Authorization
79
+
80
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: Not defined
85
+ - **Accept**: Not defined
86
+
87
+
88
+
89
+ # **create_source_image**
90
+ > ListSourceImagesResponse create_source_image(filedata, organization, opts)
91
+
92
+ Upload new source images.
93
+
94
+ The request is form data for the uploaded files and arrays of metadata. Files and metadata are matched based on their order in the request. Note that this call allows to upload multiple images, but the swagger UI does not support this.
95
+
96
+ ### Example
97
+ ```ruby
98
+ # load the gem
99
+ require 'rokka_client_codegen'
100
+ # setup authorization
101
+ RokkaClientCodegen.configure do |config|
102
+ # Configure API key authorization: ApiKeyAuth
103
+ config.api_key['api-key'] = 'YOUR API KEY'
104
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
105
+ #config.api_key_prefix['api-key'] = 'Bearer'
106
+ end
107
+
108
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
109
+
110
+ filedata = File.new("/path/to/file.txt") # File | The binary images
111
+
112
+ organization = "organization_example" # String |
113
+
114
+ opts = {
115
+ meta_dynamic: "meta_dynamic_example", # String | JSON metadata about the image, e.g. subject area. See https://rokka.io/documentation/references/dynamic-metadata.html
116
+ meta_user: "meta_user_example" # String | User specific JSON metadata that can be used when searching source images. See https://rokka.io/documentation/references/user-metadata.html
117
+ }
118
+
119
+ begin
120
+ #Upload new source images.
121
+ result = api_instance.create_source_image(filedata, organization, opts)
122
+ p result
123
+ rescue RokkaClientCodegen::ApiError => e
124
+ puts "Exception when calling SourceimagesApi->create_source_image: #{e}"
125
+ end
126
+ ```
127
+
128
+ ### Parameters
129
+
130
+ Name | Type | Description | Notes
131
+ ------------- | ------------- | ------------- | -------------
132
+ **filedata** | **File**| The binary images |
133
+ **organization** | **String**| |
134
+ **meta_dynamic** | **String**| JSON metadata about the image, e.g. subject area. See https://rokka.io/documentation/references/dynamic-metadata.html | [optional]
135
+ **meta_user** | **String**| User specific JSON metadata that can be used when searching source images. See https://rokka.io/documentation/references/user-metadata.html | [optional]
136
+
137
+ ### Return type
138
+
139
+ [**ListSourceImagesResponse**](ListSourceImagesResponse.md)
140
+
141
+ ### Authorization
142
+
143
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
144
+
145
+ ### HTTP request headers
146
+
147
+ - **Content-Type**: multipart/form-data
148
+ - **Accept**: Not defined
149
+
150
+
151
+
152
+ # **create_source_image_meta_dynamic_with_name**
153
+ > SourceImage create_source_image_meta_dynamic_with_name(meta_dynamic_definition, organization, hash, meta_name, opts)
154
+
155
+ Adds or updates a specific dynamic meta data for an image.
156
+
157
+ This changes the hash of the image. The response provides the new location of the image in the Location header.
158
+
159
+ ### Example
160
+ ```ruby
161
+ # load the gem
162
+ require 'rokka_client_codegen'
163
+ # setup authorization
164
+ RokkaClientCodegen.configure do |config|
165
+ # Configure API key authorization: ApiKeyAuth
166
+ config.api_key['api-key'] = 'YOUR API KEY'
167
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
168
+ #config.api_key_prefix['api-key'] = 'Bearer'
169
+ end
170
+
171
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
172
+
173
+ meta_dynamic_definition = nil # Object | Dynamic Meta Data definition
174
+
175
+ organization = "organization_example" # String |
176
+
177
+ hash = "hash_example" # String |
178
+
179
+ meta_name = "meta_name_example" # String |
180
+
181
+ opts = {
182
+ delete_previous: false # BOOLEAN | If the image with the original hash should be deleted
183
+ }
184
+
185
+ begin
186
+ #Adds or updates a specific dynamic meta data for an image.
187
+ result = api_instance.create_source_image_meta_dynamic_with_name(meta_dynamic_definition, organization, hash, meta_name, opts)
188
+ p result
189
+ rescue RokkaClientCodegen::ApiError => e
190
+ puts "Exception when calling SourceimagesApi->create_source_image_meta_dynamic_with_name: #{e}"
191
+ end
192
+ ```
193
+
194
+ ### Parameters
195
+
196
+ Name | Type | Description | Notes
197
+ ------------- | ------------- | ------------- | -------------
198
+ **meta_dynamic_definition** | **Object**| Dynamic Meta Data definition |
199
+ **organization** | **String**| |
200
+ **hash** | **String**| |
201
+ **meta_name** | **String**| |
202
+ **delete_previous** | **BOOLEAN**| If the image with the original hash should be deleted | [optional] [default to false]
203
+
204
+ ### Return type
205
+
206
+ [**SourceImage**](SourceImage.md)
207
+
208
+ ### Authorization
209
+
210
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
211
+
212
+ ### HTTP request headers
213
+
214
+ - **Content-Type**: Not defined
215
+ - **Accept**: Not defined
216
+
217
+
218
+
219
+ # **create_source_image_meta_user**
220
+ > create_source_image_meta_user(user_meta_data, organization, hash)
221
+
222
+ Replace the image meta data with new information.
223
+
224
+ All existing meta data for the image is removed and then the new meta data is added. User metadata is used for searching images that have been stored in rokka. It will never lead to differences in the output image and thus changing it never leads to a new hash.
225
+
226
+ ### Example
227
+ ```ruby
228
+ # load the gem
229
+ require 'rokka_client_codegen'
230
+ # setup authorization
231
+ RokkaClientCodegen.configure do |config|
232
+ # Configure API key authorization: ApiKeyAuth
233
+ config.api_key['api-key'] = 'YOUR API KEY'
234
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
235
+ #config.api_key_prefix['api-key'] = 'Bearer'
236
+ end
237
+
238
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
239
+
240
+ user_meta_data = nil # Object | User Meta Data as a json hashmap
241
+
242
+ organization = "organization_example" # String |
243
+
244
+ hash = "hash_example" # String |
245
+
246
+
247
+ begin
248
+ #Replace the image meta data with new information.
249
+ api_instance.create_source_image_meta_user(user_meta_data, organization, hash)
250
+ rescue RokkaClientCodegen::ApiError => e
251
+ puts "Exception when calling SourceimagesApi->create_source_image_meta_user: #{e}"
252
+ end
253
+ ```
254
+
255
+ ### Parameters
256
+
257
+ Name | Type | Description | Notes
258
+ ------------- | ------------- | ------------- | -------------
259
+ **user_meta_data** | **Object**| User Meta Data as a json hashmap |
260
+ **organization** | **String**| |
261
+ **hash** | **String**| |
262
+
263
+ ### Return type
264
+
265
+ nil (empty response body)
266
+
267
+ ### Authorization
268
+
269
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
270
+
271
+ ### HTTP request headers
272
+
273
+ - **Content-Type**: Not defined
274
+ - **Accept**: Not defined
275
+
276
+
277
+
278
+ # **create_source_image_meta_user_wth_name**
279
+ > create_source_image_meta_user_wth_name(user_meta_data_single_field, organization, hash, meta_name)
280
+
281
+ Adds or updates one user meta data field for an image.
282
+
283
+ User metadata is used for searching images that have been stored in rokka. It will never lead to differences in the output image and thus changing it never leads to a new hash.
284
+
285
+ ### Example
286
+ ```ruby
287
+ # load the gem
288
+ require 'rokka_client_codegen'
289
+ # setup authorization
290
+ RokkaClientCodegen.configure do |config|
291
+ # Configure API key authorization: ApiKeyAuth
292
+ config.api_key['api-key'] = 'YOUR API KEY'
293
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
294
+ #config.api_key_prefix['api-key'] = 'Bearer'
295
+ end
296
+
297
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
298
+
299
+ user_meta_data_single_field = "user_meta_data_single_field_example" # String | User Meta Data for a single field in json format
300
+
301
+ organization = "organization_example" # String |
302
+
303
+ hash = "hash_example" # String |
304
+
305
+ meta_name = "meta_name_example" # String |
306
+
307
+
308
+ begin
309
+ #Adds or updates one user meta data field for an image.
310
+ api_instance.create_source_image_meta_user_wth_name(user_meta_data_single_field, organization, hash, meta_name)
311
+ rescue RokkaClientCodegen::ApiError => e
312
+ puts "Exception when calling SourceimagesApi->create_source_image_meta_user_wth_name: #{e}"
313
+ end
314
+ ```
315
+
316
+ ### Parameters
317
+
318
+ Name | Type | Description | Notes
319
+ ------------- | ------------- | ------------- | -------------
320
+ **user_meta_data_single_field** | **String**| User Meta Data for a single field in json format |
321
+ **organization** | **String**| |
322
+ **hash** | **String**| |
323
+ **meta_name** | **String**| |
324
+
325
+ ### Return type
326
+
327
+ nil (empty response body)
328
+
329
+ ### Authorization
330
+
331
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
332
+
333
+ ### HTTP request headers
334
+
335
+ - **Content-Type**: Not defined
336
+ - **Accept**: Not defined
337
+
338
+
339
+
340
+ # **delete_source_image**
341
+ > delete_source_image(organization, hash)
342
+
343
+ Delete a single source image.
344
+
345
+ ### Example
346
+ ```ruby
347
+ # load the gem
348
+ require 'rokka_client_codegen'
349
+ # setup authorization
350
+ RokkaClientCodegen.configure do |config|
351
+ # Configure API key authorization: ApiKeyAuth
352
+ config.api_key['api-key'] = 'YOUR API KEY'
353
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
354
+ #config.api_key_prefix['api-key'] = 'Bearer'
355
+ end
356
+
357
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
358
+
359
+ organization = "organization_example" # String |
360
+
361
+ hash = "hash_example" # String |
362
+
363
+
364
+ begin
365
+ #Delete a single source image.
366
+ api_instance.delete_source_image(organization, hash)
367
+ rescue RokkaClientCodegen::ApiError => e
368
+ puts "Exception when calling SourceimagesApi->delete_source_image: #{e}"
369
+ end
370
+ ```
371
+
372
+ ### Parameters
373
+
374
+ Name | Type | Description | Notes
375
+ ------------- | ------------- | ------------- | -------------
376
+ **organization** | **String**| |
377
+ **hash** | **String**| |
378
+
379
+ ### Return type
380
+
381
+ nil (empty response body)
382
+
383
+ ### Authorization
384
+
385
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
386
+
387
+ ### HTTP request headers
388
+
389
+ - **Content-Type**: Not defined
390
+ - **Accept**: Not defined
391
+
392
+
393
+
394
+ # **delete_source_image_meta_dynamic_with_name**
395
+ > SourceImage delete_source_image_meta_dynamic_with_name(organization, hash, meta_name, opts)
396
+
397
+ Deletes a specific dynamic meta data.
398
+
399
+ This changes the hash of the image. The response provides the new location of the image in the Location header.
400
+
401
+ ### Example
402
+ ```ruby
403
+ # load the gem
404
+ require 'rokka_client_codegen'
405
+ # setup authorization
406
+ RokkaClientCodegen.configure do |config|
407
+ # Configure API key authorization: ApiKeyAuth
408
+ config.api_key['api-key'] = 'YOUR API KEY'
409
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
410
+ #config.api_key_prefix['api-key'] = 'Bearer'
411
+ end
412
+
413
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
414
+
415
+ organization = "organization_example" # String |
416
+
417
+ hash = "hash_example" # String |
418
+
419
+ meta_name = "meta_name_example" # String |
420
+
421
+ opts = {
422
+ delete_previous: false # BOOLEAN | If the image with the original hash should be deleted
423
+ }
424
+
425
+ begin
426
+ #Deletes a specific dynamic meta data.
427
+ result = api_instance.delete_source_image_meta_dynamic_with_name(organization, hash, meta_name, opts)
428
+ p result
429
+ rescue RokkaClientCodegen::ApiError => e
430
+ puts "Exception when calling SourceimagesApi->delete_source_image_meta_dynamic_with_name: #{e}"
431
+ end
432
+ ```
433
+
434
+ ### Parameters
435
+
436
+ Name | Type | Description | Notes
437
+ ------------- | ------------- | ------------- | -------------
438
+ **organization** | **String**| |
439
+ **hash** | **String**| |
440
+ **meta_name** | **String**| |
441
+ **delete_previous** | **BOOLEAN**| If the image with the original hash should be deleted | [optional] [default to false]
442
+
443
+ ### Return type
444
+
445
+ [**SourceImage**](SourceImage.md)
446
+
447
+ ### Authorization
448
+
449
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
450
+
451
+ ### HTTP request headers
452
+
453
+ - **Content-Type**: Not defined
454
+ - **Accept**: Not defined
455
+
456
+
457
+
458
+ # **delete_source_image_meta_user**
459
+ > delete_source_image_meta_user(organization, hash)
460
+
461
+ Deletes all user meta data.
462
+
463
+ User metadata is used for searching images that have been stored in rokka. It will never lead to differences in the output image and thus changing it never leads to a new hash.
464
+
465
+ ### Example
466
+ ```ruby
467
+ # load the gem
468
+ require 'rokka_client_codegen'
469
+ # setup authorization
470
+ RokkaClientCodegen.configure do |config|
471
+ # Configure API key authorization: ApiKeyAuth
472
+ config.api_key['api-key'] = 'YOUR API KEY'
473
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
474
+ #config.api_key_prefix['api-key'] = 'Bearer'
475
+ end
476
+
477
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
478
+
479
+ organization = "organization_example" # String |
480
+
481
+ hash = "hash_example" # String |
482
+
483
+
484
+ begin
485
+ #Deletes all user meta data.
486
+ api_instance.delete_source_image_meta_user(organization, hash)
487
+ rescue RokkaClientCodegen::ApiError => e
488
+ puts "Exception when calling SourceimagesApi->delete_source_image_meta_user: #{e}"
489
+ end
490
+ ```
491
+
492
+ ### Parameters
493
+
494
+ Name | Type | Description | Notes
495
+ ------------- | ------------- | ------------- | -------------
496
+ **organization** | **String**| |
497
+ **hash** | **String**| |
498
+
499
+ ### Return type
500
+
501
+ nil (empty response body)
502
+
503
+ ### Authorization
504
+
505
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
506
+
507
+ ### HTTP request headers
508
+
509
+ - **Content-Type**: Not defined
510
+ - **Accept**: Not defined
511
+
512
+
513
+
514
+ # **delete_source_image_meta_user_with_name**
515
+ > delete_source_image_meta_user_with_name(organization, hash, meta_name)
516
+
517
+ Deletes user meta data for a specified field.
518
+
519
+ User metadata is used for searching images that have been stored in rokka. It will never lead to differences in the output image and thus changing it never leads to a new hash.
520
+
521
+ ### Example
522
+ ```ruby
523
+ # load the gem
524
+ require 'rokka_client_codegen'
525
+ # setup authorization
526
+ RokkaClientCodegen.configure do |config|
527
+ # Configure API key authorization: ApiKeyAuth
528
+ config.api_key['api-key'] = 'YOUR API KEY'
529
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
530
+ #config.api_key_prefix['api-key'] = 'Bearer'
531
+ end
532
+
533
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
534
+
535
+ organization = "organization_example" # String |
536
+
537
+ hash = "hash_example" # String |
538
+
539
+ meta_name = "meta_name_example" # String |
540
+
541
+
542
+ begin
543
+ #Deletes user meta data for a specified field.
544
+ api_instance.delete_source_image_meta_user_with_name(organization, hash, meta_name)
545
+ rescue RokkaClientCodegen::ApiError => e
546
+ puts "Exception when calling SourceimagesApi->delete_source_image_meta_user_with_name: #{e}"
547
+ end
548
+ ```
549
+
550
+ ### Parameters
551
+
552
+ Name | Type | Description | Notes
553
+ ------------- | ------------- | ------------- | -------------
554
+ **organization** | **String**| |
555
+ **hash** | **String**| |
556
+ **meta_name** | **String**| |
557
+
558
+ ### Return type
559
+
560
+ nil (empty response body)
561
+
562
+ ### Authorization
563
+
564
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
565
+
566
+ ### HTTP request headers
567
+
568
+ - **Content-Type**: Not defined
569
+ - **Accept**: Not defined
570
+
571
+
572
+
573
+ # **download_source_image**
574
+ > File download_source_image(organization, hash)
575
+
576
+ Download original source image binary.
577
+
578
+ ### Example
579
+ ```ruby
580
+ # load the gem
581
+ require 'rokka_client_codegen'
582
+ # setup authorization
583
+ RokkaClientCodegen.configure do |config|
584
+ # Configure API key authorization: ApiKeyAuth
585
+ config.api_key['api-key'] = 'YOUR API KEY'
586
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
587
+ #config.api_key_prefix['api-key'] = 'Bearer'
588
+ end
589
+
590
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
591
+
592
+ organization = "organization_example" # String |
593
+
594
+ hash = "hash_example" # String |
595
+
596
+
597
+ begin
598
+ #Download original source image binary.
599
+ result = api_instance.download_source_image(organization, hash)
600
+ p result
601
+ rescue RokkaClientCodegen::ApiError => e
602
+ puts "Exception when calling SourceimagesApi->download_source_image: #{e}"
603
+ end
604
+ ```
605
+
606
+ ### Parameters
607
+
608
+ Name | Type | Description | Notes
609
+ ------------- | ------------- | ------------- | -------------
610
+ **organization** | **String**| |
611
+ **hash** | **String**| |
612
+
613
+ ### Return type
614
+
615
+ **File**
616
+
617
+ ### Authorization
618
+
619
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
620
+
621
+ ### HTTP request headers
622
+
623
+ - **Content-Type**: Not defined
624
+ - **Accept**: Not defined
625
+
626
+
627
+
628
+ # **get_source_image**
629
+ > SourceImage get_source_image(organization, hash)
630
+
631
+ Get information about a source image.
632
+
633
+ ### Example
634
+ ```ruby
635
+ # load the gem
636
+ require 'rokka_client_codegen'
637
+ # setup authorization
638
+ RokkaClientCodegen.configure do |config|
639
+ # Configure API key authorization: ApiKeyAuth
640
+ config.api_key['api-key'] = 'YOUR API KEY'
641
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
642
+ #config.api_key_prefix['api-key'] = 'Bearer'
643
+ end
644
+
645
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
646
+
647
+ organization = "organization_example" # String |
648
+
649
+ hash = "hash_example" # String |
650
+
651
+
652
+ begin
653
+ #Get information about a source image.
654
+ result = api_instance.get_source_image(organization, hash)
655
+ p result
656
+ rescue RokkaClientCodegen::ApiError => e
657
+ puts "Exception when calling SourceimagesApi->get_source_image: #{e}"
658
+ end
659
+ ```
660
+
661
+ ### Parameters
662
+
663
+ Name | Type | Description | Notes
664
+ ------------- | ------------- | ------------- | -------------
665
+ **organization** | **String**| |
666
+ **hash** | **String**| |
667
+
668
+ ### Return type
669
+
670
+ [**SourceImage**](SourceImage.md)
671
+
672
+ ### Authorization
673
+
674
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
675
+
676
+ ### HTTP request headers
677
+
678
+ - **Content-Type**: Not defined
679
+ - **Accept**: Not defined
680
+
681
+
682
+
683
+ # **get_source_image_meta_user**
684
+ > Object get_source_image_meta_user(organization, hash)
685
+
686
+ Get all user meta data.
687
+
688
+ ### Example
689
+ ```ruby
690
+ # load the gem
691
+ require 'rokka_client_codegen'
692
+ # setup authorization
693
+ RokkaClientCodegen.configure do |config|
694
+ # Configure API key authorization: ApiKeyAuth
695
+ config.api_key['api-key'] = 'YOUR API KEY'
696
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
697
+ #config.api_key_prefix['api-key'] = 'Bearer'
698
+ end
699
+
700
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
701
+
702
+ organization = "organization_example" # String |
703
+
704
+ hash = "hash_example" # String |
705
+
706
+
707
+ begin
708
+ #Get all user meta data.
709
+ result = api_instance.get_source_image_meta_user(organization, hash)
710
+ p result
711
+ rescue RokkaClientCodegen::ApiError => e
712
+ puts "Exception when calling SourceimagesApi->get_source_image_meta_user: #{e}"
713
+ end
714
+ ```
715
+
716
+ ### Parameters
717
+
718
+ Name | Type | Description | Notes
719
+ ------------- | ------------- | ------------- | -------------
720
+ **organization** | **String**| |
721
+ **hash** | **String**| |
722
+
723
+ ### Return type
724
+
725
+ **Object**
726
+
727
+ ### Authorization
728
+
729
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
730
+
731
+ ### HTTP request headers
732
+
733
+ - **Content-Type**: Not defined
734
+ - **Accept**: Not defined
735
+
736
+
737
+
738
+ # **get_source_image_meta_user_with_name**
739
+ > String get_source_image_meta_user_with_name(organization, hash, meta_name)
740
+
741
+ Get user meta for a specific field.
742
+
743
+ ### Example
744
+ ```ruby
745
+ # load the gem
746
+ require 'rokka_client_codegen'
747
+ # setup authorization
748
+ RokkaClientCodegen.configure do |config|
749
+ # Configure API key authorization: ApiKeyAuth
750
+ config.api_key['api-key'] = 'YOUR API KEY'
751
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
752
+ #config.api_key_prefix['api-key'] = 'Bearer'
753
+ end
754
+
755
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
756
+
757
+ organization = "organization_example" # String |
758
+
759
+ hash = "hash_example" # String |
760
+
761
+ meta_name = "meta_name_example" # String |
762
+
763
+
764
+ begin
765
+ #Get user meta for a specific field.
766
+ result = api_instance.get_source_image_meta_user_with_name(organization, hash, meta_name)
767
+ p result
768
+ rescue RokkaClientCodegen::ApiError => e
769
+ puts "Exception when calling SourceimagesApi->get_source_image_meta_user_with_name: #{e}"
770
+ end
771
+ ```
772
+
773
+ ### Parameters
774
+
775
+ Name | Type | Description | Notes
776
+ ------------- | ------------- | ------------- | -------------
777
+ **organization** | **String**| |
778
+ **hash** | **String**| |
779
+ **meta_name** | **String**| |
780
+
781
+ ### Return type
782
+
783
+ **String**
784
+
785
+ ### Authorization
786
+
787
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
788
+
789
+ ### HTTP request headers
790
+
791
+ - **Content-Type**: Not defined
792
+ - **Accept**: Not defined
793
+
794
+
795
+
796
+ # **list_source_images**
797
+ > ListSourceImagesResponse list_source_images(organization, opts)
798
+
799
+ Get all images of an organization, with paging.
800
+
801
+ You can also filter and sort by their metadata. See the API reference for more in depth documentation about this.
802
+
803
+ ### Example
804
+ ```ruby
805
+ # load the gem
806
+ require 'rokka_client_codegen'
807
+ # setup authorization
808
+ RokkaClientCodegen.configure do |config|
809
+ # Configure API key authorization: ApiKeyAuth
810
+ config.api_key['api-key'] = 'YOUR API KEY'
811
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
812
+ #config.api_key_prefix['api-key'] = 'Bearer'
813
+ end
814
+
815
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
816
+
817
+ organization = "organization_example" # String |
818
+
819
+ opts = {
820
+ offset: "0", # String | When paging results, where to start or a cursor
821
+ limit: 100, # Integer | How many images should be returned
822
+ sort: "created desc", # String | The field to be used for sorting
823
+ deleted: false # BOOLEAN | Search for deleted images
824
+ }
825
+
826
+ begin
827
+ #Get all images of an organization, with paging.
828
+ result = api_instance.list_source_images(organization, opts)
829
+ p result
830
+ rescue RokkaClientCodegen::ApiError => e
831
+ puts "Exception when calling SourceimagesApi->list_source_images: #{e}"
832
+ end
833
+ ```
834
+
835
+ ### Parameters
836
+
837
+ Name | Type | Description | Notes
838
+ ------------- | ------------- | ------------- | -------------
839
+ **organization** | **String**| |
840
+ **offset** | **String**| When paging results, where to start or a cursor | [optional] [default to 0]
841
+ **limit** | **Integer**| How many images should be returned | [optional] [default to 100]
842
+ **sort** | **String**| The field to be used for sorting | [optional] [default to created desc]
843
+ **deleted** | **BOOLEAN**| Search for deleted images | [optional] [default to false]
844
+
845
+ ### Return type
846
+
847
+ [**ListSourceImagesResponse**](ListSourceImagesResponse.md)
848
+
849
+ ### Authorization
850
+
851
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
852
+
853
+ ### HTTP request headers
854
+
855
+ - **Content-Type**: Not defined
856
+ - **Accept**: Not defined
857
+
858
+
859
+
860
+ # **list_source_images_by_binary_hash**
861
+ > ListSourceImagesResponse list_source_images_by_binary_hash(organization, binary_hash)
862
+
863
+ Get all images in this organization that match a binaryhash.
864
+
865
+ The binary hash is the sha1 of the image binary. This may yield several results if the same image has been uploaded with varying dynamic metadata.
866
+
867
+ ### Example
868
+ ```ruby
869
+ # load the gem
870
+ require 'rokka_client_codegen'
871
+ # setup authorization
872
+ RokkaClientCodegen.configure do |config|
873
+ # Configure API key authorization: ApiKeyAuth
874
+ config.api_key['api-key'] = 'YOUR API KEY'
875
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
876
+ #config.api_key_prefix['api-key'] = 'Bearer'
877
+ end
878
+
879
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
880
+
881
+ organization = "organization_example" # String |
882
+
883
+ binary_hash = "binary_hash_example" # String |
884
+
885
+
886
+ begin
887
+ #Get all images in this organization that match a binaryhash.
888
+ result = api_instance.list_source_images_by_binary_hash(organization, binary_hash)
889
+ p result
890
+ rescue RokkaClientCodegen::ApiError => e
891
+ puts "Exception when calling SourceimagesApi->list_source_images_by_binary_hash: #{e}"
892
+ end
893
+ ```
894
+
895
+ ### Parameters
896
+
897
+ Name | Type | Description | Notes
898
+ ------------- | ------------- | ------------- | -------------
899
+ **organization** | **String**| |
900
+ **binary_hash** | **String**| |
901
+
902
+ ### Return type
903
+
904
+ [**ListSourceImagesResponse**](ListSourceImagesResponse.md)
905
+
906
+ ### Authorization
907
+
908
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
909
+
910
+ ### HTTP request headers
911
+
912
+ - **Content-Type**: Not defined
913
+ - **Accept**: Not defined
914
+
915
+
916
+
917
+ # **patch_source_image_meta_user**
918
+ > patch_source_image_meta_user(user_meta_data, organization, hash)
919
+
920
+ Update the specified meta data fields for an image.
921
+
922
+ This only overwrites the fields specified in the request, but leaves existing meta data with different names unchanged. User metadata is used for searching images that have been stored in rokka. It will never lead to differences in the output image and thus changing it never leads to a new hash.
923
+
924
+ ### Example
925
+ ```ruby
926
+ # load the gem
927
+ require 'rokka_client_codegen'
928
+ # setup authorization
929
+ RokkaClientCodegen.configure do |config|
930
+ # Configure API key authorization: ApiKeyAuth
931
+ config.api_key['api-key'] = 'YOUR API KEY'
932
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
933
+ #config.api_key_prefix['api-key'] = 'Bearer'
934
+ end
935
+
936
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
937
+
938
+ user_meta_data = nil # Object | User Meta Data as a json hashmap
939
+
940
+ organization = "organization_example" # String |
941
+
942
+ hash = "hash_example" # String |
943
+
944
+
945
+ begin
946
+ #Update the specified meta data fields for an image.
947
+ api_instance.patch_source_image_meta_user(user_meta_data, organization, hash)
948
+ rescue RokkaClientCodegen::ApiError => e
949
+ puts "Exception when calling SourceimagesApi->patch_source_image_meta_user: #{e}"
950
+ end
951
+ ```
952
+
953
+ ### Parameters
954
+
955
+ Name | Type | Description | Notes
956
+ ------------- | ------------- | ------------- | -------------
957
+ **user_meta_data** | **Object**| User Meta Data as a json hashmap |
958
+ **organization** | **String**| |
959
+ **hash** | **String**| |
960
+
961
+ ### Return type
962
+
963
+ nil (empty response body)
964
+
965
+ ### Authorization
966
+
967
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
968
+
969
+ ### HTTP request headers
970
+
971
+ - **Content-Type**: Not defined
972
+ - **Accept**: Not defined
973
+
974
+
975
+
976
+ # **restore_source_image**
977
+ > SourceImage restore_source_image(organization, hash)
978
+
979
+ Restore source image including previously set metadata.
980
+
981
+ If the image has been deleted but not yet purged from the system, it is restored. If an image with this hash already exists and is not deleted, information about that image is returned.
982
+
983
+ ### Example
984
+ ```ruby
985
+ # load the gem
986
+ require 'rokka_client_codegen'
987
+ # setup authorization
988
+ RokkaClientCodegen.configure do |config|
989
+ # Configure API key authorization: ApiKeyAuth
990
+ config.api_key['api-key'] = 'YOUR API KEY'
991
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
992
+ #config.api_key_prefix['api-key'] = 'Bearer'
993
+ end
994
+
995
+ api_instance = RokkaClientCodegen::SourceimagesApi.new
996
+
997
+ organization = "organization_example" # String |
998
+
999
+ hash = "hash_example" # String |
1000
+
1001
+
1002
+ begin
1003
+ #Restore source image including previously set metadata.
1004
+ result = api_instance.restore_source_image(organization, hash)
1005
+ p result
1006
+ rescue RokkaClientCodegen::ApiError => e
1007
+ puts "Exception when calling SourceimagesApi->restore_source_image: #{e}"
1008
+ end
1009
+ ```
1010
+
1011
+ ### Parameters
1012
+
1013
+ Name | Type | Description | Notes
1014
+ ------------- | ------------- | ------------- | -------------
1015
+ **organization** | **String**| |
1016
+ **hash** | **String**| |
1017
+
1018
+ ### Return type
1019
+
1020
+ [**SourceImage**](SourceImage.md)
1021
+
1022
+ ### Authorization
1023
+
1024
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1025
+
1026
+ ### HTTP request headers
1027
+
1028
+ - **Content-Type**: Not defined
1029
+ - **Accept**: Not defined
1030
+
1031
+
1032
+