blueprint_ruby_client 0.4.1 → 0.5.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 (84) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +65 -0
  3. data/LICENSE +201 -0
  4. data/README.md +25 -11
  5. data/docs/AssetTypeConfigsApi.md +63 -0
  6. data/docs/AssetTypeTemplatesApi.md +179 -0
  7. data/docs/AssetsApi.md +19 -19
  8. data/docs/HierarchyApi.md +35 -35
  9. data/docs/Integration.md +10 -0
  10. data/docs/IntegrationBody.md +9 -0
  11. data/docs/IntegrationTransform.md +11 -0
  12. data/docs/IntegrationTransformExample.md +9 -0
  13. data/docs/IntegrationsApi.md +329 -0
  14. data/docs/LTIApi.md +98 -0
  15. data/docs/Lti1IntegrationAttributes.md +11 -0
  16. data/docs/NodeAttributes.md +2 -0
  17. data/docs/SecurityApi.md +48 -0
  18. data/docs/Template.md +10 -0
  19. data/docs/TemplateAttributes.md +9 -0
  20. data/docs/TemplateBody.md +9 -0
  21. data/docs/{AssetAttributes.md → TemplateVariables.md} +3 -2
  22. data/generate.sh +1 -2
  23. data/git_push.sh +16 -1
  24. data/lib/blueprint_ruby_client/api/asset_type_configs_api.rb +84 -0
  25. data/lib/blueprint_ruby_client/api/asset_type_templates_api.rb +214 -0
  26. data/lib/blueprint_ruby_client/api/assets_api.rb +23 -191
  27. data/lib/blueprint_ruby_client/api/hierarchy_api.rb +49 -409
  28. data/lib/blueprint_ruby_client/api/integrations_api.rb +415 -0
  29. data/lib/blueprint_ruby_client/api/lti_api.rb +156 -0
  30. data/lib/blueprint_ruby_client/api/security_api.rb +75 -0
  31. data/lib/blueprint_ruby_client/api_client.rb +0 -2
  32. data/lib/blueprint_ruby_client/models/asset.rb +2 -59
  33. data/lib/blueprint_ruby_client/models/asset_body.rb +2 -42
  34. data/lib/blueprint_ruby_client/models/asset_relationship.rb +2 -57
  35. data/lib/blueprint_ruby_client/models/asset_result_set.rb +2 -57
  36. data/lib/blueprint_ruby_client/models/error.rb +2 -59
  37. data/lib/blueprint_ruby_client/models/errors.rb +2 -25
  38. data/lib/blueprint_ruby_client/models/integration.rb +225 -0
  39. data/lib/blueprint_ruby_client/models/{mixed_resource_result_set.rb → integration_body.rb} +27 -12
  40. data/lib/blueprint_ruby_client/models/integration_transform.rb +221 -0
  41. data/lib/blueprint_ruby_client/models/integration_transform_example.rb +197 -0
  42. data/lib/blueprint_ruby_client/models/links.rb +2 -57
  43. data/lib/blueprint_ruby_client/models/lti1_integration_attributes.rb +225 -0
  44. data/lib/blueprint_ruby_client/models/meta.rb +2 -57
  45. data/lib/blueprint_ruby_client/models/namespace.rb +2 -43
  46. data/lib/blueprint_ruby_client/models/namespace_relationship.rb +2 -25
  47. data/lib/blueprint_ruby_client/models/node.rb +2 -75
  48. data/lib/blueprint_ruby_client/models/node_attributes.rb +26 -109
  49. data/lib/blueprint_ruby_client/models/node_body.rb +2 -42
  50. data/lib/blueprint_ruby_client/models/node_relationship.rb +2 -57
  51. data/lib/blueprint_ruby_client/models/node_relationships.rb +2 -73
  52. data/lib/blueprint_ruby_client/models/node_result_set.rb +2 -57
  53. data/lib/blueprint_ruby_client/models/resource.rb +2 -59
  54. data/lib/blueprint_ruby_client/models/template.rb +215 -0
  55. data/lib/blueprint_ruby_client/models/template_attributes.rb +217 -0
  56. data/lib/blueprint_ruby_client/models/{asset_attributes.rb → template_body.rb} +23 -33
  57. data/lib/blueprint_ruby_client/models/template_variables.rb +237 -0
  58. data/lib/blueprint_ruby_client/version.rb +1 -1
  59. data/lib/blueprint_ruby_client.rb +14 -0
  60. data/spec/api/asset_type_configs_api_spec.rb +52 -0
  61. data/spec/api/asset_type_templates_api_spec.rb +88 -0
  62. data/spec/api/assets_api_spec.rb +9 -9
  63. data/spec/api/hierarchy_api_spec.rb +17 -17
  64. data/spec/api/integrations_api_spec.rb +141 -0
  65. data/spec/api/lti_api_spec.rb +69 -0
  66. data/spec/api/security_api_spec.rb +50 -0
  67. data/spec/api_client_spec.rb +226 -0
  68. data/spec/configuration_spec.rb +42 -0
  69. data/spec/models/integration_body_spec.rb +56 -0
  70. data/spec/models/integration_spec.rb +66 -0
  71. data/spec/models/integration_transform_example_spec.rb +56 -0
  72. data/spec/models/integration_transform_spec.rb +76 -0
  73. data/spec/models/lti1_integration_attributes_spec.rb +76 -0
  74. data/spec/models/node_attributes_spec.rb +20 -0
  75. data/spec/models/template_attributes_spec.rb +56 -0
  76. data/spec/models/{asset_attributes_spec.rb → template_body_spec.rb} +17 -7
  77. data/spec/models/template_spec.rb +66 -0
  78. data/spec/models/template_variables_spec.rb +56 -0
  79. data/spec/spec_helper.rb +111 -0
  80. data/swagger-codegen-cli.jar +0 -0
  81. data/templates/model.mustache +5 -5
  82. metadata +67 -12
  83. data/docs/MixedResourceResultSet.md +0 -7
  84. data/spec/models/mixed_resource_result_set_spec.rb +0 -36
