blueprint_ruby_client 0.5.0 → 0.5.1

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 (54) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -5
  4. data/config.json +1 -1
  5. data/docs/AssetsApi.md +3 -3
  6. data/docs/HierarchyApi.md +19 -19
  7. data/docs/IntegrationTransformExample.md +1 -1
  8. data/docs/IntegrationsApi.md +4 -4
  9. data/docs/LTIApi.md +4 -4
  10. data/generate.sh +1 -1
  11. data/lib/blueprint_ruby_client/api/asset_type_configs_api.rb +15 -1
  12. data/lib/blueprint_ruby_client/api/asset_type_templates_api.rb +55 -1
  13. data/lib/blueprint_ruby_client/api/assets_api.rb +175 -7
  14. data/lib/blueprint_ruby_client/api/hierarchy_api.rb +393 -33
  15. data/lib/blueprint_ruby_client/api/integrations_api.rb +203 -3
  16. data/lib/blueprint_ruby_client/api/lti_api.rb +121 -1
  17. data/lib/blueprint_ruby_client/api/security_api.rb +3 -1
  18. data/lib/blueprint_ruby_client/api_client.rb +2 -0
  19. data/lib/blueprint_ruby_client/models/asset.rb +57 -0
  20. data/lib/blueprint_ruby_client/models/asset_body.rb +40 -0
  21. data/lib/blueprint_ruby_client/models/asset_relationship.rb +55 -0
  22. data/lib/blueprint_ruby_client/models/asset_result_set.rb +55 -0
  23. data/lib/blueprint_ruby_client/models/error.rb +57 -0
  24. data/lib/blueprint_ruby_client/models/errors.rb +23 -0
  25. data/lib/blueprint_ruby_client/models/integration.rb +57 -0
  26. data/lib/blueprint_ruby_client/models/integration_body.rb +40 -0
  27. data/lib/blueprint_ruby_client/models/integration_transform.rb +73 -0
  28. data/lib/blueprint_ruby_client/models/integration_transform_example.rb +53 -13
  29. data/lib/blueprint_ruby_client/models/links.rb +55 -0
  30. data/lib/blueprint_ruby_client/models/lti1_integration_attributes.rb +74 -0
  31. data/lib/blueprint_ruby_client/models/meta.rb +55 -0
  32. data/lib/blueprint_ruby_client/models/namespace.rb +41 -0
  33. data/lib/blueprint_ruby_client/models/namespace_relationship.rb +23 -0
  34. data/lib/blueprint_ruby_client/models/node.rb +73 -0
  35. data/lib/blueprint_ruby_client/models/node_attributes.rb +135 -0
  36. data/lib/blueprint_ruby_client/models/node_body.rb +40 -0
  37. data/lib/blueprint_ruby_client/models/node_relationship.rb +55 -0
  38. data/lib/blueprint_ruby_client/models/node_relationships.rb +71 -0
  39. data/lib/blueprint_ruby_client/models/node_result_set.rb +55 -0
  40. data/lib/blueprint_ruby_client/models/resource.rb +57 -0
  41. data/lib/blueprint_ruby_client/models/template.rb +58 -0
  42. data/lib/blueprint_ruby_client/models/template_attributes.rb +40 -18
  43. data/lib/blueprint_ruby_client/models/template_body.rb +40 -0
  44. data/lib/blueprint_ruby_client/models/template_variables.rb +43 -38
  45. data/lib/blueprint_ruby_client/version.rb +1 -1
  46. data/spec/api/assets_api_spec.rb +1 -1
  47. data/spec/api/hierarchy_api_spec.rb +9 -9
  48. data/spec/models/integration_transform_example_spec.rb +2 -2
  49. metadata +4 -11
  50. data/git_push.sh +0 -67
  51. data/spec/api_client_spec.rb +0 -226
  52. data/spec/configuration_spec.rb +0 -42
  53. data/spec/spec_helper.rb +0 -111
  54. data/swagger-codegen-cli.jar +0 -0
@@ -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,10 +41,23 @@ 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
+
44
46
  # verify the required parameter 'namespace_inc_global' is set
45
47
  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
+
46
54
  # verify the required parameter 'body' is set
47
55
  fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.add_node" if body.nil?
56
+
57
+
58
+
59
+
60
+
48
61
  # resource path
