dropbox-sign 1.6.1 → 1.7.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 (71) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +15 -5
  4. data/VERSION +1 -1
  5. data/docs/AccountResponseQuotas.md +1 -1
  6. data/docs/FaxApi.md +364 -0
  7. data/docs/FaxGetResponse.md +11 -0
  8. data/docs/FaxListResponse.md +11 -0
  9. data/docs/FaxResponse.md +19 -0
  10. data/docs/FaxResponseTransmission.md +13 -0
  11. data/docs/FaxSendRequest.md +18 -0
  12. data/docs/OAuthTokenRefreshRequest.md +2 -0
  13. data/docs/SignatureRequestApi.md +1 -1
  14. data/docs/SubWhiteLabelingOptions.md +12 -12
  15. data/docs/TemplateApi.md +3 -3
  16. data/docs/TemplateResponse.md +2 -1
  17. data/docs/TemplateResponseDocumentFormFieldBase.md +0 -1
  18. data/docs/TemplateResponseDocumentFormFieldCheckbox.md +1 -0
  19. data/docs/TemplateResponseDocumentFormFieldDateSigned.md +1 -0
  20. data/docs/TemplateResponseDocumentFormFieldDropdown.md +1 -0
  21. data/docs/TemplateResponseDocumentFormFieldHyperlink.md +1 -0
  22. data/docs/TemplateResponseDocumentFormFieldInitials.md +1 -0
  23. data/docs/TemplateResponseDocumentFormFieldRadio.md +1 -0
  24. data/docs/TemplateResponseDocumentFormFieldSignature.md +1 -0
  25. data/docs/TemplateResponseDocumentFormFieldText.md +1 -0
  26. data/examples/FaxDelete.rb +14 -0
  27. data/examples/FaxFiles.rb +17 -0
  28. data/examples/FaxGet.rb +17 -0
  29. data/examples/FaxList.rb +18 -0
  30. data/examples/FaxSend.rb +25 -0
  31. data/lib/dropbox-sign/api/fax_api.rb +495 -0
  32. data/lib/dropbox-sign/api/o_auth_api.rb +28 -0
  33. data/lib/dropbox-sign/api/signature_request_api.rb +2 -2
  34. data/lib/dropbox-sign/api/template_api.rb +2 -2
  35. data/lib/dropbox-sign/models/account_response_quotas.rb +1 -1
  36. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +2 -1
  37. data/lib/dropbox-sign/models/fax_get_response.rb +263 -0
  38. data/lib/dropbox-sign/models/fax_list_response.rb +267 -0
  39. data/lib/dropbox-sign/models/fax_response.rb +399 -0
  40. data/lib/dropbox-sign/models/fax_response_transmission.rb +328 -0
  41. data/lib/dropbox-sign/models/fax_send_request.rb +345 -0
  42. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +26 -4
  43. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +12 -12
  44. data/lib/dropbox-sign/models/template_response.rb +22 -13
  45. data/lib/dropbox-sign/models/template_response_document.rb +1 -2
  46. data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +4 -16
  47. data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +16 -4
  48. data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +16 -4
  49. data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +16 -4
  50. data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +16 -4
  51. data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +16 -4
  52. data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +20 -4
  53. data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +16 -4
  54. data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +17 -5
  55. data/lib/dropbox-sign/version.rb +1 -1
  56. data/lib/dropbox-sign.rb +6 -0
  57. data/openapi-config.yaml +1 -1
  58. data/openapi-sdk.yaml +821 -112
  59. data/run-build +9 -0
  60. data/test_fixtures/ApiAppCreateRequest.json +10 -10
  61. data/test_fixtures/ApiAppGetResponse.json +18 -3
  62. data/test_fixtures/ApiAppListResponse.json +7 -1
  63. data/test_fixtures/ApiAppUpdateRequest.json +11 -11
  64. data/test_fixtures/FaxGetResponse.json +23 -0
  65. data/test_fixtures/FaxListResponse.json +31 -0
  66. data/test_fixtures/FaxSendRequest.json +14 -0
  67. data/test_fixtures/FaxSendResponse.json +16 -0
  68. data/test_fixtures/TeamGetResponse.json +5 -0
  69. data/test_fixtures/TemplateGetResponse.json +25 -478
  70. data/test_fixtures/TemplateListResponse.json +34 -5
  71. metadata +29 -8