@@ -22,7 +22,7 @@ module BlueprintClient
22
22
 
23
23
  #
24
24
  # Add a node
25
- # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
25
+ # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
26
26
  # @param body node
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @return [NodeBody]
@@ -33,7 +33,7 @@ module BlueprintClient
33
33
 
34
34
  #
35
35
  # Add a node
36
- # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
36
+ # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
37
37
  # @param body node
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @return [Array<(NodeBody, Fixnum, Hash)>] NodeBody data, response status code and response headers
@@ -41,23 +41,10 @@ module BlueprintClient
41
41
  if @api_client.config.debugging
42
42
  @api_client.config.logger.debug "Calling API: HierarchyApi.add_node ..."
43
43
  end
44
-
45
-
46
44
  # verify the required parameter 'namespace_inc_global' is set
47
45
  fail ArgumentError, "Missing the required parameter 'namespace_inc_global' when calling HierarchyApi.add_node" if namespace_inc_global.nil?
48
-
49
-
50
-
51
-
52
-
53
-
54
46
  # verify the required parameter 'body' is set
55
47
  fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.add_node" if body.nil?
56
-
57
-
58
-
59
-
60
-
61
48
  # resource path
62
49
  local_var_path = "/{namespaceIncGlobal}/nodes".sub('{format}','json').sub('{' + 'namespaceIncGlobal' + '}', namespace_inc_global.to_s)
63
50
 
@@ -80,7 +67,6 @@ module BlueprintClient
80
67
 
81
68
  # http body (model)
82
69
  post_body = @api_client.object_to_http_body(body)
83
-
84
70
  auth_names = ['oauth2']
85
71
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
86
72
  :header_params => header_params,
@@ -96,7 +82,7 @@ module BlueprintClient
96
82
  end
97
83
 
98
84
  #
99
- # Send operations to modify nodes in bulk, to be applied/rejected as a single transaction.\nFormat will be:\n\n OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n
85
+ # Send operations to modify nodes in bulk, to be applied/rejected as a single transaction. Format will be: OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS
100
86
  # @param namespace identifier namespacing the blueprint.
101
87
  # @param [Hash] opts the optional parameters
102
88
  # @return [nil]
@@ -106,7 +92,7 @@ module BlueprintClient
106
92
  end
107
93
 
108
94
  #
109
- # Send operations to modify nodes in bulk, to be applied/rejected as a single transaction.\nFormat will be:\n\n OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n
95
+ # Send operations to modify nodes in bulk, to be applied/rejected as a single transaction. Format will be: OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS
110
96
  # @param namespace identifier namespacing the blueprint.
111
97
  # @param [Hash] opts the optional parameters
112
98
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -114,15 +100,8 @@ module BlueprintClient
114
100
  if @api_client.config.debugging
115
101
  @api_client.config.logger.debug "Calling API: HierarchyApi.bulk_upload ..."
116
102
  end
117
-
118
-
119
103
  # verify the required parameter 'namespace' is set
120
104
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.bulk_upload" if namespace.nil?
121
-
122
-
123
-
124
-
125
-
126
105
  # resource path
127
106
  local_var_path = "/{namespace}/nodes.csv".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s)