49
62
  local_var_path = "/{namespaceIncGlobal}/nodes".sub('{format}','json').sub('{' + 'namespaceIncGlobal' + '}', namespace_inc_global.to_s)
50
63
 
@@ -67,6 +80,7 @@ module BlueprintClient
67
80
 
68
81
  # http body (model)
69
82
  post_body = @api_client.object_to_http_body(body)
83
+
70
84
  auth_names = ['oauth2']
71
85
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
72
86
  :header_params => header_params,
@@ -82,7 +96,7 @@ module BlueprintClient
82
96
  end
83
97
 
84
98
  #
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
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
86
100
  # @param namespace identifier namespacing the blueprint.
87
101
  # @param [Hash] opts the optional parameters
88
102
  # @return [nil]
@@ -92,7 +106,7 @@ module BlueprintClient
92
106
  end
93
107
 
94
108
  #
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
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
96
110
  # @param namespace identifier namespacing the blueprint.
97
111
  # @param [Hash] opts the optional parameters
98
112
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -100,8 +114,15 @@ module BlueprintClient
100
114
  if @api_client.config.debugging
101
115
  @api_client.config.logger.debug "Calling API: HierarchyApi.bulk_upload ..."
102
116
  end
117
+
118
+
103
119
  # verify the required parameter 'namespace' is set
104
120
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.bulk_upload" if namespace.nil?
121
+
122
+
123
+
124
+
125
+
105
126
  # resource path
106
127
  local_var_path = "/{namespace}/nodes.csv".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s)
107
128
 
@@ -124,7 +145,8 @@ module BlueprintClient
124
145
 
125
146
  # http body (model)
126
147
  post_body = nil
127
- auth_names = ['oauth2']
148
+
149
+ auth_names = ['oauth2']
128
150
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
129
151
  :header_params => header_params,
130
152
  :query_params => query_params,
@@ -160,12 +182,31 @@ module BlueprintClient
160
182
  if @api_client.config.debugging
161
183
  @api_client.config.logger.debug "Calling API: HierarchyApi.delete_node ..."
162
184
  end
185
+
186
+
163
187
  # verify the required parameter 'namespace' is set
164
188
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.delete_node" if namespace.nil?
189
+
190
+
191
+
192
+
193
+
194
+
165
195
  # verify the required parameter 'id' is set
166
196
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.delete_node" if id.nil?
197
+
198
+
199
+
200
+
201
+
202
+
167
203
  # verify the required parameter 'type' is set
168
204
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.delete_node" if type.nil?
205
+
206
+
207
+
208
+
209
+
169
210
  # resource path
170
211
  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)
171
212
 
@@ -188,7 +229,8 @@ module BlueprintClient
188
229
 
189
230
  # http body (model)
190
231
  post_body = nil
191
- auth_names = ['oauth2']
232
+
233
+ auth_names = ['oauth2']
192
234
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
193
235
  :header_params => header_params,
194
236
  :query_params => query_params,
@@ -202,7 +244,7 @@ module BlueprintClient
202
244
  end
203
245
 
204
246
  #
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
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
206
248
  # @param namespace identifier namespacing the blueprint.
207
249
  # @param [Hash] opts the optional parameters
208
250
  # @return [nil]
@@ -212,7 +254,7 @@ module BlueprintClient
212
254
  end
213
255
 
214
256
  #
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
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
216
258
  # @param namespace identifier namespacing the blueprint.
217
259
  # @param [Hash] opts the optional parameters
218
260
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -220,8 +262,15 @@ module BlueprintClient
220
262
  if @api_client.config.debugging
221
263
  @api_client.config.logger.debug "Calling API: HierarchyApi.export_hierarchy ..."
222
264
  end
265
+
266
+
223
267
  # verify the required parameter 'namespace' is set
224
268
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.export_hierarchy" if namespace.nil?
269
+
270
+
271
+
272
+
273
+
225
274
  # resource path
226
275
  local_var_path = "/{namespace}/nodes.csv".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s)
227
276
 
@@ -244,7 +293,8 @@ module BlueprintClient
244
293
 
245
294
  # http body (model)
246
295
  post_body = nil
247
- auth_names = ['oauth2']
296
+
297
+ auth_names = ['oauth2']
248
298
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
249
299
  :header_params => header_params,
250
300
  :query_params => query_params,
@@ -258,7 +308,7 @@ module BlueprintClient
258
308
  end
259
309
 
260
310
  # Get ancestor nodes