data/test_fixtures/TemplateGetResponse.json CHANGED
@@ -5,7 +5,10 @@
5
5
  "title": "Mutual NDA",
6
6
  "message": "Please sign this NDA as soon as possible.",
7
7
  "updated_at": 1570471067,
8
+ "can_edit": true,
9
+ "is_creator": true,
8
10
  "is_embedded": false,
11
+ "is_locked": false,
9
12
  "metadata": {},
10
13
  "signer_roles": [
11
14
  {
@@ -566,496 +569,40 @@
566
569
  ]
567
570
  }
568
571
  ],
569
- "custom_fields": [
570
- {
571
- "name": "merge_field_1",
572
- "type": "text",
573
- "x": 417,
574
- "y": 219,
575
- "width": 72,
576
- "height": 15,
577
- "required": false,
578
- "api_id": "967c3e5f-2912-4f53-8ea3-c750652d29fc",
579
- "avg_text_length": {
580
- "num_lines": 1,
581
- "num_chars_per_line": 19
582
- },
583
- "isMultiline": false,
584
- "originalFontSize": 12,
585
- "fontFamily": "arial"
586
- },
587
- {
588
- "name": "merge_field_2",
589
- "type": "checkbox",
590
- "x": 515,
591
- "y": 346,
592
- "width": 18,
593
- "height": 18,
594
- "required": false,
595
- "api_id": "5e8fe02f-51cf-4f0b-b1d9-2b1e4f6ad07f"
596
- }
597
- ],
598
- "named_form_fields": [
599
- {
600
- "name": "Signature1",
601
- "type": "signature",
602
- "signer": "1",
603
- "x": 136,
604
- "y": 17,
605
- "width": 108,
606
- "height": 27,
607
- "required": true,
608
- "api_id": "8b6d78a5-0870-4f46-af9c-b78b54a49348"
609
- },
610
- {
611
- "name": "Textbox1",
612
- "type": "text",
613
- "signer": "1",
614
- "x": 328,
615
- "y": 17,
616
- "width": 144,
617
- "height": 14,
618
- "required": true,
619
- "api_id": "7ec10d80-53c9-433b-b252-0b8daa90a8e0",
620
- "avg_text_length": {
621
- "num_lines": 1,
622
- "num_chars_per_line": 38
623
- },
624
- "isMultiline": false,
625
- "originalFontSize": 12,
626
- "fontFamily": "arial"
627
- },
628
- {
629
- "name": "Textbox2",
630
- "type": "text",
631
- "signer": "1",
632
- "x": 328,
633
- "y": 48,
634
- "width": 144,
635
- "height": 14,
636
- "required": true,
637
- "api_id": "6574e6ad-7dac-49a2-9d56-650d7c5ade6e",
638
- "avg_text_length": {
639
- "num_lines": 1,
640
- "num_chars_per_line": 38
641
- },
642
- "isMultiline": false,
643
- "originalFontSize": 12,
644
- "fontFamily": "arial"
645
- },
646
- {
647
- "name": "Initial1",
648
- "type": "initials",
649
- "signer": "1",
650
- "x": 148,
651
- "y": 66,
652
- "width": 72,
653
- "height": 27,
654
- "required": true,
655
- "api_id": "30f41f54-c7f3-46c3-a29a-bb76ec40b552"
656
- },
657
- {
658
- "name": "Checkbox1",
659
- "type": "checkbox",
660
- "signer": "1",
661
- "x": 325,
662
- "y": 111,
663
- "width": 18,
664
- "height": 18,
665
- "required": false,
666
- "api_id": "d4d6ada9-e1dc-419e-bc0d-1478da694449",
667
- "group": "75a6e4b5fea47"
668
- },
669
- {
670
- "name": "Dropdown1",
671
- "type": "dropdown",
672
- "signer": "1",
673
- "x": 423,
674
- "y": 108,
675
- "width": 70,
676
- "height": 14,
677
- "required": true,
678
- "api_id": "5863be5e-ce5a-4c9d-aabe-c221914d73c2"
679
- },
680
- {
681
- "name": "DateSigned1",
682
- "type": "date_signed",
683
- "signer": "1",
684
- "x": 150,
685
- "y": 119,
686
- "width": 105,
687
- "height": 18,
688
- "required": true,
689
- "api_id": "9f6d3722-6db7-46da-8fac-3bc09f510262"
690
- },
691
- {
692
- "name": "Checkbox2",
693
- "type": "checkbox",
694
- "signer": "1",
695
- "x": 325,
696
- "y": 135,
697
- "width": 18,
698
- "height": 18,
699
- "required": false,
700
- "api_id": "edd732b8-b158-4714-a87b-503637d09ded",
701
- "group": "75a6e4b5fea47"
702
- },
703
- {
704
- "name": "FullName1",
705
- "type": "text",
706
- "signer": "1",
707
- "x": 144,
708
- "y": 158,
709
- "width": 72,
710
- "height": 14,
711
- "required": true,
712
- "api_id": "62fd3f85-4808-4011-8eae-a14ebe9105ef",
713
- "avg_text_length": {
714
- "num_lines": 1,
715
- "num_chars_per_line": 19
716
- },
717
- "isMultiline": false,
718
- "originalFontSize": 12,
719
- "fontFamily": "arial"
720
- },
721
- {
722
- "name": "Email1",
723
- "type": "text",
724
- "signer": "1",
725
- "x": 133,
726
- "y": 191,
727
- "width": 144,
728
- "height": 14,
729
- "required": true,
730
- "api_id": "a1c9bc6b-d498-4787-86e0-30ea779f06a7",
731
- "avg_text_length": {
732
- "num_lines": 1,
733
- "num_chars_per_line": 38
734
- },
735
- "isMultiline": false,
736
- "originalFontSize": 12,
737
- "fontFamily": "arial",
738
- "validation_type": "email_address"
739
- },
740
- {
741
- "name": "RadioItem1",
742
- "type": "radio",
743
- "signer": "1",
744
- "x": 307,
745
- "y": 211,
746
- "width": 18,
747
- "height": 18,
748
- "required": false,
749
- "api_id": "fc8a1277-f757-47a2-aeea-5113fa81f2d5",
750
- "group": "0831822584086"
751
- },
752
- {
753
- "name": "Company1",
754
- "type": "text",
755
- "signer": "1",
756
- "x": 128,
757
- "y": 221,
758
- "width": 144,
759
- "height": 14,
760
- "required": true,
761
- "api_id": "279b4e7f-e71f-426d-845c-6308cddde379",
762
- "avg_text_length": {
763
- "num_lines": 1,
764
- "num_chars_per_line": 38
765
- },
766
- "isMultiline": false,
767
- "originalFontSize": 12,
768
- "fontFamily": "arial"
769
- },
770
- {
771
- "name": "Title1",
772
- "type": "text",
773
- "signer": "1",
774
- "x": 127,
775
- "y": 250,
776
- "width": 144,
777
- "height": 14,
778
- "required": true,
779
- "api_id": "8809e39a-a46c-4dae-aaf9-06fc6355d80f",
780
- "avg_text_length": {
781
- "num_lines": 1,
782
- "num_chars_per_line": 38
783
- },
784
- "isMultiline": false,
785
- "originalFontSize": 12,
786
- "fontFamily": "arial"
787
- },
788
- {
789
- "name": "RadioItem2",
790
- "type": "radio",
791
- "signer": "1",
792
- "x": 307,
793
- "y": 253,
794
- "width": 18,
795
- "height": 18,
796
- "required": false,
797
- "api_id": "f7b6b70d-0522-4ab7-bfec-b86f147c8be3",
798
- "group": "0831822584086"
799
- },
800
- {
801
- "name": "Textbox3",
802
- "type": "text",
803
- "signer": "1",
804
- "x": 410,
805
- "y": 279,
806
- "width": 144,
807
- "height": 14,
808
- "required": true,
809
- "api_id": "bad7512a-e22b-46ed-ba03-123db0eda932",
810
- "avg_text_length": {
811
- "num_lines": 1,
812
- "num_chars_per_line": 38
813
- },
814
- "isMultiline": false,
815
- "originalFontSize": 12,
816
- "fontFamily": "arial"
817
- },
818
- {
819
- "name": "Textbox4",
820
- "type": "text",
821
- "signer": "1",
822
- "x": 101,
823
- "y": 314,
824
- "width": 72,
825
- "height": 14,
826
- "required": true,
827
- "api_id": "368ed029-bc93-4f92-8f7a-14c3bf8109b5",
828
- "avg_text_length": {
829
- "num_lines": 1,
830
- "num_chars_per_line": 19
831
- },
832
- "isMultiline": false,
833
- "originalFontSize": 12,
834
- "fontFamily": "arial",
835
- "validation_type": "custom_regex"
836
- },
837
- {
838
- "name": "Textbox8",
839
- "type": "text",
840
- "signer": "1",
841
- "x": 218,
842
- "y": 313,
843
- "width": 72,
844
- "height": 14,
845
- "required": true,
846
- "api_id": "ecf2ae95-d2e6-41b2-819a-836a6fa8c7c5",
847
- "avg_text_length": {
848
- "num_lines": 1,
849
- "num_chars_per_line": 19
850
- },
851
- "isMultiline": false,
852
- "originalFontSize": 12,
853
- "fontFamily": "arial",
854
- "validation_type": "bank_routing_number"
855
- },
856
- {
857
- "name": "Textbox12",
858
- "type": "text",
859
- "signer": "1",
860
- "x": 339,
861
- "y": 315,
862
- "width": 72,
863
- "height": 14,
864
- "required": true,
865
- "api_id": "3cb90a0a-a433-4f30-8af8-8fb4c747b704",
866
- "avg_text_length": {
867
- "num_lines": 1,
868
- "num_chars_per_line": 19
869
- },
870
- "isMultiline": false,
871
- "originalFontSize": 12,
872
- "fontFamily": "arial",
873
- "validation_type": "social_security_number"
874
- },
875
- {
876
- "name": "Textbox9",
877
- "type": "text",
878
- "signer": "1",
879
- "x": 224,
880
- "y": 343,
881
- "width": 72,
882
- "height": 14,
883
- "required": true,
884
- "api_id": "5b9eb331-c97d-435b-a563-d936a9b930c0",
885
- "avg_text_length": {
886
- "num_lines": 1,
887
- "num_chars_per_line": 19
888
- },
889
- "isMultiline": false,
890
- "originalFontSize": 12,
891
- "fontFamily": "arial",
892
- "validation_type": "bank_account_number"
893
- },
894
- {
895
- "name": "Textbox13",
896
- "type": "text",
897
- "signer": "1",
898
- "x": 339,
899
- "y": 345,
900
- "width": 72,
901
- "height": 14,
902
- "required": true,
903
- "api_id": "2b98ce7e-e53a-4cf8-a9f3-d7fb18d88631",
904
- "avg_text_length": {
905
- "num_lines": 1,
906
- "num_chars_per_line": 19
907
- },
908
- "isMultiline": false,
909
- "originalFontSize": 12,
910
- "fontFamily": "arial",
911
- "validation_type": "employer_identification_number"
912
- },
913
- {
914
- "name": "Textbox5",
915
- "type": "text",
916
- "signer": "1",
917
- "x": 113,
918
- "y": 350,
919
- "width": 72,
920
- "height": 14,
921
- "required": true,
922
- "api_id": "5f52c011-2c5f-4143-bf04-4694fb4a0d3f",
923
- "avg_text_length": {
924
- "num_lines": 1,
925
- "num_chars_per_line": 19
926
- },
927
- "isMultiline": false,
928
- "originalFontSize": 12,
929
- "fontFamily": "arial",
930
- "validation_type": "numbers_only"
931
- },
932
- {
933
- "name": "Textbox6",
934
- "type": "text",
935
- "signer": "1",
936
- "x": 122,
937
- "y": 374,
938
- "width": 72,
939
- "height": 14,
940
- "required": true,
941
- "api_id": "47457b7d-b1e8-41a0-93ad-60ba30e64bb1",
942
- "avg_text_length": {
943
- "num_lines": 1,
944
- "num_chars_per_line": 19
945
- },
946
- "isMultiline": false,
947
- "originalFontSize": 12,
948
- "fontFamily": "arial",
949
- "validation_type": "letters_only"
950
- },
951
- {
952
- "name": "Textbox10",
953
- "type": "text",
954
- "signer": "1",
955
- "x": 234,
956
- "y": 373,
957
- "width": 72,
958
- "height": 14,
959
- "required": true,
960
- "api_id": "18e3f994-1675-4d58-9b4a-4f92a2614551",
961
- "avg_text_length": {
962
- "num_lines": 1,
963
- "num_chars_per_line": 19
964
- },
965
- "isMultiline": false,
966
- "originalFontSize": 12,
967
- "fontFamily": "arial",
968
- "validation_type": "email_address"
969
- },
970
- {
971
- "name": "Textbox14",
972
- "type": "text",
973
- "signer": "1",
974
- "x": 339,
975
- "y": 376,
976
- "width": 72,
977
- "height": 14,
978
- "required": true,
979
- "api_id": "9ad4b8cc-bac9-432b-8836-9f80f86fc7e0",
980
- "avg_text_length": {
981
- "num_lines": 1,
982
- "num_chars_per_line": 19
983
- },
984
- "isMultiline": false,
985
- "originalFontSize": 12,
986
- "fontFamily": "arial"
987
- },
988
- {
989
- "name": "Textbox7",
990
- "type": "text",
991
- "signer": "1",
992
- "x": 130,
993
- "y": 401,
994
- "width": 72,
995
- "height": 14,
996
- "required": true,
997
- "api_id": "58c5f942-04fb-45f1-9703-5e8411f3a3bb",
998
- "avg_text_length": {
999
- "num_lines": 1,
1000
- "num_chars_per_line": 19
1001
- },
1002
- "isMultiline": false,
1003
- "originalFontSize": 12,
1004
- "fontFamily": "arial",
1005
- "validation_type": "phone_number"
1006
- },
1007
- {
1008
- "name": "me_now_hyperlink_1",
1009
- "type": "hyperlink",
1010
- "signer": "me_now",
1011
- "x": 434,
1012
- "y": 400,
1013
- "width": 112,
1014
- "height": 14,
1015
- "required": false,
1016
- "api_id": "fd928b56-cf59-40a4-9a90-62f97ffd0ddc",
1017
- "avg_text_length": {
1018
- "num_lines": 1,
1019
- "num_chars_per_line": 30
1020
- },
1021
- "isMultiline": false,
1022
- "originalFontSize": 12,
1023
- "fontFamily": "helvetica"
1024
- },
1025
- {
1026
- "name": "Textbox11",
1027
- "type": "text",
1028
- "signer": "1",
1029
- "x": 237,
1030
- "y": 405,
1031
- "width": 72,
1032
- "height": 14,
1033
- "required": true,
1034
- "api_id": "e48c388d-8c26-4f20-848e-f8587a631746",
1035
- "avg_text_length": {
1036
- "num_lines": 1,
1037
- "num_chars_per_line": 19
1038
- },
1039
- "isMultiline": false,
1040
- "originalFontSize": 12,
1041
- "fontFamily": "arial",
1042
- "validation_type": "zip_code"
1043
- }
1044
- ],
1045
572
  "accounts": [
1046
573
  {
1047
574
  "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
1048
575
  "email_address": "me@dropboxsign.com",
1049
576
  "is_locked": false,
1050
577
  "is_paid_hs": false,
1051
- "is_paid_hf": false
578
+ "is_paid_hf": false,
579
+ "quotas": {
580
+ "templates_left": 5,
581
+ "api_signature_requests_left": 5,
582
+ "documents_left": 5,
583
+ "sms_verifications_left": 0
584
+ }
1052
585
  },
1053
586
  {
1054
587
  "account_id": "",
1055
588
  "email_address": "teammate@dropboxsign.com",
1056
589
  "is_locked": false,
1057
590
  "is_paid_hs": false,
1058
- "is_paid_hf": false
591
+ "is_paid_hf": false,
592
+ "quotas": {
593
+ "templates_left": 5,
594
+ "api_signature_requests_left": 5,
595
+ "documents_left": 5,
596
+ "sms_verifications_left": 0
597
+ }
598
+ }
599
+ ],
600
+ "attachments": [
601
+ {
602
+ "id": "attachment_1",
603
+ "signer": "Outside Vendor",
604
+ "name": "Attachment #1",
605
+ "required": true
1059
606
  }
1060
607
  ]