128
107
 
@@ -145,8 +124,7 @@ module BlueprintClient
145
124
 
146
125
  # http body (model)
147
126
  post_body = nil
148
-
149
- auth_names = ['oauth2']
127
+ auth_names = ['oauth2']
150
128
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
151
129
  :header_params => header_params,
152
130
  :query_params => query_params,
@@ -163,7 +141,7 @@ module BlueprintClient
163
141
  # Delete a node
164
142
  # @param namespace identifier namespacing the blueprint.
165
143
  # @param id id identifying a domain model
166
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
144
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
167
145
  # @param [Hash] opts the optional parameters
168
146
  # @return [nil]
169
147
  def delete_node(namespace, id, type, opts = {})
@@ -175,38 +153,19 @@ module BlueprintClient
175
153
  # Delete a node
176
154
  # @param namespace identifier namespacing the blueprint.
177
155
  # @param id id identifying a domain model
178
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
156
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
179
157
  # @param [Hash] opts the optional parameters
180
158
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
181
159
  def delete_node_with_http_info(namespace, id, type, opts = {})
182
160
  if @api_client.config.debugging
183
161
  @api_client.config.logger.debug "Calling API: HierarchyApi.delete_node ..."
184
162
  end
185
-
186
-
187
163
  # verify the required parameter 'namespace' is set
188
164
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.delete_node" if namespace.nil?
189
-
190
-
191
-
192
-
193
-
194
-
195
165
  # verify the required parameter 'id' is set
196
166
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.delete_node" if id.nil?
197
-
198
-
199
-
200
-
201
-
202
-
203
167
  # verify the required parameter 'type' is set
204
168
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.delete_node" if type.nil?
205
-
206
-
207
-
208
-
209
-
210
169
  # resource path
211
170
  local_var_path = "/{namespace}/nodes/{type}/{id}".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'type' + '}', type.to_s)
212
171
 
@@ -229,8 +188,7 @@ module BlueprintClient
229
188
 
230
189
  # http body (model)
231
190
  post_body = nil
232
-
233
- auth_names = ['oauth2']
191
+ auth_names = ['oauth2']
234
192
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
235
193
  :header_params => header_params,
236
194
  :query_params => query_params,
@@ -244,7 +202,7 @@ module BlueprintClient
244
202
  end
245
203
 
246
204
  #
247
- # Download the blueprint's nodes in CSV format\nFormat will be:\n\n OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n\nOLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer\n
205
+ # Download the blueprint's nodes in CSV format Format will be: OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS OLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer
248
206
  # @param namespace identifier namespacing the blueprint.
249
207
  # @param [Hash] opts the optional parameters
250
208
  # @return [nil]
@@ -254,7 +212,7 @@ module BlueprintClient
254
212
  end
255
213
 
256
214
  #
257
- # Download the blueprint&#39;s nodes in CSV format\nFormat will be:\n\n OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n\nOLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer\n
215
+ # Download the blueprint&#39;s nodes in CSV format Format will be: OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS OLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer
258
216
  # @param namespace identifier namespacing the blueprint.
259
217
  # @param [Hash] opts the optional parameters
260
218
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -262,15 +220,8 @@ module BlueprintClient
262
220
  if @api_client.config.debugging
263
221
  @api_client.config.logger.debug "Calling API: HierarchyApi.export_hierarchy ..."
264
222
  end
265
-
266
-
267
223
  # verify the required parameter 'namespace' is set
268
224
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.export_hierarchy" if namespace.nil?
269
-
270
-
271
-
272
-
273
-
274
225
  # resource path
275
226
  local_var_path = "/{namespace}/nodes.csv".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s)
276
227
 
@@ -293,8 +244,7 @@ module BlueprintClient
293
244
 
294
245
  # http body (model)
295
246
  post_body = nil
296
-
297
- auth_names = ['oauth2']
247
+ auth_names = ['oauth2']
298
248
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
299
249
  :header_params => header_params,
300
250
  :query_params => query_params,
@@ -308,10 +258,10 @@ module BlueprintClient
308
258
  end
309
259
 
310
260
  # Get ancestor nodes
311
- # A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
261
+ # A proxy for finding ancestors of a given node, equivalent to `/1/abc/nodes?filter[descendant]=department%2Fdep101`
312
262
  # @param id id identifying a domain model
313
263
  # @param namespace identifier namespacing the blueprint.
314
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
264
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
315
265
  # @param [Hash] opts the optional parameters
316
266
  # @option opts [Float] :offset index to start result set from
317
267
  # @option opts [Float] :limit number of records to return
@@ -322,10 +272,10 @@ module BlueprintClient
322
272
  end