261
- # A proxy for finding ancestors of a given node, equivalent to `/1/abc/nodes?filter[descendant]=department%2Fdep101`
311
+ # A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
262
312
  # @param id id identifying a domain model
263
313
  # @param namespace identifier namespacing the blueprint.
264
314
  # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
@@ -272,7 +322,7 @@ module BlueprintClient
272
322
  end
273
323
 
274
324
  # Get ancestor nodes
275
- # A proxy for finding ancestors of a given node, equivalent to &#x60;/1/abc/nodes?filter[descendant]&#x3D;department%2Fdep101&#x60;
325
+ # A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
276
326
  # @param id id identifying a domain model
277
327
  # @param namespace identifier namespacing the blueprint.
278
328
  # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
@@ -284,12 +334,43 @@ module BlueprintClient
284
334
  if @api_client.config.debugging
285
335
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_ancestors ..."
286
336
  end
337
+
338
+
287
339
  # verify the required parameter 'id' is set
288
340
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_ancestors" if id.nil?
341
+
342
+
343
+
344
+
345
+
346
+
289
347
  # verify the required parameter 'namespace' is set
290
348
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_ancestors" if namespace.nil?
349
+
350
+
351
+
352
+
353
+
354
+
291
355
  # verify the required parameter 'type' is set
292
356
  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
+
293
374
  # resource path
294
375
  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)
295
376
 
@@ -314,7 +395,8 @@ module BlueprintClient
314
395
 
315
396
  # http body (model)
316
397
  post_body = nil
317
- auth_names = ['oauth2']
398
+
399
+ auth_names = ['oauth2']
318
400
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
319
401
  :header_params => header_params,
320
402
  :query_params => query_params,
@@ -329,7 +411,7 @@ module BlueprintClient
329
411
  end
330
412
 
331
413
  # Get child nodes
332
- # A proxy for finding children of a given node, equivalent to `/1/abc/nodes?filter[parent]=department%2Fdep101`
414
+ # A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
333
415
  # @param id id identifying a domain model
334
416
  # @param namespace identifier namespacing the blueprint.
335
417
  # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
@@ -343,7 +425,7 @@ module BlueprintClient
343
425
  end
344
426
 
345
427
  # Get child nodes
346
- # A proxy for finding children of a given node, equivalent to &#x60;/1/abc/nodes?filter[parent]&#x3D;department%2Fdep101&#x60;
428
+ # A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
347
429
  # @param id id identifying a domain model
348
430
  # @param namespace identifier namespacing the blueprint.
349
431
  # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
@@ -355,12 +437,43 @@ module BlueprintClient
355
437
  if @api_client.config.debugging
356
438
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_children ..."
357
439
  end
440
+
441
+
358
442
  # verify the required parameter 'id' is set
359
443
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_children" if id.nil?
444
+
445
+
446
+
447
+
448
+
449
+
360
450
  # verify the required parameter 'namespace' is set
361
451
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_children" if namespace.nil?
452
+
453
+
454
+
455
+
456
+
457
+
362
458
  # verify the required parameter 'type' is set
363
459
  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
+
364
477
  # resource path
365
478
  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)
366
479
 
@@ -385,7 +498,8 @@ module BlueprintClient
385
498
 
386
499
  # http body (model)
387
500
  post_body = nil
388
- auth_names = ['oauth2']
501
+
502
+ auth_names = ['oauth2']
389
503
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
390
504
  :header_params => header_params,
391
505
  :query_params => query_params,
@@ -400,7 +514,7 @@ module BlueprintClient
400
514
  end
401
515
 
402
516
  # Get descendant nodes
403
- # A proxy for finding descendants of a given node, equivalent to `/1/abc/nodes?filter[ancestor]=department%2Fdep101`
517
+ # A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
404
518
  # @param id id identifying a domain model
405
519
  # @param namespace identifier namespacing the blueprint.
406
520
  # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
@@ -414,7 +528,7 @@ module BlueprintClient
414
528
  end
415
529
 
416
530
  # Get descendant nodes
417
- # A proxy for finding descendants of a given node, equivalent to &#x60;/1/abc/nodes?filter[ancestor]&#x3D;department%2Fdep101&#x60;
531
+ # A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
418
532
  # @param id id identifying a domain model
419
533
  # @param namespace identifier namespacing the blueprint.
420
534
  # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
