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/run-build CHANGED
@@ -7,6 +7,15 @@ set -e
7
7
  DIR=$(cd `dirname $0` && pwd)
8
8
  WORKING_DIR="/app/ruby"
9
9
 
10
+ if [[ -n "$GITHUB_ACTIONS" ]]; then
11
+ printf "\nLogging in to docker.com ...\n"
12
+ echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin
13
+ fi
14
+
15
+ # cleanup
16
+ rm -f "${DIR}/lib/dropbox-sign/api/"*.rb
17
+ rm -f "${DIR}/lib/dropbox-sign/models/"*.rb
18
+
10
19
  docker run --rm \
11
20
  -v "${DIR}/:/local" \
12
21
  openapitools/openapi-generator-cli:v7.8.0 generate \
data/test_fixtures/ApiAppCreateRequest.json CHANGED
@@ -18,18 +18,18 @@
18
18
  "white_labeling_options": {
19
19
  "header_background_color": "#1A1A1A",
20
20
  "legal_version": "terms1",
21
- "link_color": "#00B3E6",
22
- "page_background_color": "#F7F8F9",
23
- "primary_button_color": "#00b3e6",
24
- "primary_button_color_hover": "#00B3E6",
21
+ "link_color": "#0061FE",
22
+ "page_background_color": "#f7f8f9",
23
+ "primary_button_color": "#0061FE",
24
+ "primary_button_color_hover": "#0061FE",
25
25
  "primary_button_text_color": "#ffffff",
26
- "primary_button_text_color_hover": "#FFFFFF",
27
- "secondary_button_color": "#FFFFFF",
28
- "secondary_button_color_hover": "#FFFFFF",
29
- "secondary_button_text_color": "#00B3E6",
30
- "secondary_button_text_color_hover": "#00B3E6",
26
+ "primary_button_text_color_hover": "#ffffff",
27
+ "secondary_button_color": "#ffffff",
28
+ "secondary_button_color_hover": "#ffffff",
29
+ "secondary_button_text_color": "#0061FE",
30
+ "secondary_button_text_color_hover": "#0061FE",
31
31
  "text_color1": "#808080",
32
- "text_color2": "#FFFFFF"
32
+ "text_color2": "#ffffff"
33
33
  }
34
34
  }
35
35
  }
data/test_fixtures/ApiAppGetResponse.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "is_approved": false,
8
8
  "name": "My Production App",
9
9
  "oauth": {
10
- "callback_url": "http://example.com/oauth",
10
+ "callback_url": "https://example.com/oauth",
11
11
  "scopes": [
12
12
  "basic_account_info",
13
13
  "request_signature"
@@ -15,13 +15,28 @@
15
15
  "charges_users": false,
16
16
  "secret": "98891a1b59f312d04cd88e4e0c498d75"
17
17
  },
18
+ "options": {
19
+ "can_insert_everywhere": true
20
+ },
18
21
  "owner_account": {
19
22
  "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888",
20
23
  "email_address": "john@example.com"
21
24
  },
22
25
  "white_labeling_options": {
23
- "primary_button_color": "#00b3e6",
24
- "primary_button_text_color": "#ffffff"
26
+ "header_background_color": "#1A1A1A",
27
+ "legal_version": "terms1",
28
+ "link_color": "#0061FE",
29
+ "page_background_color": "#f7f8f9",
30
+ "primary_button_color": "#0061FE",
31
+ "primary_button_color_hover": "#0061FE",
32
+ "primary_button_text_color": "#ffffff",
33
+ "primary_button_text_color_hover": "#ffffff",
34
+ "secondary_button_color": "#ffffff",
35
+ "secondary_button_color_hover": "#ffffff",
36
+ "secondary_button_text_color": "#0061FE",
37
+ "secondary_button_text_color_hover": "#0061FE",
38
+ "text_color1": "#808080",
39
+ "text_color2": "#ffffff"
25
40
  }
26
41
  }
27
42
  }
data/test_fixtures/ApiAppListResponse.json CHANGED
@@ -8,7 +8,7 @@
8
8
  "is_approved": true,
9
9
  "name": "My Production App",