323
273
 
324
274
  # Get ancestor nodes
325
- # A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
275
+ # A proxy for finding ancestors of a given node, equivalent to &#x60;/1/abc/nodes?filter[descendant]&#x3D;department%2Fdep101&#x60;
326
276
  # @param id id identifying a domain model
327
277
  # @param namespace identifier namespacing the blueprint.
328
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
278
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
329
279
  # @param [Hash] opts the optional parameters
330
280
  # @option opts [Float] :offset index to start result set from
331
281
  # @option opts [Float] :limit number of records to return
@@ -334,43 +284,12 @@ module BlueprintClient
334
284
  if @api_client.config.debugging
335
285
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_ancestors ..."
336
286
  end
337
-
338
-
339
287
  # verify the required parameter 'id' is set
340
288
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_ancestors" if id.nil?
341
-
342
-
343
-
344
-
345
-
346
-
347
289
  # verify the required parameter 'namespace' is set
348
290
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_ancestors" if namespace.nil?
349
-
350
-
351
-
352
-
353
-
354
-
355
291
  # verify the required parameter 'type' is set
356
292
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_ancestors" if type.nil?
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
293
  # resource path
375
294
  local_var_path = "/{namespace}/nodes/{type}/{id}/ancestors".sub('{format}','json').sub('{' + 'id' + '}', id.to_s).sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'type' + '}', type.to_s)
376
295
 
@@ -395,8 +314,7 @@ module BlueprintClient
395
314
 
396
315
  # http body (model)
397
316
  post_body = nil
398
-
399
- auth_names = ['oauth2']
317
+ auth_names = ['oauth2']
400
318
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
401
319
  :header_params => header_params,
402
320
  :query_params => query_params,
@@ -411,10 +329,10 @@ module BlueprintClient
411
329
  end
412
330
 
413
331
  # Get child nodes
414
- # A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
332
+ # A proxy for finding children of a given node, equivalent to `/1/abc/nodes?filter[parent]=department%2Fdep101`
415
333
  # @param id id identifying a domain model
416
334
  # @param namespace identifier namespacing the blueprint.
417
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
335
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
418
336
  # @param [Hash] opts the optional parameters
419
337
  # @option opts [Float] :offset index to start result set from
420
338
  # @option opts [Float] :limit number of records to return
@@ -425,10 +343,10 @@ module BlueprintClient
425
343
  end
426
344
 
427
345
  # Get child nodes
428
- # A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
346
+ # A proxy for finding children of a given node, equivalent to &#x60;/1/abc/nodes?filter[parent]&#x3D;department%2Fdep101&#x60;
429
347
  # @param id id identifying a domain model
430
348
  # @param namespace identifier namespacing the blueprint.
431
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
349
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
432
350
  # @param [Hash] opts the optional parameters
433
351
  # @option opts [Float] :offset index to start result set from
434
352
  # @option opts [Float] :limit number of records to return
@@ -437,43 +355,12 @@ module BlueprintClient
437
355
  if @api_client.config.debugging
438
356
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_children ..."
439
357
  end
440
-
441
-
442
358
  # verify the required parameter 'id' is set
443
359
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_children" if id.nil?
444
-
445
-
446
-
447
-
448
-
449
-
450
360
  # verify the required parameter 'namespace' is set
451
361
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_children" if namespace.nil?
452
-
453
-
454
-
455
-
456
-
457
-
458
362
  # verify the required parameter 'type' is set
459
363
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_children" if type.nil?
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
364
  # resource path
478
365
  local_var_path = "/{namespace}/nodes/{type}/{id}/children".sub('{format}','json').sub('{' + 'id' + '}', id.to_s).sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'type' + '}', type.to_s)
479
366
 
@@ -498,8 +385,7 @@ module BlueprintClient
498
385
 
499
386
  # http body (model)
500
387
  post_body = nil
501
-
502
- auth_names = ['oauth2']
388
+ auth_names = ['oauth2']
503
389
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
504
390
  :header_params => header_params,
505
391
  :query_params => query_params,
@@ -514,10 +400,10 @@ module BlueprintClient
514
400
  end
515
401
 
516
402
  # Get descendant nodes
517
- # A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
403
+ # A proxy for finding descendants of a given node, equivalent to `/1/abc/nodes?filter[ancestor]=department%2Fdep101`
518
404
  # @param id id identifying a domain model
519
405
  # @param namespace identifier namespacing the blueprint.
520
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
406
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
521
407
  # @param [Hash] opts the optional parameters
522
408
  # @option opts [Float] :offset index to start result set from