@@ -426,12 +540,43 @@ module BlueprintClient
426
540
  if @api_client.config.debugging
427
541
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_descendants ..."
428
542
  end
543
+
544
+
429
545
  # verify the required parameter 'id' is set
430
546
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_descendants" if id.nil?
547
+
548
+
549
+
550
+
551
+
552
+
431
553
  # verify the required parameter 'namespace' is set
432
554
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_descendants" if namespace.nil?
555
+
556
+
557
+
558
+
559
+
560
+
433
561
  # verify the required parameter 'type' is set
434
562
  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
+
435
580
  # resource path
436
581
  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)
437
582
 
@@ -456,7 +601,8 @@ module BlueprintClient
456
601
 
457
602
  # http body (model)
458
603
  post_body = nil
459
- auth_names = ['oauth2']
604
+
605
+ auth_names = ['oauth2']
460
606
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
461
607
  :header_params => header_params,
462
608
  :query_params => query_params,
@@ -495,15 +641,37 @@ module BlueprintClient
495
641
  if @api_client.config.debugging
496
642
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_node ..."
497
643
  end
644
+
645
+
498
646
  # verify the required parameter 'namespace' is set
499
647
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_node" if namespace.nil?
648
+
649
+
650
+
651
+
652
+
653
+
500
654
  # verify the required parameter 'id' is set
501
655
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_node" if id.nil?
656
+
657
+
658
+
659
+
660
+
661
+
502
662
  # verify the required parameter 'type' is set
503
663
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_node" if type.nil?
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
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
507
675
  # resource path
508
676
  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)
509
677
 
@@ -527,7 +695,8 @@ module BlueprintClient
527
695
 
528
696
  # http body (model)
529
697
  post_body = nil
530
- auth_names = ['oauth2']
698
+
699
+ auth_names = ['oauth2']
531
700
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
532
701
  :header_params => header_params,
533
702
  :query_params => query_params,
@@ -542,7 +711,7 @@ module BlueprintClient
542
711
  end
543
712
 
544
713
  # Get parent nodes
545
- # A proxy for finding parents of a given node, equivalent to `/1/abc/nodes?filter[child]=department%2Fdep101`
714
+ # A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
546
715
  # @param id id identifying a domain model
547
716
  # @param namespace identifier namespacing the blueprint.
548
717
  # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
@@ -556,7 +725,7 @@ module BlueprintClient
556
725
  end
557
726
 
558
727
  # Get parent nodes
559
- # A proxy for finding parents of a given node, equivalent to &#x60;/1/abc/nodes?filter[child]&#x3D;department%2Fdep101&#x60;
728
+ # A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
560
729
  # @param id id identifying a domain model
561
730
  # @param namespace identifier namespacing the blueprint.
562
731
  # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
@@ -568,12 +737,43 @@ module BlueprintClient
568
737
  if @api_client.config.debugging
569
738
  @api_client.config.logger.debug "Calling API: HierarchyApi.get_parents ..."
570
739
  end
740
+
741
+
571
742
  # verify the required parameter 'id' is set
572
743
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_parents" if id.nil?
744
+
745
+
746
+
747
+
748
+
749
+
573
750
  # verify the required parameter 'namespace' is set
574
751
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_parents" if namespace.nil?
752
+
753
+
754
+
755
+
756
+
757
+
575
758
  # verify the required parameter 'type' is set
576
759
  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
+
577
777
  # resource path
578
778
  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)
579
779
 
@@ -598,7 +798,8 @@ module BlueprintClient
598
798
 
599
799
  # http body (model)
600
800
  post_body = nil
601
- auth_names = ['oauth2']
801
+
802
+ auth_names = ['oauth2']
602
803
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
603
804
  :header_params => header_params,
604
805
  :query_params => query_params,
@@ -637,14 +838,39 @@ module BlueprintClient
637
838
  if @api_client.config.debugging
638
839
  @api_client.config.logger.debug "Calling API: HierarchyApi.replace_node ..."
639
840
  end
841
+
842
+
640
843
  # verify the required parameter 'namespace' is set
641
844
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.replace_node" if namespace.nil?
845
+
846
+
847
+
848
+
849
+
850
+
642
851
  # verify the required parameter 'id' is set
643
852
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.replace_node" if id.nil?
853
+
854
+
855
+
856
+
857
+
858
+
644
859
  # verify the required parameter 'body' is set