1061
608
  }
data/test_fixtures/TemplateListResponse.json CHANGED
@@ -12,7 +12,10 @@
12
12
  "title": "Purchase order",
13
13
  "message": "",
14
14
  "updated_at": 1570471067,
15
+ "can_edit": true,
16
+ "is_creator": true,
15
17
  "is_embedded": false,
18
+ "is_locked": false,
16
19
  "metadata": {},
17
20
  "signer_roles": [
18
21
  {
@@ -49,7 +52,8 @@
49
52
  "originalFontSize": 12,
50
53
  "fontFamily": "arial"
51
54
  }
52
- ]
55
+ ],
56
+ "static_fields": []
53
57
  }
54
58
  ],
55
59
  "accounts": [
@@ -58,7 +62,21 @@
58
62
  "email_address": "me@dropboxsign.com",
59
63
  "is_locked": false,
60
64
  "is_paid_hs": false,
61
- "is_paid_hf": false
65
+ "is_paid_hf": false,
66
+ "quotas": {
67
+ "templates_left": 5,
68
+ "api_signature_requests_left": 5,
69
+ "documents_left": 5,
70
+ "sms_verifications_left": 0
71
+ }
72
+ }
73
+ ],
74
+ "attachments": [
75
+ {
76
+ "id": "attachment_1",
77
+ "signer": "Outside Vendor",
78
+ "name": "Attachment #1",
79
+ "required": true
62
80
  }
63
81
  ]