523
409
  # @option opts [Float] :limit number of records to return
@@ -528,10 +414,10 @@ module BlueprintClient
528
414
  end
529
415
 
530
416
  # Get descendant nodes
531
- # A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
417
+ # A proxy for finding descendants of a given node, equivalent to &#x60;/1/abc/nodes?filter[ancestor]&#x3D;department%2Fdep101&#x60;
532
418
  # @param id id identifying a domain model
533
419
  # @param namespace identifier namespacing the blueprint.
534
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
420
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
535
421
  # @param [Hash] opts the optional parameters
536
422
  # @option opts [Float] :offset index to start result set from
537
423
  # @option opts [Float] :limit number of records to return
@@ -540,43 +426,12 @@ module BlueprintClient
540
426
  if @api_client.config.debugging
541
427
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_descendants ..."
542
428
  end
543
-
544
-
545
429
  # verify the required parameter 'id' is set
546
430
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_descendants" if id.nil?
547
-
548
-
549
-
550
-
551
-
552
-
553
431
  # verify the required parameter 'namespace' is set
554
432
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_descendants" if namespace.nil?
555
-
556
-
557
-
558
-
559
-
560
-
561
433
  # verify the required parameter 'type' is set
562
434
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_descendants" if type.nil?
563
-
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
-
574
-
575
-
576
-
577
-
578
-
579
-
580
435
  # resource path
581
436
  local_var_path = "/{namespace}/nodes/{type}/{id}/descendants".sub('{format}','json').sub('{' + 'id' + '}', id.to_s).sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'type' + '}', type.to_s)
582
437
 
@@ -601,8 +456,7 @@ module BlueprintClient
601
456
 
602
457
  # http body (model)
603
458
  post_body = nil
604
-
605
- auth_names = ['oauth2']
459
+ auth_names = ['oauth2']
606
460
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
607
461
  :header_params => header_params,
608
462
  :query_params => query_params,
@@ -620,7 +474,7 @@ module BlueprintClient
620
474
  # Get details of a given node
621
475
  # @param namespace identifier namespacing the blueprint.
622
476
  # @param id id identifying a domain model
623
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
477
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
624
478
  # @param [Hash] opts the optional parameters
625
479
  # @option opts [Array<String>] :include comma separated list of elements to hydrate. Can include children, parents, and/or assets
626
480
  # @return [NodeBody]
@@ -633,7 +487,7 @@ module BlueprintClient
633
487
  # Get details of a given node
634
488
  # @param namespace identifier namespacing the blueprint.
635
489
  # @param id id identifying a domain model
636
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
490
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
637
491
  # @param [Hash] opts the optional parameters
638
492
  # @option opts [Array<String>] :include comma separated list of elements to hydrate. Can include children, parents, and/or assets
639
493
  # @return [Array<(NodeBody, Fixnum, Hash)>] NodeBody data, response status code and response headers
@@ -641,37 +495,15 @@ module BlueprintClient
641
495
  if @api_client.config.debugging
642
496
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_node ..."
643
497
  end
644
-
645
-
646
498
  # verify the required parameter 'namespace' is set
647
499
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_node" if namespace.nil?
648
-
649
-
650
-
651
-
652
-
653
-
654
500
  # verify the required parameter 'id' is set
655
501
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_node" if id.nil?
656
-
657
-
658
-
659
-
660
-
661
-
662
502
  # verify the required parameter 'type' is set
663
503
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_node" if type.nil?
664
-
665
-
666
-
667
-
668
-
669
-
670
-
671
-
672
-
673
-
674
-
504
+ if opts[:'include'] && !['children', 'parents', 'assets'].include?(opts[:'include'])
505
+ fail ArgumentError, 'invalid value for "include", must be one of children, parents, assets'
506
+ end
675
507
  # resource path
676
508
  local_var_path = "/{namespace}/nodes/{type}/{id}".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'type' + '}', type.to_s)
677
509
 
@@ -695,8 +527,7 @@ module BlueprintClient
695
527
 
696
528
  # http body (model)
697
529
  post_body = nil
698
-
699
- auth_names = ['oauth2']
530
+ auth_names = ['oauth2']
700
531
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
701
532
  :header_params => header_params,
702
533
  :query_params => query_params,
@@ -711,10 +542,10 @@ module BlueprintClient
711
542
  end
712
543
 
713
544
  # Get parent nodes
714
- # A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
545
+ # A proxy for finding parents of a given node, equivalent to `/1/abc/nodes?filter[child]=department%2Fdep101`
715
546
  # @param id id identifying a domain model
716
547
  # @param namespace identifier namespacing the blueprint.
