aspose_diagram_cloud 19.10 → 20.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +72 -94
  3. data/lib/AsposeDiagramCloud.rb +11 -0
  4. data/lib/AsposeDiagramCloud/api/diagram_api.rb +468 -0
  5. data/lib/AsposeDiagramCloud/models/api_response_of_list_of_page_data.rb +190 -0
  6. data/lib/AsposeDiagramCloud/models/draw_shape_data.rb +262 -0
  7. data/lib/AsposeDiagramCloud/models/ellipse_data.rb +262 -0
  8. data/lib/AsposeDiagramCloud/models/line_data.rb +273 -0
  9. data/lib/AsposeDiagramCloud/models/page_data.rb +216 -0
  10. data/lib/AsposeDiagramCloud/models/page_setting.rb +219 -0
  11. data/lib/AsposeDiagramCloud/models/polyline_data.rb +273 -0
  12. data/lib/AsposeDiagramCloud/models/shape_data.rb +221 -0
  13. data/lib/AsposeDiagramCloud/models/shape_style_data.rb +189 -0
  14. data/lib/AsposeDiagramCloud/models/text_style_data.rb +253 -0
  15. data/lib/AsposeDiagramCloud/version.rb +1 -1
  16. data/spec/_spec.rb +308 -0
  17. data/spec/api/test_drawing_spec.rb +136 -0
  18. data/spec/api/test_page_spec.rb +92 -0
  19. metadata +18 -37
  20. data/docs/AccessTokenResponse.md +0 -15
  21. data/docs/CreateNewResponse.md +0 -8
  22. data/docs/DiagramApi.md +0 -241
  23. data/docs/DiagramSaveOptions.md +0 -10
  24. data/docs/DiscUsage.md +0 -9
  25. data/docs/Error.md +0 -11
  26. data/docs/ErrorDetails.md +0 -9
  27. data/docs/FileVersion.md +0 -14
  28. data/docs/FileVersions.md +0 -8
  29. data/docs/FilesList.md +0 -8
  30. data/docs/FilesUploadResult.md +0 -9
  31. data/docs/HTMLSaveOptions.md +0 -19
  32. data/docs/ImageSaveOptions.md +0 -29
  33. data/docs/ModifyResponse.md +0 -9
  34. data/docs/OAuthApi.md +0 -60
  35. data/docs/ObjectExist.md +0 -9
  36. data/docs/PageSize.md +0 -8
  37. data/docs/PdfDigitalSignatureDetails.md +0 -11
  38. data/docs/PdfEncryptionDetails.md +0 -11
  39. data/docs/PdfSaveOptions.md +0 -25
  40. data/docs/PointF.md +0 -10
  41. data/docs/RectangleF.md +0 -18
  42. data/docs/RenderingSaveOptions.md +0 -13
  43. data/docs/SVGSaveOptions.md +0 -18
  44. data/docs/SWFSaveOptions.md +0 -13
  45. data/docs/SaaSposeResponse.md +0 -7
  46. data/docs/SaveAsResponse.md +0 -10
  47. data/docs/SaveOptionsModel.md +0 -9
  48. data/docs/SaveOptionsRequest.md +0 -10
  49. data/docs/StorageApi.md +0 -799
  50. data/docs/StorageExist.md +0 -8
  51. data/docs/StorageFile.md +0 -12
  52. data/docs/UploadResponse.md +0 -8
  53. data/docs/XAMLSaveOptions.md +0 -12
  54. data/docs/XPSSaveOptions.md +0 -13
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 677332a0fed405cae7e5cd04feaf4c09b427eb5b
4
- data.tar.gz: aaf40b832efc82625ede388064f3557b1de4d398
3
+ metadata.gz: 57d547bbab413986d09a61a39e91b5a31d046939
4
+ data.tar.gz: a7273202c6ddbe67a2e69ab2e6d3b00206b9878b
5
5
  SHA512:
6
- metadata.gz: 1728f8e6d0e521ca1fa380436fa8318e55bfdd55f81511bdc2e7f2e38dc9964b2c625edc23b4d8c29e17f09930dade865fa852adaadfd7b2ab1947258f8cca9c
7
- data.tar.gz: 750335f8ed368be4c671a9336da16b0c9fb7e2364ef38e19d0db3cf7e78100d995e75b8fe236f20de3a95166991616a613e97e1ddd738a5ca305e67a4ca96013
6
+ metadata.gz: 2151090169d7badc345f3472feceed75e12b70c6019e7d130cfdf97e24ad19d5a69e83d85c8e1852a60abb7af2fd3acffc3edea99d9295546f53201dba5396f8
7
+ data.tar.gz: aed4ba9f93a4b2d513cf55cb0de76926cc2c659e2907cd306baa30e820dfe5d0a6c85908adb5431556d56fae9f3eb157f49faef1ab59919c936457f6df195d2f
data/README.md CHANGED
@@ -1,96 +1,74 @@
1
- [Aspose.Diagram Cloud](https://products.aspose.cloud/Diagram) helps you develop diagrams manipulation applications. Our REST API based Diagram Cloud SDK allows your applications to work with Microsoft Visio Object Model.
2
-
3
- This repository contains Aspose.Diagram Cloud SDK source code. This SDK allows you to work with Aspose.Diagram Cloud REST APIs in your applications quickly and easily, with zero initial cost.
4
-
5
- To use this SDK, you will need App SID and App Key which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (free registration in Aspose Cloud is required for this).
6
-
7
-
8
- # Features
9
-
10
- ### Support Import Formats
11
- * VSDX
12
- * VDX
13
- * VSD
14
- * VSX
15
- * VTX
16
- * VSSX
17
- * VSTX
18
- * VSDM
19
- * VSSM
20
- * VSTM
21
- * VDW
22
- * VSS
23
- * VST
24
-
25
- ### Support Export Formats
26
- * VSDX
27
- * VDX
28
- * VSX
29
- * VTX
30
- * VSSX
31
- * VSTX
32
- * VSDM
33
- * VSSM
34
- * VSTM
35
- * PDF
36
- * XPS
37
- * SWF
38
- * SVG
39
- * EMF
40
- * JPEG
41
- * PNG
42
- * BMP
43
- * TIFF
44
- * HTML
45
-
46
- ### Supported Operations
47
- * Convert document format
48
- * Create new document
49
- * Upload document and save it with supported format
50
- * Download document with supported format
51
-
52
- For the complete list of use-cases, please refer to [common operations format support map](https://docs.aspose.cloud/display/diagramcloud/Supported+File+Formats#SupportedFileFormats-CommonOperationsFormatSupportMap) to see what you can achieve!
53
-
54
-
55
- # Storage API support
56
- #### Since version 19.10, SDK includes support of storage operations for better user experience and unification, so now there's no need to use 2 different SDKs!
57
-
58
- It gives you an ability to:
59
- * Upload, download, copy, move and delete files, including versions handling (if you are using Cloud storage that supports this feature - true by default)
60
- * Create, copy, move and delete folders
61
- * Copy and move files and folders accross separate storages in scope of a single operation
62
- * Check if certain file, folder or storage exists
63
-
64
- # Examples
65
- Please, look at [Examples](EXAMPLES.md) document for basic usage or use the [Examples](Examples) folder for more sophisticated scenarios.
66
-
67
- ### Aspose Cloud-hosted service VS on-premise deployment (*experimental feature*)
68
- Starting from v19.10, you can choose either to use Aspose Cloud-hosted image processing service (the standard way) or the Docker image from Docker Hub deployed on-premise to serve the requests.
69
- The details about key differences and deployment process will be described on the dedicated Docker Hub page as soon as it's released.
1
+ # Ruby Cloud REST API for Visio Processing
70
2
 
71
- To succeed with your on-premise service usage by the SDK, you need to:
72
- 1. Use the new API class constructor with grantType parameter, clientId and clientSecret parameters.
73
- ```
74
- $diagramApi = AsposeDiagramCloud::DiagramApi.new($grant_type,$client_id,$client_secret)
3
+ This cloud SDK enables your Ruby cloud apps to [create & process Visio diagrams](https://products.aspose.cloud/diagram/ruby) from within your apps without installing Microsoft Visio.
4
+
5
+ ## Visio Processing Features
6
+
7
+ - Retrieve document information of a Visio diagram.
8
+ - Programmatically create a new Microsoft Visio diagram file.
9
+ - Convert Visio flow-charts to other supported formats.
10
+ - Upload your business oriented Visio diagrams to cloud storage.
11
+ - Export Visio files to raster images, fixed-layout and HTML formats.
12
+
13
+ ## New Features in Version 20.3
14
+
15
+ Added support to draw following objects on a page:
16
+ - Polyline
17
+ - Line
18
+ - Ellipse
19
+
20
+ Added support to:
21
+ - Set page setting
22
+ - Add new empty page
23
+ - Get pages info
24
+
25
+ For the detailed notes, please visit [Aspose.Diagram Cloud 20.3 Release Notes](https://docs.aspose.cloud/display/diagramcloud/Aspose.Diagram+Cloud+20.3+Release+Notes).
26
+
27
+ ## Read & Write Visio Formats
28
+
29
+ **Microsoft Visio:** VSDX, VSX, VTX, VDX, VSSX, VSTX, VSDM, VSSM, VSTM
30
+
31
+ ## Save Visio As
32
+
33
+ **Fixed Layout:** PDF, XPS
34
+ **Images:** JPEG, PNG, BMP, TIFF, SVG, EMF
35
+ **Web:** HTML
36
+ **Other:** XAML, SWF
37
+
38
+ ## Read Visio Formats
39
+
40
+ **Microsoft Visio:** VDW, VSD, VSS, VST
41
+
42
+ ## Getting Started with Aspose.Diagram Cloud SDK for Ruby
43
+
44
+ You do not need to install anything to get started with Aspose.Diagram Cloud SDK for Ruby. All you need to do is create an account at [Aspose for Cloud](https://dashboard.aspose.cloud/#/apps) and get your application information.
45
+
46
+ Please check the [GitHub Repository](https://github.com/aspose-diagram-cloud/aspose-diagram-cloud-dotnet) for other common usage scenarios.
47
+
48
+ ## Usage
49
+
50
+ Please, add the following [gem](https://rubygems.org/gems/aspose_diagram_cloud) to your project.
51
+
52
+ ```ruby
53
+ gem install aspose_diagram_cloud
75
54
  ```
76
- 2. Set *storage* or *storageName* parameters for each request where they're present (mandatory!).
77
-
78
- # Tests
79
- Tests are intended for internal usage only.
80
-
81
- # Licensing
82
- All Aspose.Diagram Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
83
-
84
- # Contact Us
85
- Your feedback is very important to us. Please feel free to contact via
86
- + [**Free Support Forum**](https://forum.aspose.cloud/c/diagram)
87
- + [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
88
-
89
- # Resources
90
- + [**Website**](https://www.aspose.cloud)
91
- + [**Product Home**](https://products.aspose.cloud/diagram)
92
- + [**Documentation**](https://docs.aspose.cloud/display/diagramcloud/Home)
93
- + [**API Reference**](https://apireference.aspose.cloud/diagram/)
94
- + [**Free Support Forum**](https://forum.aspose.cloud/c/diagram)
95
- + [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
96
- + [**Blog**](https://blog.aspose.cloud/category/diagram/
55
+
56
+ ### Aspose Cloud-hosted service VS on-premise deployment (experimental feature)
57
+
58
+ Starting from v19.10, you can choose either to use Aspose Cloud-hosted image processing service (the standard way) or the Docker image from Docker Hub deployed on-premise to serve the requests. The details about key differences and deployment process will be described on the dedicated Docker Hub page as soon as it's released.
59
+
60
+ To succeed with your on-premise service usage by the SDK, you need to:
61
+
62
+ - Use the new API class constructor with grantType parameter, clientId and clientSecret parameters.
63
+
64
+ ```ruby
65
+ $diagramApi = AsposeDiagramCloud::DiagramApi.new($grant_type,$client_id,$client_secret)
66
+ ```
67
+
68
+ - Set storage or storageName parameters for each request where they're present (mandatory!).
69
+
70
+ ## Licensing
71
+
72
+ All Aspose.Diagram Cloud SDKs, helper scripts and templates are licensed under [MIT License](https://github.com/aspose-diagram-cloud/aspose-diagram-cloud-ruby/blob/master/LICENSE).
73
+
74
+ [Product Page](https://products.aspose.cloud/diagram/net) | [Documentation](https://docs.aspose.cloud/display/diagramcloud/Home) | [Live Demo](https://products.aspose.app/diagram/family) | [API Reference](https://apireference.aspose.cloud/diagram/) | [Code Samples](https://github.com/aspose-diagram-cloud/aspose-diagram-cloud-dotnet) | [Blog](https://blog.aspose.cloud/category/diagram/) | [Free Support](https://forum.aspose.cloud/c/diagram) | [Free Trial](https://dashboard.aspose.cloud/#/apps)
@@ -49,6 +49,17 @@ require 'AsposeDiagramCloud/models/html_save_options'
49
49
  require 'AsposeDiagramCloud/models/image_save_options'
50
50
  require 'AsposeDiagramCloud/models/pdf_save_options'
51
51
  require 'AsposeDiagramCloud/models/svg_save_options'
52
+ require 'AsposeDiagramCloud/models/draw_shape_data'
53
+ require 'AsposeDiagramCloud/models/page_data'
54
+ require 'AsposeDiagramCloud/models/page_setting'
55
+ require 'AsposeDiagramCloud/models/point_f'
56
+ require 'AsposeDiagramCloud/models/shape_data'
57
+ require 'AsposeDiagramCloud/models/shape_style_data'
58
+ require 'AsposeDiagramCloud/models/text_style_data'
59
+ require 'AsposeDiagramCloud/models/api_response_of_list_of_page_data'
60
+ require 'AsposeDiagramCloud/models/ellipse_data'
61
+ require 'AsposeDiagramCloud/models/line_data'
62
+ require 'AsposeDiagramCloud/models/polyline_data'
52
63
 
53
64
  # APIs
54
65
  require 'AsposeDiagramCloud/api/diagram_api'
@@ -296,5 +296,473 @@ module AsposeDiagramCloud
296
296
  end
297
297
  return data, status_code, headers
298
298
  end
299
+
300
+ # draw ellipse on the page.
301
+ #
302
+ # @param name Document name.
303
+ # @param page_name Page name.
304
+ # @param ellipse_data drawing ellipse data.
305
+ # @param [Hash] opts the optional parameters
306
+ # @option opts [String] :folder Document folder.
307
+ # @return [ModifyResponse]
308
+ def put_draw_ellipse(name, page_name, ellipse_data, opts = {})
309
+ data, _status_code, _headers = put_draw_ellipse_with_http_info(name, page_name, ellipse_data, opts)
310
+ return data
311
+ end
312
+
313
+ # draw ellipse on the page.
314
+ #
315
+ # @param name Document name.
316
+ # @param page_name Page name.
317
+ # @param ellipse_data drawing ellipse data.
318
+ # @param [Hash] opts the optional parameters
319
+ # @option opts [String] :folder Document folder.
320
+ # @return [Array<(ModifyResponse, Fixnum, Hash)>] ModifyResponse data, response status code and response headers
321
+ def put_draw_ellipse_with_http_info(name, page_name, ellipse_data, opts = {})
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug "Calling API: DrawApi.put_draw_ellipse ..."
324
+ end
325
+ # verify the required parameter 'name' is set
326
+ if @api_client.config.client_side_validation && name.nil?
327
+ fail ArgumentError, "Missing the required parameter 'name' when calling DrawApi.put_draw_ellipse"
328
+ end
329
+ # verify the required parameter 'page_name' is set
330
+ if @api_client.config.client_side_validation && page_name.nil?
331
+ fail ArgumentError, "Missing the required parameter 'page_name' when calling DrawApi.put_draw_ellipse"
332
+ end
333
+ # verify the required parameter 'ellipse_data' is set
334
+ if @api_client.config.client_side_validation && ellipse_data.nil?
335
+ fail ArgumentError, "Missing the required parameter 'ellipse_data' when calling DrawApi.put_draw_ellipse"
336
+ end
337
+ # resource path
338
+ local_var_path = "/diagram/{name}/pages/{pageName}/drawEllipse".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageName' + '}', page_name.to_s)
339
+
340
+ # query parameters
341
+ query_params = {}
342
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
343
+
344
+ # header parameters
345
+ header_params = {}
346
+ # HTTP header 'Accept' (if needed)
347
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
348
+ # HTTP header 'Content-Type'
349
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
350
+
351
+ # form parameters
352
+ form_params = {}
353
+
354
+ # http body (model)
355
+ post_body = @api_client.object_to_http_body(ellipse_data)
356
+ auth_names = ['JWT']
357
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
358
+ :header_params => header_params,
359
+ :query_params => query_params,
360
+ :form_params => form_params,
361
+ :body => post_body,
362
+ :auth_names => auth_names,
363
+ :return_type => 'ModifyResponse')
364
+ if @api_client.config.debugging
365
+ @api_client.config.logger.debug "API called: DrawApi#put_draw_ellipse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
366
+ end
367
+ return data, status_code, headers
368
+ end
369
+
370
+ # draw line on the page.
371
+ #
372
+ # @param name Document name.
373
+ # @param page_name Page name.
374
+ # @param line_data drawing line data.
375
+ # @param [Hash] opts the optional parameters
376
+ # @option opts [String] :folder Document folder.
377
+ # @return [ModifyResponse]
378
+ def put_draw_line(name, page_name, line_data, opts = {})
379
+ data, _status_code, _headers = put_draw_line_with_http_info(name, page_name, line_data, opts)
380
+ return data
381
+ end
382
+
383
+ # draw line on the page.
384
+ #
385
+ # @param name Document name.
386
+ # @param page_name Page name.
387
+ # @param line_data drawing line data.
388
+ # @param [Hash] opts the optional parameters
389
+ # @option opts [String] :folder Document folder.
390
+ # @return [Array<(ModifyResponse, Fixnum, Hash)>] ModifyResponse data, response status code and response headers
391
+ def put_draw_line_with_http_info(name, page_name, line_data, opts = {})
392
+ if @api_client.config.debugging
393
+ @api_client.config.logger.debug "Calling API: DrawApi.put_draw_line ..."
394
+ end
395
+ # verify the required parameter 'name' is set
396
+ if @api_client.config.client_side_validation && name.nil?
397
+ fail ArgumentError, "Missing the required parameter 'name' when calling DrawApi.put_draw_line"
398
+ end
399
+ # verify the required parameter 'page_name' is set
400
+ if @api_client.config.client_side_validation && page_name.nil?
401
+ fail ArgumentError, "Missing the required parameter 'page_name' when calling DrawApi.put_draw_line"
402
+ end
403
+ # verify the required parameter 'line_data' is set
404
+ if @api_client.config.client_side_validation && line_data.nil?
405
+ fail ArgumentError, "Missing the required parameter 'line_data' when calling DrawApi.put_draw_line"
406
+ end
407
+ # resource path
408
+ local_var_path = "/diagram/{name}/pages/{pageName}/drawLine".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageName' + '}', page_name.to_s)
409
+
410
+ # query parameters
411
+ query_params = {}
412
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
413
+
414
+ # header parameters
415
+ header_params = {}
416
+ # HTTP header 'Accept' (if needed)
417
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
418
+ # HTTP header 'Content-Type'
419
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
420
+
421
+ # form parameters
422
+ form_params = {}
423
+
424
+ # http body (model)
425
+ post_body = @api_client.object_to_http_body(line_data)
426
+ auth_names = ['JWT']
427
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
428
+ :header_params => header_params,
429
+ :query_params => query_params,
430
+ :form_params => form_params,
431
+ :body => post_body,
432
+ :auth_names => auth_names,
433
+ :return_type => 'ModifyResponse')
434
+ if @api_client.config.debugging
435
+ @api_client.config.logger.debug "API called: DrawApi#put_draw_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
436
+ end
437
+ return data, status_code, headers
438
+ end
439
+
440
+ # draw polyline on the page.
441
+ #
442
+ # @param name Document name.
443
+ # @param page_name Page name.
444
+ # @param polyline_data drawing polyline data.
445
+ # @param [Hash] opts the optional parameters
446
+ # @option opts [String] :folder Document folder.
447
+ # @return [ModifyResponse]
448
+ def put_draw_polyline(name, page_name, polyline_data, opts = {})
449
+ data, _status_code, _headers = put_draw_polyline_with_http_info(name, page_name, polyline_data, opts)
450
+ return data
451
+ end
452
+
453
+ # draw polyline on the page.
454
+ #
455
+ # @param name Document name.
456
+ # @param page_name Page name.
457
+ # @param polyline_data drawing polyline data.
458
+ # @param [Hash] opts the optional parameters
459
+ # @option opts [String] :folder Document folder.
460
+ # @return [Array<(ModifyResponse, Fixnum, Hash)>] ModifyResponse data, response status code and response headers
461
+ def put_draw_polyline_with_http_info(name, page_name, polyline_data, opts = {})
462
+ if @api_client.config.debugging
463
+ @api_client.config.logger.debug "Calling API: DrawApi.put_draw_polyline ..."
464
+ end
465
+ # verify the required parameter 'name' is set
466
+ if @api_client.config.client_side_validation && name.nil?
467
+ fail ArgumentError, "Missing the required parameter 'name' when calling DrawApi.put_draw_polyline"
468
+ end
469
+ # verify the required parameter 'page_name' is set
470
+ if @api_client.config.client_side_validation && page_name.nil?
471
+ fail ArgumentError, "Missing the required parameter 'page_name' when calling DrawApi.put_draw_polyline"
472
+ end
473
+ # verify the required parameter 'polyline_data' is set
474
+ if @api_client.config.client_side_validation && polyline_data.nil?
475
+ fail ArgumentError, "Missing the required parameter 'polyline_data' when calling DrawApi.put_draw_polyline"
476
+ end
477
+ # resource path
478
+ local_var_path = "/diagram/{name}/pages/{pageName}/drawPolyline".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageName' + '}', page_name.to_s)
479
+
480
+ # query parameters
481
+ query_params = {}
482
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
483
+
484
+ # header parameters
485
+ header_params = {}
486
+ # HTTP header 'Accept' (if needed)
487
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
488
+ # HTTP header 'Content-Type'
489
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
490
+
491
+ # form parameters
492
+ form_params = {}
493
+
494
+ # http body (model)
495
+ post_body = @api_client.object_to_http_body(polyline_data)
496
+ auth_names = ['JWT']
497
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
498
+ :header_params => header_params,
499
+ :query_params => query_params,
500
+ :form_params => form_params,
501
+ :body => post_body,
502
+ :auth_names => auth_names,
503
+ :return_type => 'ModifyResponse')
504
+ if @api_client.config.debugging
505
+ @api_client.config.logger.debug "API called: DrawApi#put_draw_polyline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
506
+ end
507
+ return data, status_code, headers
508
+ end
509
+
510
+ # Remove Page
511
+ #
512
+ # @param name Document name.
513
+ # @param page_name The page name for delete.
514
+ # @param [Hash] opts the optional parameters
515
+ # @option opts [String] :folder Document folder.
516
+ # @return [ModifyResponse]
517
+ def delete_page(name, page_name, opts = {})
518
+ data, _status_code, _headers = delete_page_with_http_info(name, page_name, opts)
519
+ return data
520
+ end
521
+
522
+ # Remove Page
523
+ #
524
+ # @param name Document name.
525
+ # @param page_name The page name for delete.
526
+ # @param [Hash] opts the optional parameters
527
+ # @option opts [String] :folder Document folder.
528
+ # @return [Array<(ModifyResponse, Fixnum, Hash)>] ModifyResponse data, response status code and response headers
529
+ def delete_page_with_http_info(name, page_name, opts = {})
530
+ if @api_client.config.debugging
531
+ @api_client.config.logger.debug "Calling API: PageApi.delete_page ..."
532
+ end
533
+ # verify the required parameter 'name' is set
534
+ if @api_client.config.client_side_validation && name.nil?
535
+ fail ArgumentError, "Missing the required parameter 'name' when calling PageApi.delete_page"
536
+ end
537
+ # verify the required parameter 'page_name' is set
538
+ if @api_client.config.client_side_validation && page_name.nil?
539
+ fail ArgumentError, "Missing the required parameter 'page_name' when calling PageApi.delete_page"
540
+ end
541
+ # resource path
542
+ local_var_path = "/diagram/{name}/pages/{pageName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageName' + '}', page_name.to_s)
543
+
544
+ # query parameters
545
+ query_params = {}
546
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
547
+
548
+ # header parameters
549
+ header_params = {}
550
+ # HTTP header 'Accept' (if needed)
551
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
552
+ # HTTP header 'Content-Type'
553
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
554
+
555
+ # form parameters
556
+ form_params = {}
557
+
558
+ # http body (model)
559
+ post_body = nil
560
+ auth_names = ['JWT']
561
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
562
+ :header_params => header_params,
563
+ :query_params => query_params,
564
+ :form_params => form_params,
565
+ :body => post_body,
566
+ :auth_names => auth_names,
567
+ :return_type => 'ModifyResponse')
568
+ if @api_client.config.debugging
569
+ @api_client.config.logger.debug "API called: PageApi#delete_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
570
+ end
571
+ return data, status_code, headers
572
+ end
573
+
574
+ # Read pages info.
575
+ #
576
+ # @param name Document name.
577
+ # @param [Hash] opts the optional parameters
578
+ # @option opts [String] :folder Document folder.
579
+ # @return [ApiResponseOfListOfPageData]
580
+ def get_pages(name, opts = {})
581
+ data, _status_code, _headers = get_pages_with_http_info(name, opts)
582
+ return data
583
+ end
584
+
585
+ # Read pages info.
586
+ #
587
+ # @param name Document name.
588
+ # @param [Hash] opts the optional parameters
589
+ # @option opts [String] :folder Document folder.
590
+ # @return [Array<(ApiResponseOfListOfPageData, Fixnum, Hash)>] ApiResponseOfListOfPageData data, response status code and response headers
591
+ def get_pages_with_http_info(name, opts = {})
592
+ if @api_client.config.debugging
593
+ @api_client.config.logger.debug "Calling API: PageApi.get_pages ..."
594
+ end
595
+ # verify the required parameter 'name' is set
596
+ if @api_client.config.client_side_validation && name.nil?
597
+ fail ArgumentError, "Missing the required parameter 'name' when calling PageApi.get_pages"
598
+ end
599
+ # resource path
600
+ local_var_path = "/diagram/{name}/pages".sub('{' + 'name' + '}', name.to_s)
601
+
602
+ # query parameters
603
+ query_params = {}
604
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
605
+
606
+ # header parameters
607
+ header_params = {}
608
+ # HTTP header 'Accept' (if needed)
609
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
610
+ # HTTP header 'Content-Type'
611
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
612
+
613
+ # form parameters
614
+ form_params = {}
615
+
616
+ # http body (model)
617
+ post_body = nil
618
+ auth_names = ['JWT']
619
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
620
+ :header_params => header_params,
621
+ :query_params => query_params,
622
+ :form_params => form_params,
623
+ :body => post_body,
624
+ :auth_names => auth_names,
625
+ :return_type => 'ApiResponseOfListOfPageData')
626
+ if @api_client.config.debugging
627
+ @api_client.config.logger.debug "API called: PageApi#get_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
628
+ end
629
+ return data, status_code, headers
630
+ end
631
+
632
+ # page setup
633
+ #
634
+ # @param name Document name.
635
+ # @param page_name The page name for setting.
636
+ # @param page_setting Page setting info.
637
+ # @param [Hash] opts the optional parameters
638
+ # @option opts [String] :folder Document folder.
639
+ # @return [ModifyResponse]
640
+ def post_page_setup(name, page_name, page_setting, opts = {})
641
+ data, _status_code, _headers = post_page_setup_with_http_info(name, page_name, page_setting, opts)
642
+ return data
643
+ end
644
+
645
+ # page setup
646
+ #
647
+ # @param name Document name.
648
+ # @param page_name The page name for setting.
649
+ # @param page_setting Page setting info.
650
+ # @param [Hash] opts the optional parameters
651
+ # @option opts [String] :folder Document folder.
652
+ # @return [Array<(ModifyResponse, Fixnum, Hash)>] ModifyResponse data, response status code and response headers
653
+ def post_page_setup_with_http_info(name, page_name, page_setting, opts = {})
654
+ if @api_client.config.debugging
655
+ @api_client.config.logger.debug "Calling API: PageApi.post_page_setup ..."
656
+ end
657
+ # verify the required parameter 'name' is set
658
+ if @api_client.config.client_side_validation && name.nil?
659
+ fail ArgumentError, "Missing the required parameter 'name' when calling PageApi.post_page_setup"
660
+ end
661
+ # verify the required parameter 'page_name' is set
662
+ if @api_client.config.client_side_validation && page_name.nil?
663
+ fail ArgumentError, "Missing the required parameter 'page_name' when calling PageApi.post_page_setup"
664
+ end
665
+ # verify the required parameter 'page_setting' is set
666
+ if @api_client.config.client_side_validation && page_setting.nil?
667
+ fail ArgumentError, "Missing the required parameter 'page_setting' when calling PageApi.post_page_setup"
668
+ end
669
+ # resource path
670
+ local_var_path = "/diagram/{name}/pages/PageSetup".sub('{' + 'name' + '}', name.to_s)
671
+
672
+ # query parameters
673
+ query_params = {}
674
+ query_params[:'pageName'] = page_name
675
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
676
+
677
+ # header parameters
678
+ header_params = {}
679
+ # HTTP header 'Accept' (if needed)
680
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
681
+ # HTTP header 'Content-Type'
682
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
683
+
684
+ # form parameters
685
+ form_params = {}
686
+
687
+ # http body (model)
688
+ post_body = @api_client.object_to_http_body(page_setting)
689
+ auth_names = ['JWT']
690
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
691
+ :header_params => header_params,
692
+ :query_params => query_params,
693
+ :form_params => form_params,
694
+ :body => post_body,
695
+ :auth_names => auth_names,
696
+ :return_type => 'ModifyResponse')
697
+ if @api_client.config.debugging
698
+ @api_client.config.logger.debug "API called: PageApi#post_page_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
699
+ end
700
+ return data, status_code, headers
701
+ end
702
+
703
+ # Add new empty page
704
+ #
705
+ # @param name Document name.
706
+ # @param page_name New page name.
707
+ # @param [Hash] opts the optional parameters
708
+ # @option opts [String] :folder Document folder.
709
+ # @return [ModifyResponse]
710
+ def put_new_page(name, page_name, opts = {})
711
+ data, _status_code, _headers = put_new_page_with_http_info(name, page_name, opts)
712
+ return data
713
+ end
714
+
715
+ # Add new empty page
716
+ #
717
+ # @param name Document name.
718
+ # @param page_name New page name.
719
+ # @param [Hash] opts the optional parameters
720
+ # @option opts [String] :folder Document folder.
721
+ # @return [Array<(ModifyResponse, Fixnum, Hash)>] ModifyResponse data, response status code and response headers
722
+ def put_new_page_with_http_info(name, page_name, opts = {})
723
+ if @api_client.config.debugging
724
+ @api_client.config.logger.debug "Calling API: PageApi.put_new_page ..."
725
+ end
726
+ # verify the required parameter 'name' is set
727
+ if @api_client.config.client_side_validation && name.nil?
728
+ fail ArgumentError, "Missing the required parameter 'name' when calling PageApi.put_new_page"
729
+ end
730
+ # verify the required parameter 'page_name' is set
731
+ if @api_client.config.client_side_validation && page_name.nil?
732
+ fail ArgumentError, "Missing the required parameter 'page_name' when calling PageApi.put_new_page"
733
+ end
734
+ # resource path
735
+ local_var_path = "/diagram/{name}/pages/addNew".sub('{' + 'name' + '}', name.to_s)
736
+
737
+ # query parameters
738
+ query_params = {}
739
+ query_params[:'pageName'] = page_name
740
+ query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
741
+
742
+ # header parameters
743
+ header_params = {}
744
+ # HTTP header 'Accept' (if needed)
745
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
746
+ # HTTP header 'Content-Type'
747
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
748
+
749
+ # form parameters
750
+ form_params = {}
751
+
752
+ # http body (model)
753
+ post_body = nil
754
+ auth_names = ['JWT']
755
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
756
+ :header_params => header_params,
757
+ :query_params => query_params,
758
+ :form_params => form_params,
759
+ :body => post_body,
760
+ :auth_names => auth_names,
761
+ :return_type => 'ModifyResponse')
762
+ if @api_client.config.debugging
763
+ @api_client.config.logger.debug "API called: PageApi#put_new_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
764
+ end
765
+ return data, status_code, headers
766
+ end
299
767
  end
300
768
  end