64
82
  },
@@ -67,7 +85,10 @@
67
85
  "title": "Mutual NDA",
68
86
  "message": "Please sign this NDA as soon as possible.",
69
87
  "updated_at": 1329478947,
88
+ "can_edit": true,
89
+ "is_creator": true,
70
90
  "is_embedded": false,
91
+ "is_locked": false,
71
92
  "metadata": {},
72
93
  "signer_roles": [
73
94
  {
@@ -564,7 +585,8 @@
564
585
  "fontFamily": "arial",
565
586
  "validation_type": "zip_code"
566
587
  }
567
- ]
588
+ ],
589
+ "static_fields": []
568
590
  }
569
591
  ],
570
592
  "accounts": [
@@ -573,9 +595,16 @@
573
595
  "email_address": "me@dropboxsign.com",
574
596
  "is_locked": false,
575
597
  "is_paid_hs": false,
576
- "is_paid_hf": false
598
+ "is_paid_hf": false,
599
+ "quotas": {
600
+ "templates_left": 5,
601
+ "api_signature_requests_left": 5,
602
+ "documents_left": 5,
603
+ "sms_verifications_left": 0
604
+ }
577
605
  }
578
- ]
606
+ ],
607
+ "attachments": []
579
608
  }
580
609
  ]
581
610
  }