717
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
548
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
718
549
  # @param [Hash] opts the optional parameters
719
550
  # @option opts [Float] :offset index to start result set from
720
551
  # @option opts [Float] :limit number of records to return
@@ -725,10 +556,10 @@ module BlueprintClient
725
556
  end
726
557
 
727
558
  # Get parent nodes
728
- # A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
559
+ # A proxy for finding parents of a given node, equivalent to &#x60;/1/abc/nodes?filter[child]&#x3D;department%2Fdep101&#x60;
729
560
  # @param id id identifying a domain model
730
561
  # @param namespace identifier namespacing the blueprint.
731
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
562
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
732
563
  # @param [Hash] opts the optional parameters
733
564
  # @option opts [Float] :offset index to start result set from
734
565
  # @option opts [Float] :limit number of records to return
@@ -737,43 +568,12 @@ module BlueprintClient
737
568
  if @api_client.config.debugging
738
569
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_parents ..."
739
570
  end
740
-
741
-
742
571
  # verify the required parameter 'id' is set
743
572
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_parents" if id.nil?
744
-
745
-
746
-
747
-
748
-
749
-
750
573
  # verify the required parameter 'namespace' is set
751
574
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_parents" if namespace.nil?
752
-
753
-
754
-
755
-
756
-
757
-
758
575
  # verify the required parameter 'type' is set
759
576
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_parents" if type.nil?
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
-
777
577
  # resource path
778
578
  local_var_path = "/{namespace}/nodes/{type}/{id}/parents".sub('{format}','json').sub('{' + 'id' + '}', id.to_s).sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'type' + '}', type.to_s)
779
579
 
@@ -798,8 +598,7 @@ module BlueprintClient
798
598
 
799
599
  # http body (model)
800
600
  post_body = nil
801
-
802
- auth_names = ['oauth2']
601
+ auth_names = ['oauth2']
803
602
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
804
603
  :header_params => header_params,
805
604
  :query_params => query_params,
@@ -818,7 +617,7 @@ module BlueprintClient
818
617
  # @param namespace identifier namespacing the blueprint.
819
618
  # @param id id identifying a domain model
820
619
  # @param body node
821
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
620
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
822
621
  # @param [Hash] opts the optional parameters
823
622
  # @return [NodeBody]
824
623
  def replace_node(namespace, id, body, type, opts = {})
@@ -831,46 +630,21 @@ module BlueprintClient
831
630
  # @param namespace identifier namespacing the blueprint.
832
631
  # @param id id identifying a domain model
833
632
  # @param body node
834
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
633
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
835
634
  # @param [Hash] opts the optional parameters
836
635
  # @return [Array<(NodeBody, Fixnum, Hash)>] NodeBody data, response status code and response headers
837
636
  def replace_node_with_http_info(namespace, id, body, type, opts = {})
838
637
  if @api_client.config.debugging
839
638
  @api_client.config.logger.debug "Calling API: HierarchyApi.replace_node ..."
840
639
  end
841
-
842
-
843
640
  # verify the required parameter 'namespace' is set
844
641
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.replace_node" if namespace.nil?
845
-
846
-
847
-
848
-
849
-
850
-
851
642
  # verify the required parameter 'id' is set
852
643
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.replace_node" if id.nil?
853
-
854
-
855
-
856
-
857
-
858
-
859
644
  # verify the required parameter 'body' is set
860
645
  fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.replace_node" if body.nil?
861
-
862
-
863
-
864
-
865
-
866
-
867
646
  # verify the required parameter 'type' is set
868
647
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.replace_node" if type.nil?
869
-
870
-
871
-
872
-
873
-
874
648
  # resource path
875
649
  local_var_path = "/{namespace}/nodes/{type}/{id}".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'type' + '}', type.to_s)
876
650
 
@@ -893,7 +667,6 @@ module BlueprintClient
893
667
 
894
668
  # http body (model)
895
669
  post_body = @api_client.object_to_http_body(body)
896
-
897
670
  auth_names = ['oauth2']
898
671
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
899
672
  :header_params => header_params,
@@ -909,8 +682,8 @@ module BlueprintClient
909
682
  end
910
683
 
911
684
  # Search nodes