645
860
  fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.replace_node" if body.nil?
861
+
862
+
863
+
864
+
865
+
866
+
646
867
  # verify the required parameter 'type' is set
647
868
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.replace_node" if type.nil?
869
+
870
+
871
+
872
+
873
+
648
874
  # resource path
649
875
  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)
650
876
 
@@ -667,6 +893,7 @@ module BlueprintClient
667
893
 
668
894
  # http body (model)
669
895
  post_body = @api_client.object_to_http_body(body)
896
+
670
897
  auth_names = ['oauth2']
671
898
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
672
899
  :header_params => header_params,
@@ -682,8 +909,8 @@ module BlueprintClient
682
909
  end
683
910
 
684
911
  # Search nodes
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.
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]=Modules`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101`\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=modules%2Fabf203&filter[nodeType]=Departments` # <= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Modules&filter[ancestor]=departments%2FDEP101&filter[hasAssets]=true&filter[assetType]=Lists`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[assetType]=Lists`\n\n###### 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\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&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.
687
914
  # @param [Hash] opts the optional parameters
688
915
  # @option opts [Float] :offset index to start result set from
689
916
  # @option opts [Float] :limit number of records to return
@@ -709,8 +936,8 @@ module BlueprintClient
709
936
  end
710
937
 
711
938
  # Search nodes
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.
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]=Modules`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101`\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=modules%2Fabf203&amp;filter[nodeType]=Departments` # &lt;= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Modules&amp;filter[ancestor]=departments%2FDEP101&amp;filter[hasAssets]=true&amp;filter[assetType]=Lists`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Modules&amp;filter[hasAssets]=false&amp;filter[assetType]=Lists`\n\n###### 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\n`/1/global/nodes?filter[nodeType]=Modules&amp;filter[hasAssets]=false&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.
714
941
  # @param [Hash] opts the optional parameters
715
942
  # @option opts [Float] :offset index to start result set from
716
943
  # @option opts [Float] :limit number of records to return
@@ -734,11 +961,117 @@ module BlueprintClient
734
961
  if @api_client.config.debugging
735
962
  @api_client.config.logger.debug "Calling API: HierarchyApi.search_nodes ..."
736
963
  end
964
+
965
+
737
966
  # verify the required parameter 'namespace_inc_global' is set
738
967
  fail ArgumentError, "Missing the required parameter 'namespace_inc_global' when calling HierarchyApi.search_nodes" if namespace_inc_global.nil?
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
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
+
742
1075
  # resource path
743
1076
  local_var_path = "/{namespaceIncGlobal}/nodes".sub('{format}','json').sub('{' + 'namespaceIncGlobal' + '}', namespace_inc_global.to_s)
744
1077
 
@@ -778,7 +1111,8 @@ module BlueprintClient
778
1111
 
779
1112
  # http body (model)
780
1113
  post_body = nil
781
- auth_names = ['oauth2']
1114
+
1115
+ auth_names = ['oauth2']
782
1116
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
783
1117
  :header_params => header_params,
784
1118
  :query_params => query_params,
@@ -817,14 +1151,39 @@ module BlueprintClient
817
1151
  if @api_client.config.debugging
818
1152
  @api_client.config.logger.debug "Calling API: HierarchyApi.update_node ..."
819
1153
  end
1154
+
1155
+
820
1156
  # verify the required parameter 'namespace' is set
821
1157
  fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.update_node" if namespace.nil?
1158
+
1159
+
1160
+
1161
+
1162
+
1163
+
822
1164
  # verify the required parameter 'id' is set
823
1165
  fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.update_node" if id.nil?
1166
+
1167
+
1168
+
1169
+
1170
+
1171
+
824
1172
  # verify the required parameter 'body' is set
825
1173
  fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.update_node" if body.nil?
1174
+
1175
+
1176
+
1177
+
1178
+
1179
+
826
1180
  # verify the required parameter 'type' is set
827
1181
  fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.update_node" if type.nil?
1182
+
1183
+
1184
+
1185
+
1186
+
828
1187
  # resource path
829
1188
  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)
830
1189
 
@@ -847,6 +1206,7 @@ module BlueprintClient
847
1206
 
848
1207
  # http body (model)
849
1208
  post_body = @api_client.object_to_http_body(body)
1209
+
850
1210
  auth_names = ['oauth2']
851
1211
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
852
1212
  :header_params => header_params,