10
10
  "oauth": {
11
- "callback_url": "http://example.com/oauth",
11
+ "callback_url": "https://example.com/oauth",
12
12
  "scopes": [
13
13
  "basic_account_info",
14
14
  "request_signature"
@@ -16,6 +16,9 @@
16
16
  "charges_users": false,
17
17
  "secret": "98891a1b59f312d04cd88e4e0c498d75"
18
18
  },
19
+ "options": {
20
+ "can_insert_everywhere": true
21
+ },
19
22
  "owner_account": {
20
23
  "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888",
21
24
  "email_address": "john@example.com"
@@ -27,6 +30,9 @@
27
30
  "domains": ["example.com"],
28
31
  "is_approved": false,
29
32
  "name": "My Other App",
33
+ "options": {
34
+ "can_insert_everywhere": true
35
+ },
30
36
  "owner_account": {
31
37
  "account_id": "dc5deeb9e10b044c591ef2475aafad1d1d3bd888",
32
38
  "email_address": "john@example.com"
data/test_fixtures/ApiAppUpdateRequest.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "domains": [
5
5
  "example.com"
6
6
  ],
7
- "callback_url": "http://example.com/dropboxsign",
7
+ "callback_url": "https://example.com/dropboxsign",
8
8
  "oauth": {
9
9
  "callback_url": "https://example.com/oauth",
10
10
  "scopes": [
@@ -18,18 +18,18 @@
18
18
  "white_labeling_options": {
19
19
  "header_background_color": "#1A1A1A",
20
20
  "legal_version": "terms1",
21
- "link_color": "#00B3E6",
22
- "page_background_color": "#F7F8F9",
23
- "primary_button_color": "#00b3e6",
24
- "primary_button_color_hover": "#00B3E6",
21
+ "link_color": "#0061FE",
22
+ "page_background_color": "#f7f8f9",
23
+ "primary_button_color": "#0061FE",
24
+ "primary_button_color_hover": "#0061FE",
25
25
  "primary_button_text_color": "#ffffff",
26
- "primary_button_text_color_hover": "#FFFFFF",
27
- "secondary_button_color": "#FFFFFF",
28
- "secondary_button_color_hover": "#FFFFFF",
29
- "secondary_button_text_color": "#00B3E6",
30
- "secondary_button_text_color_hover": "#00B3E6",
26
+ "primary_button_text_color_hover": "#ffffff",
27
+ "secondary_button_color": "#ffffff",
28
+ "secondary_button_color_hover": "#ffffff",
29
+ "secondary_button_text_color": "#0061FE",
30
+ "secondary_button_text_color_hover": "#0061FE",
31
31
  "text_color1": "#808080",
32
- "text_color2": "#FFFFFF"
32
+ "text_color2": "#ffffff"
33
33
  }
34
34
  }
35
35
  }
data/test_fixtures/FaxGetResponse.json ADDED
@@ -0,0 +1,23 @@
1
+ {
2
+ "default": {
3
+ "fax": {
4
+ "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d",
5
+ "title": "example title",
6
+ "original_title": "example original title",
7
+ "subject": "example subject",
8
+ "message": "example message",
9
+ "metadata": [],
10
+ "created_at": 1726774555,
11
+ "sender": "me@dropboxsign.com",
12
+ "transmissions": [
13
+ {
14
+ "recipient": "recipient@dropboxsign.com",
15
+ "sender": "me@dropboxsign.com",
16
+ "sent_at": 1723231831,
17
+ "status_code": "success"
18
+ }
19
+ ],
20
+ "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2",
21
+ }
22
+ }
23
+ }
data/test_fixtures/FaxListResponse.json ADDED
@@ -0,0 +1,31 @@
1
+ {
2
+ "default": {
3
+ "list_info": {
4
+ "num_pages": 1,
5
+ "num_results": 1,
6
+ "page": 1,
7
+ "page_size": 1
8
+ },
9
+ "faxes": [
10
+ {
11
+ "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d",
12
+ "title": "example title",
13
+ "original_title": "example original title",
14
+ "subject": "example subject",
15
+ "message": "example message",
16
+ "metadata": [],
17
+ "created_at": 1726774555,
18
+ "sender": "me@dropboxsign.com",
19
+ "transmissions": [
20
+ {
21
+ "recipient": "recipient@dropboxsign.com",
22
+ "sender": "me@dropboxsign.com",
23
+ "sent_at": 1723231831,
24
+ "status_code": "success"
25
+ }
26
+ ],
27
+ "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2",
28
+ }
29
+ ]
30
+ }
31
+ }
data/test_fixtures/FaxSendRequest.json ADDED
@@ -0,0 +1,14 @@
1
+ {
2
+ "default": {
3
+ "file_url": [
4
+ "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2"
5
+ ],
6
+ "test_mode": "true",
7
+ "recipient": "16690000001",
8
+ "sender": "16690000000",
9
+ "cover_page_to": "Jill Fax",
10
+ "cover_page_message": "I'm sending you a fax!",
11
+ "cover_page_from": "Faxer Faxerson",
12
+ "title": "This is what the fax is about!"
13
+ }
14
+ }
data/test_fixtures/FaxSendResponse.json ADDED
@@ -0,0 +1,16 @@
1
+ {
2
+ "default": {
3
+ "fax": {
4
+ "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d",
5
+ "title": "example title",
6
+ "original_title": "example original title",
7
+ "subject": "example subject",
8
+ "message": "example message",
9
+ "metadata": [ ],
10
+ "created_at": 1726774555,
11
+ "sender": "me@dropboxsign.com",
12
+ "transmissions": [],
13
+ "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2"
14
+ }
15
+ }
16
+ }
data/test_fixtures/TeamGetResponse.json CHANGED
@@ -28,6 +28,11 @@
28
28
  "api_signature_requests_left": 0
29
29
  }
30
30
  }
31
+ ],
32
+ "invited_emails": [
33
+ "invite_1@example.com",
34
+ "invite_2@example.com",
35
+ "invite_3@example.com"
31
36
  ]
32
37
  }
33
38
  }