912
- # This endpoint is a really flexible way to ask questions about the hierarchy. for example:\n\n###### Find all nodes for abc:\n`/1/abc/nodes`\n\n###### Find all modules for abc:\n`/1/abc/nodes?filter[nodeType]=Module`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=module%2Fabf203&filter[nodeType]=Department` # <= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Module&filter[ancestor]=department%2FDEP101&filter[hasAssets]=true&filter[assetType]=List`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Module&filter[hasAssets]=false&filter[assetType]=List`\n\n###### Find all nodes of type time period valid during 2015 that have no list assets. Note a node's valid_from/valid_to just need to overlap from/to to qualify\n`/1/global/nodes?filter[nodeType]=TimePeriod&filter[hasAssets]=false&filter[assetType]=List&filter[from]=20150101&filter[to]=20151231`\n
913
- # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
685
+ # This endpoint is a really flexible way to ask questions about the hierarchy. for example: ###### Find all nodes for abc: `/1/abc/nodes` ###### Find all modules for abc: `/1/abc/nodes?filter[nodeType]=Modules` ###### Find all nodes that are descendants of DEP101: `/1/abc/nodes?filter[descendant]=departments%2Fdep101` ###### Find all Departments that are ancestors of ABF203: `/1/abc/nodes?filter[descendant]=modules%2Fabf203&filter[nodeType]=Departments` # <= case insensitive ###### Find all nodes with list assets that are descendants of DEP101 for abc: `/1/abc/nodes?filter[nodeType]=Modules&filter[ancestor]=departments%2FDEP101&filter[hasAssets]=true&filter[assetType]=Lists` ###### Globally, find all modules that have no list assets `/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[assetType]=Lists` ###### Find all nodes of type modules during 2015 that have no assets. Note a node's valid_from/valid_to just need to overlap from/to to qualify `/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[from]=20150101&filter[to]=20151231`
686
+ # @param namespace_inc_global identifier namespacing the blueprint. &#x60;global&#x60; is a special namespace which references data from all blueprints in the call.
914
687
  # @param [Hash] opts the optional parameters
915
688
  # @option opts [Float] :offset index to start result set from
916
689
  # @option opts [Float] :limit number of records to return
@@ -936,8 +709,8 @@ module BlueprintClient
936
709
  end
937
710
 
938
711
  # Search nodes
939
- # This endpoint is a really flexible way to ask questions about the hierarchy. for example:\n\n###### Find all nodes for abc:\n`/1/abc/nodes`\n\n###### Find all modules for abc:\n`/1/abc/nodes?filter[nodeType]=Module`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=module%2Fabf203&amp;filter[nodeType]=Department` # &lt;= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Module&amp;filter[ancestor]=department%2FDEP101&amp;filter[hasAssets]=true&amp;filter[assetType]=List`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Module&amp;filter[hasAssets]=false&amp;filter[assetType]=List`\n\n###### Find all nodes of type time period valid during 2015 that have no list assets. Note a node&#39;s valid_from/valid_to just need to overlap from/to to qualify\n`/1/global/nodes?filter[nodeType]=TimePeriod&amp;filter[hasAssets]=false&amp;filter[assetType]=List&amp;filter[from]=20150101&amp;filter[to]=20151231`\n
940
- # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
712
+ # This endpoint is a really flexible way to ask questions about the hierarchy. for example: ###### Find all nodes for abc: &#x60;/1/abc/nodes&#x60; ###### Find all modules for abc: &#x60;/1/abc/nodes?filter[nodeType]&#x3D;Modules&#x60; ###### Find all nodes that are descendants of DEP101: &#x60;/1/abc/nodes?filter[descendant]&#x3D;departments%2Fdep101&#x60; ###### Find all Departments that are ancestors of ABF203: &#x60;/1/abc/nodes?filter[descendant]&#x3D;modules%2Fabf203&amp;filter[nodeType]&#x3D;Departments&#x60; # &lt;&#x3D; case insensitive ###### Find all nodes with list assets that are descendants of DEP101 for abc: &#x60;/1/abc/nodes?filter[nodeType]&#x3D;Modules&amp;filter[ancestor]&#x3D;departments%2FDEP101&amp;filter[hasAssets]&#x3D;true&amp;filter[assetType]&#x3D;Lists&#x60; ###### Globally, find all modules that have no list assets &#x60;/1/global/nodes?filter[nodeType]&#x3D;Modules&amp;filter[hasAssets]&#x3D;false&amp;filter[assetType]&#x3D;Lists&#x60; ###### Find all nodes of type modules during 2015 that have no assets. Note a node&#39;s valid_from/valid_to just need to overlap from/to to qualify &#x60;/1/global/nodes?filter[nodeType]&#x3D;Modules&amp;filter[hasAssets]&#x3D;false&amp;filter[from]&#x3D;20150101&amp;filter[to]&#x3D;20151231&#x60;
713
+ # @param namespace_inc_global identifier namespacing the blueprint. &#x60;global&#x60; is a special namespace which references data from all blueprints in the call.
941
714
  # @param [Hash] opts the optional parameters
942
715
  # @option opts [Float] :offset index to start result set from
943
716
  # @option opts [Float] :limit number of records to return
@@ -961,117 +734,11 @@ module BlueprintClient
961
734
  if @api_client.config.debugging
962
735
  @api_client.config.logger.debug "Calling API: HierarchyApi.search_nodes ..."
963
736
  end
964
-
965
-
966
737
  # verify the required parameter 'namespace_inc_global' is set
967
738
  fail ArgumentError, "Missing the required parameter 'namespace_inc_global' when calling HierarchyApi.search_nodes" if namespace_inc_global.nil?
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
-
979
-
980
-
981
-
982
-
983
-
984
-
985
-
986
-
987
-
988
-
989
-
990
-
991
-
992
-
993
-
994
-
995
-
996
-
997
-
998
-
999
-
1000
-
1001
-
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
-
1010
-
1011
-
1012
-
1013
-
1014
-
1015
-
1016
-
1017
-
1018
-
1019
-
1020
-
1021
-
1022
-
1023
-
1024
-
1025
-
1026
-
1027
-
1028
-
1029
-
1030
-
1031
-
1032
-
1033
-
1034
-
1035
-
1036
-
1037
-
1038
-
1039
-
1040
-
1041
-
1042
-
1043
-
1044
-
1045
-
1046
-
1047
-
1048
-
1049
-
1050
-
1051
-
1052
-
1053
-
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
-
1062
-
1063
-
1064
-
1065
-
1066
-
1067
-
1068
-
1069
-
1070
-
1071
-
1072
-
1073
-
1074
-
739
+ if opts[:'include'] && !['children', 'parents', 'assets'].include?(opts[:'include'])
740
+ fail ArgumentError, 'invalid value for "include", must be one of children, parents, assets'
741
+ end
1075
742
  # resource path
1076
743
  local_var_path = "/{namespaceIncGlobal}/nodes".sub('{format}','json').sub('{' + 'namespaceIncGlobal' + '}', namespace_inc_global.to_s)
1077
744
 
@@ -1111,8 +778,7 @@ module BlueprintClient
1111
778
 
1112
779
  # http body (model)
1113
780
  post_body = nil
1114
-
1115
- auth_names = ['oauth2']
781
+ auth_names = ['oauth2']
1116
782
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1117
783
  :header_params => header_params,
1118
784
  :query_params => query_params,
@@ -1131,7 +797,7 @@ module BlueprintClient
1131
797
  # @param namespace identifier namespacing the blueprint.
1132
798
  # @param id id identifying a domain model
1133
799
  # @param body node
1134
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
800
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
1135
801
  # @param [Hash] opts the optional parameters
1136
802
  # @return [NodeBody]
1137
803
  def update_node(namespace, id, body, type, opts = {})
@@ -1144,46 +810,21 @@ module BlueprintClient
1144
810
  # @param namespace identifier namespacing the blueprint.
1145
811
  # @param id id identifying a domain model
1146
812
  # @param body node
1147
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
813
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
1148
814
  # @param [Hash] opts the optional parameters
1149
815
  # @return [Array<(NodeBody, Fixnum, Hash)>] NodeBody data, response status code and response headers
1150
816
  def update_node_with_http_info(namespace, id, body, type, opts = {})
1151
817
  if @api_client.config.debugging
1152
818
  @api_client.config.logger.debug "Calling API: HierarchyApi.update_node ..."
1153
819
  end
1154
-
1155
-
1156
820
  # verify the required parameter 'namespace' is set
1157
821
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.update_node" if namespace.nil?
1158
-
1159
-
1160
-
1161
-
1162
-
1163
-
1164
822
  # verify the required parameter 'id' is set
1165
823
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.update_node" if id.nil?
1166
-
1167
-
1168
-
1169
-
1170
-
1171
-
1172
824
  # verify the required parameter 'body' is set
1173
825
  fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.update_node" if body.nil?
1174
-
1175
-
1176
-
1177
-
1178
-
1179
-
1180
826
  # verify the required parameter 'type' is set
1181
827
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.update_node" if type.nil?
1182
-
1183
-
1184
-
1185
-
1186
-
1187
828
  # resource path
1188
829
  local_var_path = "/{namespace}/nodes/{type}/{id}".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'type' + '}', type.to_s)
1189
830
 
@@ -1206,7 +847,6 @@ module BlueprintClient
1206
847
 
1207
848
  # http body (model)
1208
849
  post_body = @api_client.object_to_http_body(body)
1209
-
1210
850
  auth_names = ['oauth2']
1211
851
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1212
852
  :header_params => header_params,