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.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +15 -5
- data/VERSION +1 -1
- data/docs/AccountResponseQuotas.md +1 -1
- data/docs/FaxApi.md +364 -0
- data/docs/FaxGetResponse.md +11 -0
- data/docs/FaxListResponse.md +11 -0
- data/docs/FaxResponse.md +19 -0
- data/docs/FaxResponseTransmission.md +13 -0
- data/docs/FaxSendRequest.md +18 -0
- data/docs/OAuthTokenRefreshRequest.md +2 -0
- data/docs/SignatureRequestApi.md +1 -1
- data/docs/SubWhiteLabelingOptions.md +12 -12
- data/docs/TemplateApi.md +3 -3
- data/docs/TemplateResponse.md +2 -1
- data/docs/TemplateResponseDocumentFormFieldBase.md +0 -1
- data/docs/TemplateResponseDocumentFormFieldCheckbox.md +1 -0
- data/docs/TemplateResponseDocumentFormFieldDateSigned.md +1 -0
- data/docs/TemplateResponseDocumentFormFieldDropdown.md +1 -0
- data/docs/TemplateResponseDocumentFormFieldHyperlink.md +1 -0
- data/docs/TemplateResponseDocumentFormFieldInitials.md +1 -0
- data/docs/TemplateResponseDocumentFormFieldRadio.md +1 -0
- data/docs/TemplateResponseDocumentFormFieldSignature.md +1 -0
- data/docs/TemplateResponseDocumentFormFieldText.md +1 -0
- data/examples/FaxDelete.rb +14 -0
- data/examples/FaxFiles.rb +17 -0
- data/examples/FaxGet.rb +17 -0
- data/examples/FaxList.rb +18 -0
- data/examples/FaxSend.rb +25 -0
- data/lib/dropbox-sign/api/fax_api.rb +495 -0
- data/lib/dropbox-sign/api/o_auth_api.rb +28 -0
- data/lib/dropbox-sign/api/signature_request_api.rb +2 -2
- data/lib/dropbox-sign/api/template_api.rb +2 -2
- data/lib/dropbox-sign/models/account_response_quotas.rb +1 -1
- data/lib/dropbox-sign/models/api_app_response_o_auth.rb +2 -1
- data/lib/dropbox-sign/models/fax_get_response.rb +263 -0
- data/lib/dropbox-sign/models/fax_list_response.rb +267 -0
- data/lib/dropbox-sign/models/fax_response.rb +399 -0
- data/lib/dropbox-sign/models/fax_response_transmission.rb +328 -0
- data/lib/dropbox-sign/models/fax_send_request.rb +345 -0
- data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +26 -4
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +12 -12
- data/lib/dropbox-sign/models/template_response.rb +22 -13
- data/lib/dropbox-sign/models/template_response_document.rb +1 -2
- data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +4 -16
- data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +16 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +16 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +16 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +16 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +16 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +20 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +16 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +17 -5
- data/lib/dropbox-sign/version.rb +1 -1
- data/lib/dropbox-sign.rb +6 -0
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +821 -112
- data/run-build +9 -0
- data/test_fixtures/ApiAppCreateRequest.json +10 -10
- data/test_fixtures/ApiAppGetResponse.json +18 -3
- data/test_fixtures/ApiAppListResponse.json +7 -1
- data/test_fixtures/ApiAppUpdateRequest.json +11 -11
- data/test_fixtures/FaxGetResponse.json +23 -0
- data/test_fixtures/FaxListResponse.json +31 -0
- data/test_fixtures/FaxSendRequest.json +14 -0
- data/test_fixtures/FaxSendResponse.json +16 -0
- data/test_fixtures/TeamGetResponse.json +5 -0
- data/test_fixtures/TemplateGetResponse.json +25 -478
- data/test_fixtures/TemplateListResponse.json +34 -5
- metadata +29 -8
data/openapi-sdk.yaml
CHANGED
@@ -1409,6 +1409,304 @@ paths:
|
|
1409
1409
|
seo:
|
1410
1410
|
title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers'
|
1411
1411
|
description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.'
|
1412
|
+
'/fax/{fax_id}':
|
1413
|
+
get:
|
1414
|
+
tags:
|
1415
|
+
- Fax
|
1416
|
+
summary: 'Get Fax'
|
1417
|
+
description: 'Returns information about fax'
|
1418
|
+
operationId: faxGet
|
1419
|
+
parameters:
|
1420
|
+
-
|
1421
|
+
name: fax_id
|
1422
|
+
in: path
|
1423
|
+
description: 'Fax ID'
|
1424
|
+
required: true
|
1425
|
+
schema:
|
1426
|
+
type: string
|
1427
|
+
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
|
1428
|
+
responses:
|
1429
|
+
200:
|
1430
|
+
description: 'successful operation'
|
1431
|
+
headers:
|
1432
|
+
X-RateLimit-Limit:
|
1433
|
+
$ref: '#/components/headers/X-RateLimit-Limit'
|
1434
|
+
X-RateLimit-Remaining:
|
1435
|
+
$ref: '#/components/headers/X-RateLimit-Remaining'
|
1436
|
+
X-Ratelimit-Reset:
|
1437
|
+
$ref: '#/components/headers/X-Ratelimit-Reset'
|
1438
|
+
content:
|
1439
|
+
application/json:
|
1440
|
+
schema:
|
1441
|
+
$ref: '#/components/schemas/FaxGetResponse'
|
1442
|
+
examples:
|
1443
|
+
default_example:
|
1444
|
+
$ref: '#/components/examples/FaxGetResponseExample'
|
1445
|
+
4XX:
|
1446
|
+
description: failed_operation
|
1447
|
+
content:
|
1448
|
+
application/json:
|
1449
|
+
schema:
|
1450
|
+
$ref: '#/components/schemas/ErrorResponse'
|
1451
|
+
examples:
|
1452
|
+
400_example:
|
1453
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
1454
|
+
401_example:
|
1455
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
1456
|
+
402_example:
|
1457
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
1458
|
+
403_example:
|
1459
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
1460
|
+
404_example:
|
1461
|
+
$ref: '#/components/examples/Error404ResponseExample'
|
1462
|
+
429_example:
|
1463
|
+
$ref: '#/components/examples/Error429ResponseExample'
|
1464
|
+
4XX_example:
|
1465
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
1466
|
+
security:
|
1467
|
+
-
|
1468
|
+
api_key: []
|
1469
|
+
x-codeSamples:
|
1470
|
+
-
|
1471
|
+
lang: PHP
|
1472
|
+
label: PHP
|
1473
|
+
source:
|
1474
|
+
$ref: examples/FaxGet.php
|
1475
|
+
-
|
1476
|
+
lang: 'C#'
|
1477
|
+
label: 'C#'
|
1478
|
+
source:
|
1479
|
+
$ref: examples/FaxGet.cs
|
1480
|
+
-
|
1481
|
+
lang: JavaScript
|
1482
|
+
label: JavaScript
|
1483
|
+
source:
|
1484
|
+
$ref: examples/FaxGet.js
|
1485
|
+
-
|
1486
|
+
lang: TypeScript
|
1487
|
+
label: TypeScript
|
1488
|
+
source:
|
1489
|
+
$ref: examples/FaxGet.ts
|
1490
|
+
-
|
1491
|
+
lang: Java
|
1492
|
+
label: Java
|
1493
|
+
source:
|
1494
|
+
$ref: examples/FaxGet.java
|
1495
|
+
-
|
1496
|
+
lang: Ruby
|
1497
|
+
label: Ruby
|
1498
|
+
source:
|
1499
|
+
$ref: examples/FaxGet.rb
|
1500
|
+
-
|
1501
|
+
lang: Python
|
1502
|
+
label: Python
|
1503
|
+
source:
|
1504
|
+
$ref: examples/FaxGet.py
|
1505
|
+
-
|
1506
|
+
lang: cURL
|
1507
|
+
label: cURL
|
1508
|
+
source:
|
1509
|
+
$ref: examples/FaxGet.sh
|
1510
|
+
x-meta:
|
1511
|
+
seo:
|
1512
|
+
title: 'Get Fax | API Documentation | Dropbox Fax for Developers'
|
1513
|
+
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.'
|
1514
|
+
delete:
|
1515
|
+
tags:
|
1516
|
+
- Fax
|
1517
|
+
summary: 'Delete Fax'
|
1518
|
+
description: 'Deletes the specified Fax from the system.'
|
1519
|
+
operationId: faxDelete
|
1520
|
+
parameters:
|
1521
|
+
-
|
1522
|
+
name: fax_id
|
1523
|
+
in: path
|
1524
|
+
description: 'Fax ID'
|
1525
|
+
required: true
|
1526
|
+
schema:
|
1527
|
+
type: string
|
1528
|
+
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
|
1529
|
+
responses:
|
1530
|
+
204:
|
1531
|
+
description: 'successful operation'
|
1532
|
+
headers:
|
1533
|
+
X-RateLimit-Limit:
|
1534
|
+
$ref: '#/components/headers/X-RateLimit-Limit'
|
1535
|
+
X-RateLimit-Remaining:
|
1536
|
+
$ref: '#/components/headers/X-RateLimit-Remaining'
|
1537
|
+
X-Ratelimit-Reset:
|
1538
|
+
$ref: '#/components/headers/X-Ratelimit-Reset'
|
1539
|
+
4XX:
|
1540
|
+
description: failed_operation
|
1541
|
+
content:
|
1542
|
+
application/json:
|
1543
|
+
schema:
|
1544
|
+
$ref: '#/components/schemas/ErrorResponse'
|
1545
|
+
examples:
|
1546
|
+
400_example:
|
1547
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
1548
|
+
401_example:
|
1549
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
1550
|
+
402_example:
|
1551
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
1552
|
+
403_example:
|
1553
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
1554
|
+
404_example:
|
1555
|
+
$ref: '#/components/examples/Error404ResponseExample'
|
1556
|
+
429_example:
|
1557
|
+
$ref: '#/components/examples/Error429ResponseExample'
|
1558
|
+
4XX_example:
|
1559
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
1560
|
+
security:
|
1561
|
+
-
|
1562
|
+
api_key: []
|
1563
|
+
x-codeSamples:
|
1564
|
+
-
|
1565
|
+
lang: PHP
|
1566
|
+
label: PHP
|
1567
|
+
source:
|
1568
|
+
$ref: examples/FaxDelete.php
|
1569
|
+
-
|
1570
|
+
lang: 'C#'
|
1571
|
+
label: 'C#'
|
1572
|
+
source:
|
1573
|
+
$ref: examples/FaxDelete.cs
|
1574
|
+
-
|
1575
|
+
lang: JavaScript
|
1576
|
+
label: JavaScript
|
1577
|
+
source:
|
1578
|
+
$ref: examples/FaxDelete.js
|
1579
|
+
-
|
1580
|
+
lang: TypeScript
|
1581
|
+
label: TypeScript
|
1582
|
+
source:
|
1583
|
+
$ref: examples/FaxDelete.ts
|
1584
|
+
-
|
1585
|
+
lang: Java
|
1586
|
+
label: Java
|
1587
|
+
source:
|
1588
|
+
$ref: examples/FaxDelete.java
|
1589
|
+
-
|
1590
|
+
lang: Ruby
|
1591
|
+
label: Ruby
|
1592
|
+
source:
|
1593
|
+
$ref: examples/FaxDelete.rb
|
1594
|
+
-
|
1595
|
+
lang: Python
|
1596
|
+
label: Python
|
1597
|
+
source:
|
1598
|
+
$ref: examples/FaxDelete.py
|
1599
|
+
-
|
1600
|
+
lang: cURL
|
1601
|
+
label: cURL
|
1602
|
+
source:
|
1603
|
+
$ref: examples/FaxDelete.sh
|
1604
|
+
x-meta:
|
1605
|
+
seo:
|
1606
|
+
title: 'Delete Fax | API Documentation | Dropbox Fax for Developers'
|
1607
|
+
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.'
|
1608
|
+
'/fax/files/{fax_id}':
|
1609
|
+
get:
|
1610
|
+
tags:
|
1611
|
+
- Fax
|
1612
|
+
summary: 'List Fax Files'
|
1613
|
+
description: 'Returns list of fax files'
|
1614
|
+
operationId: faxFiles
|
1615
|
+
parameters:
|
1616
|
+
-
|
1617
|
+
name: fax_id
|
1618
|
+
in: path
|
1619
|
+
description: 'Fax ID'
|
1620
|
+
required: true
|
1621
|
+
schema:
|
1622
|
+
type: string
|
1623
|
+
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
|
1624
|
+
responses:
|
1625
|
+
200:
|
1626
|
+
description: 'successful operation'
|
1627
|
+
headers:
|
1628
|
+
X-RateLimit-Limit:
|
1629
|
+
$ref: '#/components/headers/X-RateLimit-Limit'
|
1630
|
+
X-RateLimit-Remaining:
|
1631
|
+
$ref: '#/components/headers/X-RateLimit-Remaining'
|
1632
|
+
X-Ratelimit-Reset:
|
1633
|
+
$ref: '#/components/headers/X-Ratelimit-Reset'
|
1634
|
+
content:
|
1635
|
+
application/pdf:
|
1636
|
+
schema:
|
1637
|
+
type: string
|
1638
|
+
format: binary
|
1639
|
+
4XX:
|
1640
|
+
description: failed_operation
|
1641
|
+
content:
|
1642
|
+
application/json:
|
1643
|
+
schema:
|
1644
|
+
$ref: '#/components/schemas/ErrorResponse'
|
1645
|
+
examples:
|
1646
|
+
400_example:
|
1647
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
1648
|
+
401_example:
|
1649
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
1650
|
+
402_example:
|
1651
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
1652
|
+
403_example:
|
1653
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
1654
|
+
404_example:
|
1655
|
+
$ref: '#/components/examples/Error404ResponseExample'
|
1656
|
+
410_example:
|
1657
|
+
$ref: '#/components/examples/Error410ResponseExample'
|
1658
|
+
429_example:
|
1659
|
+
$ref: '#/components/examples/Error429ResponseExample'
|
1660
|
+
4XX_example:
|
1661
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
1662
|
+
security:
|
1663
|
+
-
|
1664
|
+
api_key: []
|
1665
|
+
x-codeSamples:
|
1666
|
+
-
|
1667
|
+
lang: PHP
|
1668
|
+
label: PHP
|
1669
|
+
source:
|
1670
|
+
$ref: examples/FaxFiles.php
|
1671
|
+
-
|
1672
|
+
lang: 'C#'
|
1673
|
+
label: 'C#'
|
1674
|
+
source:
|
1675
|
+
$ref: examples/FaxFiles.cs
|
1676
|
+
-
|
1677
|
+
lang: JavaScript
|
1678
|
+
label: JavaScript
|
1679
|
+
source:
|
1680
|
+
$ref: examples/FaxFiles.js
|
1681
|
+
-
|
1682
|
+
lang: TypeScript
|
1683
|
+
label: TypeScript
|
1684
|
+
source:
|
1685
|
+
$ref: examples/FaxFiles.ts
|
1686
|
+
-
|
1687
|
+
lang: Java
|
1688
|
+
label: Java
|
1689
|
+
source:
|
1690
|
+
$ref: examples/FaxFiles.java
|
1691
|
+
-
|
1692
|
+
lang: Ruby
|
1693
|
+
label: Ruby
|
1694
|
+
source:
|
1695
|
+
$ref: examples/FaxFiles.rb
|
1696
|
+
-
|
1697
|
+
lang: Python
|
1698
|
+
label: Python
|
1699
|
+
source:
|
1700
|
+
$ref: examples/FaxFiles.py
|
1701
|
+
-
|
1702
|
+
lang: cURL
|
1703
|
+
label: cURL
|
1704
|
+
source:
|
1705
|
+
$ref: examples/FaxFiles.sh
|
1706
|
+
x-meta:
|
1707
|
+
seo:
|
1708
|
+
title: 'Fax Files | API Documentation | Dropbox Fax for Developers'
|
1709
|
+
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.'
|
1412
1710
|
/fax_line/add_user:
|
1413
1711
|
put:
|
1414
1712
|
tags:
|
@@ -1977,31 +2275,243 @@ paths:
|
|
1977
2275
|
lang: Python
|
1978
2276
|
label: Python
|
1979
2277
|
source:
|
1980
|
-
$ref: examples/FaxLineDelete.py
|
2278
|
+
$ref: examples/FaxLineDelete.py
|
2279
|
+
-
|
2280
|
+
lang: cURL
|
2281
|
+
label: cURL
|
2282
|
+
source:
|
2283
|
+
$ref: examples/FaxLineDelete.sh
|
2284
|
+
x-meta:
|
2285
|
+
seo:
|
2286
|
+
title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers'
|
2287
|
+
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.'
|
2288
|
+
/fax_line/list:
|
2289
|
+
get:
|
2290
|
+
tags:
|
2291
|
+
- 'Fax Line'
|
2292
|
+
summary: 'List Fax Lines'
|
2293
|
+
description: 'Returns the properties and settings of multiple Fax Lines.'
|
2294
|
+
operationId: faxLineList
|
2295
|
+
parameters:
|
2296
|
+
-
|
2297
|
+
name: account_id
|
2298
|
+
in: query
|
2299
|
+
description: 'Account ID'
|
2300
|
+
schema:
|
2301
|
+
type: string
|
2302
|
+
example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
|
2303
|
+
-
|
2304
|
+
name: page
|
2305
|
+
in: query
|
2306
|
+
description: Page
|
2307
|
+
schema:
|
2308
|
+
type: integer
|
2309
|
+
default: 1
|
2310
|
+
example: 1
|
2311
|
+
-
|
2312
|
+
name: page_size
|
2313
|
+
in: query
|
2314
|
+
description: 'Page size'
|
2315
|
+
schema:
|
2316
|
+
type: integer
|
2317
|
+
default: 20
|
2318
|
+
example: 20
|
2319
|
+
-
|
2320
|
+
name: show_team_lines
|
2321
|
+
in: query
|
2322
|
+
description: 'Show team lines'
|
2323
|
+
schema:
|
2324
|
+
type: boolean
|
2325
|
+
responses:
|
2326
|
+
200:
|
2327
|
+
description: 'successful operation'
|
2328
|
+
headers:
|
2329
|
+
X-RateLimit-Limit:
|
2330
|
+
$ref: '#/components/headers/X-RateLimit-Limit'
|
2331
|
+
X-RateLimit-Remaining:
|
2332
|
+
$ref: '#/components/headers/X-RateLimit-Remaining'
|
2333
|
+
X-Ratelimit-Reset:
|
2334
|
+
$ref: '#/components/headers/X-Ratelimit-Reset'
|
2335
|
+
content:
|
2336
|
+
application/json:
|
2337
|
+
schema:
|
2338
|
+
$ref: '#/components/schemas/FaxLineListResponse'
|
2339
|
+
examples:
|
2340
|
+
default_example:
|
2341
|
+
$ref: '#/components/examples/FaxLineListResponseExample'
|
2342
|
+
4XX:
|
2343
|
+
description: failed_operation
|
2344
|
+
content:
|
2345
|
+
application/json:
|
2346
|
+
schema:
|
2347
|
+
$ref: '#/components/schemas/ErrorResponse'
|
2348
|
+
examples:
|
2349
|
+
400_example:
|
2350
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
2351
|
+
401_example:
|
2352
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
2353
|
+
402_example:
|
2354
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
2355
|
+
403_example:
|
2356
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
2357
|
+
4XX_example:
|
2358
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
2359
|
+
security:
|
2360
|
+
-
|
2361
|
+
api_key: []
|
2362
|
+
x-codeSamples:
|
2363
|
+
-
|
2364
|
+
lang: PHP
|
2365
|
+
label: PHP
|
2366
|
+
source:
|
2367
|
+
$ref: examples/FaxLineList.php
|
2368
|
+
-
|
2369
|
+
lang: 'C#'
|
2370
|
+
label: 'C#'
|
2371
|
+
source:
|
2372
|
+
$ref: examples/FaxLineList.cs
|
2373
|
+
-
|
2374
|
+
lang: JavaScript
|
2375
|
+
label: JavaScript
|
2376
|
+
source:
|
2377
|
+
$ref: examples/FaxLineList.js
|
2378
|
+
-
|
2379
|
+
lang: TypeScript
|
2380
|
+
label: TypeScript
|
2381
|
+
source:
|
2382
|
+
$ref: examples/FaxLineList.ts
|
2383
|
+
-
|
2384
|
+
lang: Java
|
2385
|
+
label: Java
|
2386
|
+
source:
|
2387
|
+
$ref: examples/FaxLineList.java
|
2388
|
+
-
|
2389
|
+
lang: Ruby
|
2390
|
+
label: Ruby
|
2391
|
+
source:
|
2392
|
+
$ref: examples/FaxLineList.rb
|
2393
|
+
-
|
2394
|
+
lang: Python
|
2395
|
+
label: Python
|
2396
|
+
source:
|
2397
|
+
$ref: examples/FaxLineList.py
|
2398
|
+
-
|
2399
|
+
lang: cURL
|
2400
|
+
label: cURL
|
2401
|
+
source:
|
2402
|
+
$ref: examples/FaxLineList.sh
|
2403
|
+
x-meta:
|
2404
|
+
seo:
|
2405
|
+
title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers'
|
2406
|
+
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.'
|
2407
|
+
/fax_line/remove_user:
|
2408
|
+
put:
|
2409
|
+
tags:
|
2410
|
+
- 'Fax Line'
|
2411
|
+
summary: 'Remove Fax Line Access'
|
2412
|
+
description: 'Removes a user''s access to the specified Fax Line.'
|
2413
|
+
operationId: faxLineRemoveUser
|
2414
|
+
requestBody:
|
2415
|
+
required: true
|
2416
|
+
content:
|
2417
|
+
application/json:
|
2418
|
+
schema:
|
2419
|
+
$ref: '#/components/schemas/FaxLineRemoveUserRequest'
|
2420
|
+
examples:
|
2421
|
+
default_example:
|
2422
|
+
$ref: '#/components/examples/FaxLineRemoveUserRequestExample'
|
2423
|
+
responses:
|
2424
|
+
200:
|
2425
|
+
description: 'successful operation'
|
2426
|
+
headers:
|
2427
|
+
X-RateLimit-Limit:
|
2428
|
+
$ref: '#/components/headers/X-RateLimit-Limit'
|
2429
|
+
X-RateLimit-Remaining:
|
2430
|
+
$ref: '#/components/headers/X-RateLimit-Remaining'
|
2431
|
+
X-Ratelimit-Reset:
|
2432
|
+
$ref: '#/components/headers/X-Ratelimit-Reset'
|
2433
|
+
content:
|
2434
|
+
application/json:
|
2435
|
+
schema:
|
2436
|
+
$ref: '#/components/schemas/FaxLineResponse'
|
2437
|
+
examples:
|
2438
|
+
default_example:
|
2439
|
+
$ref: '#/components/examples/FaxLineResponseExample'
|
2440
|
+
4XX:
|
2441
|
+
description: failed_operation
|
2442
|
+
content:
|
2443
|
+
application/json:
|
2444
|
+
schema:
|
2445
|
+
$ref: '#/components/schemas/ErrorResponse'
|
2446
|
+
examples:
|
2447
|
+
400_example:
|
2448
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
2449
|
+
401_example:
|
2450
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
2451
|
+
402_example:
|
2452
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
2453
|
+
403_example:
|
2454
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
2455
|
+
404_example:
|
2456
|
+
$ref: '#/components/examples/Error404ResponseExample'
|
2457
|
+
4XX_example:
|
2458
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
2459
|
+
security:
|
2460
|
+
-
|
2461
|
+
api_key: []
|
2462
|
+
x-codeSamples:
|
2463
|
+
-
|
2464
|
+
lang: PHP
|
2465
|
+
label: PHP
|
2466
|
+
source:
|
2467
|
+
$ref: examples/FaxLineRemoveUser.php
|
2468
|
+
-
|
2469
|
+
lang: 'C#'
|
2470
|
+
label: 'C#'
|
2471
|
+
source:
|
2472
|
+
$ref: examples/FaxLineRemoveUser.cs
|
2473
|
+
-
|
2474
|
+
lang: JavaScript
|
2475
|
+
label: JavaScript
|
2476
|
+
source:
|
2477
|
+
$ref: examples/FaxLineRemoveUser.js
|
2478
|
+
-
|
2479
|
+
lang: TypeScript
|
2480
|
+
label: TypeScript
|
2481
|
+
source:
|
2482
|
+
$ref: examples/FaxLineRemoveUser.ts
|
2483
|
+
-
|
2484
|
+
lang: Java
|
2485
|
+
label: Java
|
2486
|
+
source:
|
2487
|
+
$ref: examples/FaxLineRemoveUser.java
|
2488
|
+
-
|
2489
|
+
lang: Ruby
|
2490
|
+
label: Ruby
|
2491
|
+
source:
|
2492
|
+
$ref: examples/FaxLineRemoveUser.rb
|
2493
|
+
-
|
2494
|
+
lang: Python
|
2495
|
+
label: Python
|
2496
|
+
source:
|
2497
|
+
$ref: examples/FaxLineRemoveUser.py
|
1981
2498
|
-
|
1982
2499
|
lang: cURL
|
1983
2500
|
label: cURL
|
1984
2501
|
source:
|
1985
|
-
$ref: examples/
|
2502
|
+
$ref: examples/FaxLineRemoveUser.sh
|
1986
2503
|
x-meta:
|
1987
2504
|
seo:
|
1988
|
-
title: '
|
1989
|
-
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to
|
1990
|
-
/
|
2505
|
+
title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers'
|
2506
|
+
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.'
|
2507
|
+
/fax/list:
|
1991
2508
|
get:
|
1992
2509
|
tags:
|
1993
|
-
-
|
1994
|
-
summary: '
|
1995
|
-
description: 'Returns
|
1996
|
-
operationId:
|
2510
|
+
- Fax
|
2511
|
+
summary: 'Lists Faxes'
|
2512
|
+
description: 'Returns properties of multiple faxes'
|
2513
|
+
operationId: faxList
|
1997
2514
|
parameters:
|
1998
|
-
-
|
1999
|
-
name: account_id
|
2000
|
-
in: query
|
2001
|
-
description: 'Account ID'
|
2002
|
-
schema:
|
2003
|
-
type: string
|
2004
|
-
example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
|
2005
2515
|
-
|
2006
2516
|
name: page
|
2007
2517
|
in: query
|
@@ -2009,6 +2519,7 @@ paths:
|
|
2009
2519
|
schema:
|
2010
2520
|
type: integer
|
2011
2521
|
default: 1
|
2522
|
+
minimum: 1
|
2012
2523
|
example: 1
|
2013
2524
|
-
|
2014
2525
|
name: page_size
|
@@ -2017,13 +2528,9 @@ paths:
|
|
2017
2528
|
schema:
|
2018
2529
|
type: integer
|
2019
2530
|
default: 20
|
2531
|
+
maximum: 100
|
2532
|
+
minimum: 1
|
2020
2533
|
example: 20
|
2021
|
-
-
|
2022
|
-
name: show_team_lines
|
2023
|
-
in: query
|
2024
|
-
description: 'Show team lines'
|
2025
|
-
schema:
|
2026
|
-
type: boolean
|
2027
2534
|
responses:
|
2028
2535
|
200:
|
2029
2536
|
description: 'successful operation'
|
@@ -2037,10 +2544,10 @@ paths:
|
|
2037
2544
|
content:
|
2038
2545
|
application/json:
|
2039
2546
|
schema:
|
2040
|
-
$ref: '#/components/schemas/
|
2547
|
+
$ref: '#/components/schemas/FaxListResponse'
|
2041
2548
|
examples:
|
2042
2549
|
default_example:
|
2043
|
-
$ref: '#/components/examples/
|
2550
|
+
$ref: '#/components/examples/FaxListResponseExample'
|
2044
2551
|
4XX:
|
2045
2552
|
description: failed_operation
|
2046
2553
|
content:
|
@@ -2066,62 +2573,65 @@ paths:
|
|
2066
2573
|
lang: PHP
|
2067
2574
|
label: PHP
|
2068
2575
|
source:
|
2069
|
-
$ref: examples/
|
2576
|
+
$ref: examples/FaxList.php
|
2070
2577
|
-
|
2071
2578
|
lang: 'C#'
|
2072
2579
|
label: 'C#'
|
2073
2580
|
source:
|
2074
|
-
$ref: examples/
|
2581
|
+
$ref: examples/FaxList.cs
|
2075
2582
|
-
|
2076
2583
|
lang: JavaScript
|
2077
2584
|
label: JavaScript
|
2078
2585
|
source:
|
2079
|
-
$ref: examples/
|
2586
|
+
$ref: examples/FaxList.js
|
2080
2587
|
-
|
2081
2588
|
lang: TypeScript
|
2082
2589
|
label: TypeScript
|
2083
2590
|
source:
|
2084
|
-
$ref: examples/
|
2591
|
+
$ref: examples/FaxList.ts
|
2085
2592
|
-
|
2086
2593
|
lang: Java
|
2087
2594
|
label: Java
|
2088
2595
|
source:
|
2089
|
-
$ref: examples/
|
2596
|
+
$ref: examples/FaxList.java
|
2090
2597
|
-
|
2091
2598
|
lang: Ruby
|
2092
2599
|
label: Ruby
|
2093
2600
|
source:
|
2094
|
-
$ref: examples/
|
2601
|
+
$ref: examples/FaxList.rb
|
2095
2602
|
-
|
2096
2603
|
lang: Python
|
2097
2604
|
label: Python
|
2098
2605
|
source:
|
2099
|
-
$ref: examples/
|
2606
|
+
$ref: examples/FaxList.py
|
2100
2607
|
-
|
2101
2608
|
lang: cURL
|
2102
2609
|
label: cURL
|
2103
2610
|
source:
|
2104
|
-
$ref: examples/
|
2611
|
+
$ref: examples/FaxList.sh
|
2105
2612
|
x-meta:
|
2106
2613
|
seo:
|
2107
|
-
title: 'List
|
2108
|
-
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your
|
2109
|
-
/
|
2110
|
-
|
2614
|
+
title: 'List Faxes | API Documentation | Dropbox Fax for Developers'
|
2615
|
+
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.'
|
2616
|
+
/fax/send:
|
2617
|
+
post:
|
2111
2618
|
tags:
|
2112
|
-
-
|
2113
|
-
summary: '
|
2114
|
-
description: '
|
2115
|
-
operationId:
|
2619
|
+
- Fax
|
2620
|
+
summary: 'Send Fax'
|
2621
|
+
description: 'Action to prepare and send a fax'
|
2622
|
+
operationId: faxSend
|
2116
2623
|
requestBody:
|
2117
2624
|
required: true
|
2118
2625
|
content:
|
2119
2626
|
application/json:
|
2120
2627
|
schema:
|
2121
|
-
$ref: '#/components/schemas/
|
2628
|
+
$ref: '#/components/schemas/FaxSendRequest'
|
2122
2629
|
examples:
|
2123
2630
|
default_example:
|
2124
|
-
$ref: '#/components/examples/
|
2631
|
+
$ref: '#/components/examples/FaxSendRequestExample'
|
2632
|
+
multipart/form-data:
|
2633
|
+
schema:
|
2634
|
+
$ref: '#/components/schemas/FaxSendRequest'
|
2125
2635
|
responses:
|
2126
2636
|
200:
|
2127
2637
|
description: 'successful operation'
|
@@ -2135,10 +2645,10 @@ paths:
|
|
2135
2645
|
content:
|
2136
2646
|
application/json:
|
2137
2647
|
schema:
|
2138
|
-
$ref: '#/components/schemas/
|
2648
|
+
$ref: '#/components/schemas/FaxGetResponse'
|
2139
2649
|
examples:
|
2140
2650
|
default_example:
|
2141
|
-
$ref: '#/components/examples/
|
2651
|
+
$ref: '#/components/examples/FaxGetResponseExample'
|
2142
2652
|
4XX:
|
2143
2653
|
description: failed_operation
|
2144
2654
|
content:
|
@@ -2156,6 +2666,8 @@ paths:
|
|
2156
2666
|
$ref: '#/components/examples/Error403ResponseExample'
|
2157
2667
|
404_example:
|
2158
2668
|
$ref: '#/components/examples/Error404ResponseExample'
|
2669
|
+
429_example:
|
2670
|
+
$ref: '#/components/examples/Error429ResponseExample'
|
2159
2671
|
4XX_example:
|
2160
2672
|
$ref: '#/components/examples/Error4XXResponseExample'
|
2161
2673
|
security:
|
@@ -2166,46 +2678,46 @@ paths:
|
|
2166
2678
|
lang: PHP
|
2167
2679
|
label: PHP
|
2168
2680
|
source:
|
2169
|
-
$ref: examples/
|
2681
|
+
$ref: examples/FaxSend.php
|
2170
2682
|
-
|
2171
2683
|
lang: 'C#'
|
2172
2684
|
label: 'C#'
|
2173
2685
|
source:
|
2174
|
-
$ref: examples/
|
2686
|
+
$ref: examples/FaxSend.cs
|
2175
2687
|
-
|
2176
2688
|
lang: JavaScript
|
2177
2689
|
label: JavaScript
|
2178
2690
|
source:
|
2179
|
-
$ref: examples/
|
2691
|
+
$ref: examples/FaxSend.js
|
2180
2692
|
-
|
2181
2693
|
lang: TypeScript
|
2182
2694
|
label: TypeScript
|
2183
2695
|
source:
|
2184
|
-
$ref: examples/
|
2696
|
+
$ref: examples/FaxSend.ts
|
2185
2697
|
-
|
2186
2698
|
lang: Java
|
2187
2699
|
label: Java
|
2188
2700
|
source:
|
2189
|
-
$ref: examples/
|
2701
|
+
$ref: examples/FaxSend.java
|
2190
2702
|
-
|
2191
2703
|
lang: Ruby
|
2192
2704
|
label: Ruby
|
2193
2705
|
source:
|
2194
|
-
$ref: examples/
|
2706
|
+
$ref: examples/FaxSend.rb
|
2195
2707
|
-
|
2196
2708
|
lang: Python
|
2197
2709
|
label: Python
|
2198
2710
|
source:
|
2199
|
-
$ref: examples/
|
2711
|
+
$ref: examples/FaxSend.py
|
2200
2712
|
-
|
2201
2713
|
lang: cURL
|
2202
2714
|
label: cURL
|
2203
2715
|
source:
|
2204
|
-
$ref: examples/
|
2716
|
+
$ref: examples/FaxSend.sh
|
2205
2717
|
x-meta:
|
2206
2718
|
seo:
|
2207
|
-
title: 'Fax
|
2208
|
-
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to
|
2719
|
+
title: 'Send Fax| API Documentation | Dropbox Fax for Developers'
|
2720
|
+
description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.'
|
2209
2721
|
/oauth/token:
|
2210
2722
|
post:
|
2211
2723
|
tags:
|
@@ -2239,6 +2751,23 @@ paths:
|
|
2239
2751
|
examples:
|
2240
2752
|
default_example:
|
2241
2753
|
$ref: '#/components/examples/OAuthTokenGenerateResponseExample'
|
2754
|
+
4XX:
|
2755
|
+
description: failed_operation
|
2756
|
+
content:
|
2757
|
+
application/json:
|
2758
|
+
schema:
|
2759
|
+
$ref: '#/components/schemas/ErrorResponse'
|
2760
|
+
examples:
|
2761
|
+
400_example:
|
2762
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
2763
|
+
401_example:
|
2764
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
2765
|
+
402_example:
|
2766
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
2767
|
+
403_example:
|
2768
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
2769
|
+
4XX_example:
|
2770
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
2242
2771
|
security: []
|
2243
2772
|
servers:
|
2244
2773
|
-
|
@@ -2322,6 +2851,23 @@ paths:
|
|
2322
2851
|
examples:
|
2323
2852
|
default_example:
|
2324
2853
|
$ref: '#/components/examples/OAuthTokenRefreshResponseExample'
|
2854
|
+
4XX:
|
2855
|
+
description: failed_operation
|
2856
|
+
content:
|
2857
|
+
application/json:
|
2858
|
+
schema:
|
2859
|
+
$ref: '#/components/schemas/ErrorResponse'
|
2860
|
+
examples:
|
2861
|
+
400_example:
|
2862
|
+
$ref: '#/components/examples/Error400ResponseExample'
|
2863
|
+
401_example:
|
2864
|
+
$ref: '#/components/examples/Error401ResponseExample'
|
2865
|
+
402_example:
|
2866
|
+
$ref: '#/components/examples/Error402ResponseExample'
|
2867
|
+
403_example:
|
2868
|
+
$ref: '#/components/examples/Error403ResponseExample'
|
2869
|
+
4XX_example:
|
2870
|
+
$ref: '#/components/examples/Error4XXResponseExample'
|
2325
2871
|
security: []
|
2326
2872
|
servers:
|
2327
2873
|
-
|
@@ -2703,7 +3249,7 @@ paths:
|
|
2703
3249
|
|
2704
3250
|
The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued.
|
2705
3251
|
|
2706
|
-
This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a
|
3252
|
+
This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.
|
2707
3253
|
|
2708
3254
|
To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.
|
2709
3255
|
|
@@ -4617,7 +5163,7 @@ paths:
|
|
4617
5163
|
403_example:
|
4618
5164
|
$ref: '#/components/examples/Error403ResponseExample'
|
4619
5165
|
404_example:
|
4620
|
-
$ref: '#/components/examples/
|
5166
|
+
$ref: '#/components/examples/Error404ResponseExample'
|
4621
5167
|
4XX_example:
|
4622
5168
|
$ref: '#/components/examples/Error4XXResponseExample'
|
4623
5169
|
security:
|
@@ -5440,7 +5986,7 @@ paths:
|
|
5440
5986
|
post:
|
5441
5987
|
tags:
|
5442
5988
|
- Template
|
5443
|
-
summary: 'Create
|
5989
|
+
summary: 'Create Template'
|
5444
5990
|
description: 'Creates a template that can then be used.'
|
5445
5991
|
operationId: templateCreate
|
5446
5992
|
requestBody:
|
@@ -7345,6 +7891,50 @@ components:
|
|
7345
7891
|
type: string
|
7346
7892
|
format: email
|
7347
7893
|
type: object
|
7894
|
+
FaxSendRequest:
|
7895
|
+
required:
|
7896
|
+
- recipient
|
7897
|
+
properties:
|
7898
|
+
recipient:
|
7899
|
+
description: 'Fax Send To Recipient'
|
7900
|
+
type: string
|
7901
|
+
example: recipient@example.com
|
7902
|
+
sender:
|
7903
|
+
description: 'Fax Send From Sender (used only with fax number)'
|
7904
|
+
type: string
|
7905
|
+
example: sender@example.com
|
7906
|
+
files:
|
7907
|
+
description: 'Fax File to Send'
|
7908
|
+
type: array
|
7909
|
+
items:
|
7910
|
+
type: string
|
7911
|
+
format: binary
|
7912
|
+
file_urls:
|
7913
|
+
description: 'Fax File URL to Send'
|
7914
|
+
type: array
|
7915
|
+
items:
|
7916
|
+
type: string
|
7917
|
+
test_mode:
|
7918
|
+
description: 'API Test Mode Setting'
|
7919
|
+
type: boolean
|
7920
|
+
default: false
|
7921
|
+
cover_page_to:
|
7922
|
+
description: 'Fax Cover Page for Recipient'
|
7923
|
+
type: string
|
7924
|
+
example: 'Recipient Name'
|
7925
|
+
cover_page_from:
|
7926
|
+
description: 'Fax Cover Page for Sender'
|
7927
|
+
type: string
|
7928
|
+
example: 'Sender Name'
|
7929
|
+
cover_page_message:
|
7930
|
+
description: 'Fax Cover Page Message'
|
7931
|
+
type: string
|
7932
|
+
example: 'Please find the attached documents.'
|
7933
|
+
title:
|
7934
|
+
description: 'Fax Title'
|
7935
|
+
type: string
|
7936
|
+
example: 'Fax Title'
|
7937
|
+
type: object
|
7348
7938
|
OAuthTokenGenerateRequest:
|
7349
7939
|
required:
|
7350
7940
|
- client_id
|
@@ -7382,6 +7972,12 @@ components:
|
|
7382
7972
|
refresh_token:
|
7383
7973
|
description: 'The token provided when you got the expired access token.'
|
7384
7974
|
type: string
|
7975
|
+
client_id:
|
7976
|
+
description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
|
7977
|
+
type: string
|
7978
|
+
client_secret:
|
7979
|
+
description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
|
7980
|
+
type: string
|
7385
7981
|
type: object
|
7386
7982
|
ReportCreateRequest:
|
7387
7983
|
required:
|
@@ -9091,7 +9687,7 @@ components:
|
|
9091
9687
|
properties:
|
9092
9688
|
header_background_color:
|
9093
9689
|
type: string
|
9094
|
-
default: '#
|
9690
|
+
default: '#1a1a1a'
|
9095
9691
|
legal_version:
|
9096
9692
|
type: string
|
9097
9693
|
default: terms1
|
@@ -9100,40 +9696,40 @@ components:
|
|
9100
9696
|
- terms2
|
9101
9697
|
link_color:
|
9102
9698
|
type: string
|
9103
|
-
default: '#
|
9699
|
+
default: '#0061FE'
|
9104
9700
|
page_background_color:
|
9105
9701
|
type: string
|
9106
|
-
default: '#
|
9702
|
+
default: '#f7f8f9'
|
9107
9703
|
primary_button_color:
|
9108
9704
|
type: string
|
9109
|
-
default: '#
|
9705
|
+
default: '#0061FE'
|
9110
9706
|
primary_button_color_hover:
|
9111
9707
|
type: string
|
9112
|
-
default: '#
|
9708
|
+
default: '#0061FE'
|
9113
9709
|
primary_button_text_color:
|
9114
9710
|
type: string
|
9115
|
-
default: '#
|
9711
|
+
default: '#ffffff'
|
9116
9712
|
primary_button_text_color_hover:
|
9117
9713
|
type: string
|
9118
|
-
default: '#
|
9714
|
+
default: '#ffffff'
|
9119
9715
|
secondary_button_color:
|
9120
9716
|
type: string
|
9121
|
-
default: '#
|
9717
|
+
default: '#ffffff'
|
9122
9718
|
secondary_button_color_hover:
|
9123
9719
|
type: string
|
9124
|
-
default: '#
|
9720
|
+
default: '#ffffff'
|
9125
9721
|
secondary_button_text_color:
|
9126
9722
|
type: string
|
9127
|
-
default: '#
|
9723
|
+
default: '#0061FE'
|
9128
9724
|
secondary_button_text_color_hover:
|
9129
9725
|
type: string
|
9130
|
-
default: '#
|
9726
|
+
default: '#0061FE'
|
9131
9727
|
text_color1:
|
9132
9728
|
type: string
|
9133
9729
|
default: '#808080'
|
9134
9730
|
text_color2:
|
9135
9731
|
type: string
|
9136
|
-
default: '#
|
9732
|
+
default: '#ffffff'
|
9137
9733
|
reset_to_default:
|
9138
9734
|
description: 'Resets white labeling options to defaults. Only useful when updating an API App.'
|
9139
9735
|
type: boolean
|
@@ -10211,6 +10807,19 @@ components:
|
|
10211
10807
|
error:
|
10212
10808
|
$ref: '#/components/schemas/ErrorResponseError'
|
10213
10809
|
type: object
|
10810
|
+
FaxGetResponse:
|
10811
|
+
required:
|
10812
|
+
- fax
|
10813
|
+
properties:
|
10814
|
+
fax:
|
10815
|
+
$ref: '#/components/schemas/FaxResponse'
|
10816
|
+
warnings:
|
10817
|
+
description: 'A list of warnings.'
|
10818
|
+
type: array
|
10819
|
+
items:
|
10820
|
+
$ref: '#/components/schemas/WarningResponse'
|
10821
|
+
type: object
|
10822
|
+
x-internal-class: true
|
10214
10823
|
FaxLineResponse:
|
10215
10824
|
required:
|
10216
10825
|
- fax_line
|
@@ -10246,6 +10855,19 @@ components:
|
|
10246
10855
|
$ref: '#/components/schemas/WarningResponse'
|
10247
10856
|
type: object
|
10248
10857
|
x-internal-class: true
|
10858
|
+
FaxListResponse:
|
10859
|
+
required:
|
10860
|
+
- faxes
|
10861
|
+
- list_info
|
10862
|
+
properties:
|
10863
|
+
faxes:
|
10864
|
+
type: array
|
10865
|
+
items:
|
10866
|
+
$ref: '#/components/schemas/FaxResponse'
|
10867
|
+
list_info:
|
10868
|
+
$ref: '#/components/schemas/ListInfoResponse'
|
10869
|
+
type: object
|
10870
|
+
x-internal-class: true
|
10249
10871
|
FileResponse:
|
10250
10872
|
required:
|
10251
10873
|
- file_url
|
@@ -10388,7 +11010,7 @@ components:
|
|
10388
11010
|
type: integer
|
10389
11011
|
nullable: true
|
10390
11012
|
sms_verifications_left:
|
10391
|
-
description: 'SMS verifications
|
11013
|
+
description: 'SMS verifications remaining.'
|
10392
11014
|
type: integer
|
10393
11015
|
nullable: true
|
10394
11016
|
num_fax_pages_left:
|
@@ -10456,6 +11078,7 @@ components:
|
|
10456
11078
|
secret:
|
10457
11079
|
description: 'The app''s OAuth secret, or null if the app does not belong to user.'
|
10458
11080
|
type: string
|
11081
|
+
nullable: true
|
10459
11082
|
scopes:
|
10460
11083
|
description: 'Array of OAuth scopes used by the app.'
|
10461
11084
|
type: array
|
@@ -10589,6 +11212,54 @@ components:
|
|
10589
11212
|
description: 'Name of the error.'
|
10590
11213
|
type: string
|
10591
11214
|
type: object
|
11215
|
+
FaxResponse:
|
11216
|
+
required:
|
11217
|
+
- fax_id
|
11218
|
+
- title
|
11219
|
+
- original_title
|
11220
|
+
- subject
|
11221
|
+
- message
|
11222
|
+
- metadata
|
11223
|
+
- created_at
|
11224
|
+
- sender
|
11225
|
+
- transmissions
|
11226
|
+
- files_url
|
11227
|
+
properties:
|
11228
|
+
fax_id:
|
11229
|
+
description: 'Fax ID'
|
11230
|
+
type: string
|
11231
|
+
title:
|
11232
|
+
description: 'Fax Title'
|
11233
|
+
type: string
|
11234
|
+
original_title:
|
11235
|
+
description: 'Fax Original Title'
|
11236
|
+
type: string
|
11237
|
+
subject:
|
11238
|
+
description: 'Fax Subject'
|
11239
|
+
type: string
|
11240
|
+
message:
|
11241
|
+
description: 'Fax Message'
|
11242
|
+
type: string
|
11243
|
+
metadata:
|
11244
|
+
description: 'Fax Metadata'
|
11245
|
+
type: object
|
11246
|
+
additionalProperties: {}
|
11247
|
+
created_at:
|
11248
|
+
description: 'Fax Created At Timestamp'
|
11249
|
+
type: integer
|
11250
|
+
sender:
|
11251
|
+
description: 'Fax Sender Email'
|
11252
|
+
type: string
|
11253
|
+
transmissions:
|
11254
|
+
description: 'Fax Transmissions List'
|
11255
|
+
type: array
|
11256
|
+
items:
|
11257
|
+
$ref: '#/components/schemas/FaxResponseTransmission'
|
11258
|
+
files_url:
|
11259
|
+
description: 'Fax Files URL'
|
11260
|
+
type: string
|
11261
|
+
type: object
|
11262
|
+
x-internal-class: true
|
10592
11263
|
FaxLineResponseFaxLine:
|
10593
11264
|
properties:
|
10594
11265
|
number:
|
@@ -10606,6 +11277,35 @@ components:
|
|
10606
11277
|
$ref: '#/components/schemas/AccountResponse'
|
10607
11278
|
type: object
|
10608
11279
|
x-internal-class: true
|
11280
|
+
FaxResponseTransmission:
|
11281
|
+
required:
|
11282
|
+
- recipient
|
11283
|
+
- sender
|
11284
|
+
- status_code
|
11285
|
+
properties:
|
11286
|
+
recipient:
|
11287
|
+
description: 'Fax Transmission Recipient'
|
11288
|
+
type: string
|
11289
|
+
sender:
|
11290
|
+
description: 'Fax Transmission Sender'
|
11291
|
+
type: string
|
11292
|
+
status_code:
|
11293
|
+
description: 'Fax Transmission Status Code'
|
11294
|
+
type: string
|
11295
|
+
enum:
|
11296
|
+
- success
|
11297
|
+
- transmitting
|
11298
|
+
- error_could_not_fax
|
11299
|
+
- error_unknown
|
11300
|
+
- error_busy
|
11301
|
+
- error_no_answer
|
11302
|
+
- error_disconnected
|
11303
|
+
- error_bad_destination
|
11304
|
+
sent_at:
|
11305
|
+
description: 'Fax Transmission Sent Timestamp'
|
11306
|
+
type: integer
|
11307
|
+
type: object
|
11308
|
+
x-internal-class: true
|
10609
11309
|
ListInfoResponse:
|
10610
11310
|
description: 'Contains pagination information about the data returned.'
|
10611
11311
|
properties:
|
@@ -11218,24 +11918,21 @@ components:
|
|
11218
11918
|
description: 'Time the template was last updated.'
|
11219
11919
|
type: integer
|
11220
11920
|
is_embedded:
|
11221
|
-
description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.'
|
11921
|
+
description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.'
|
11222
11922
|
type: boolean
|
11223
11923
|
nullable: true
|
11224
11924
|
is_creator:
|
11225
11925
|
description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.'
|
11226
11926
|
type: boolean
|
11227
|
-
nullable: true
|
11228
11927
|
can_edit:
|
11229
11928
|
description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).'
|
11230
11929
|
type: boolean
|
11231
|
-
nullable: true
|
11232
11930
|
is_locked:
|
11233
11931
|
description: |-
|
11234
11932
|
Indicates whether the template is locked.
|
11235
11933
|
If `true`, then the template was created outside your quota and can only be used in `test_mode`.
|
11236
11934
|
If `false`, then the template is within your quota and can be used to create signature requests.
|
11237
11935
|
type: boolean
|
11238
|
-
nullable: true
|
11239
11936
|
metadata:
|
11240
11937
|
description: 'The metadata attached to the template.'
|
11241
11938
|
type: object
|
@@ -11273,7 +11970,11 @@ components:
|
|
11273
11970
|
type: array
|
11274
11971
|
items:
|
11275
11972
|
$ref: '#/components/schemas/TemplateResponseAccount'
|
11276
|
-
|
11973
|
+
attachments:
|
11974
|
+
description: 'Signer attachments.'
|
11975
|
+
type: array
|
11976
|
+
items:
|
11977
|
+
$ref: '#/components/schemas/SignatureRequestResponseAttachment'
|
11277
11978
|
type: object
|
11278
11979
|
x-internal-class: true
|
11279
11980
|
TemplateResponseAccount:
|
@@ -11377,7 +12078,6 @@ components:
|
|
11377
12078
|
type: array
|
11378
12079
|
items:
|
11379
12080
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
11380
|
-
nullable: true
|
11381
12081
|
type: object
|
11382
12082
|
x-internal-class: true
|
11383
12083
|
TemplateResponseDocumentCustomFieldBase:
|
@@ -11529,10 +12229,6 @@ components:
|
|
11529
12229
|
required:
|
11530
12230
|
description: 'Boolean showing whether or not this field is required.'
|
11531
12231
|
type: boolean
|
11532
|
-
group:
|
11533
|
-
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
11534
|
-
type: string
|
11535
|
-
nullable: true
|
11536
12232
|
type: object
|
11537
12233
|
discriminator:
|
11538
12234
|
propertyName: type
|
@@ -11549,12 +12245,12 @@ components:
|
|
11549
12245
|
x-base-class: true
|
11550
12246
|
TemplateResponseDocumentFormFieldCheckbox:
|
11551
12247
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
12248
|
+
required:
|
12249
|
+
- type
|
11552
12250
|
allOf:
|
11553
12251
|
-
|
11554
12252
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
11555
12253
|
-
|
11556
|
-
required:
|
11557
|
-
- type
|
11558
12254
|
properties:
|
11559
12255
|
type:
|
11560
12256
|
description: |-
|
@@ -11570,6 +12266,10 @@ components:
|
|
11570
12266
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
11571
12267
|
type: string
|
11572
12268
|
default: checkbox
|
12269
|
+
group:
|
12270
|
+
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
12271
|
+
type: string
|
12272
|
+
nullable: true
|
11573
12273
|
type: object
|
11574
12274
|
TemplateResponseDocumentFormFieldDateSigned:
|
11575
12275
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
@@ -11579,8 +12279,6 @@ components:
|
|
11579
12279
|
-
|
11580
12280
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
11581
12281
|
-
|
11582
|
-
required:
|
11583
|
-
- type
|
11584
12282
|
properties:
|
11585
12283
|
type:
|
11586
12284
|
description: |-
|
@@ -11596,6 +12294,10 @@ components:
|
|
11596
12294
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
11597
12295
|
type: string
|
11598
12296
|
default: date_signed
|
12297
|
+
group:
|
12298
|
+
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
12299
|
+
type: string
|
12300
|
+
nullable: true
|
11599
12301
|
type: object
|
11600
12302
|
TemplateResponseDocumentFormFieldDropdown:
|
11601
12303
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
@@ -11605,8 +12307,6 @@ components:
|
|
11605
12307
|
-
|
11606
12308
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
11607
12309
|
-
|
11608
|
-
required:
|
11609
|
-
- type
|
11610
12310
|
properties:
|
11611
12311
|
type:
|
11612
12312
|
description: |-
|
@@ -11622,6 +12322,10 @@ components:
|
|
11622
12322
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
11623
12323
|
type: string
|
11624
12324
|
default: dropdown
|
12325
|
+
group:
|
12326
|
+
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
12327
|
+
type: string
|
12328
|
+
nullable: true
|
11625
12329
|
type: object
|
11626
12330
|
TemplateResponseDocumentFormFieldHyperlink:
|
11627
12331
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
@@ -11631,8 +12335,6 @@ components:
|
|
11631
12335
|
-
|
11632
12336
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
11633
12337
|
-
|
11634
|
-
required:
|
11635
|
-
- type
|
11636
12338
|
properties:
|
11637
12339
|
type:
|
11638
12340
|
description: |-
|
@@ -11659,6 +12361,10 @@ components:
|
|
11659
12361
|
fontFamily:
|
11660
12362
|
description: 'Font family used in this form field''s text.'
|
11661
12363
|
type: string
|
12364
|
+
group:
|
12365
|
+
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
12366
|
+
type: string
|
12367
|
+
nullable: true
|
11662
12368
|
type: object
|
11663
12369
|
TemplateResponseDocumentFormFieldInitials:
|
11664
12370
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
@@ -11668,8 +12374,6 @@ components:
|
|
11668
12374
|
-
|
11669
12375
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
11670
12376
|
-
|
11671
|
-
required:
|
11672
|
-
- type
|
11673
12377
|
properties:
|
11674
12378
|
type:
|
11675
12379
|
description: |-
|
@@ -11685,6 +12389,10 @@ components:
|
|
11685
12389
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
11686
12390
|
type: string
|
11687
12391
|
default: initials
|
12392
|
+
group:
|
12393
|
+
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
12394
|
+
type: string
|
12395
|
+
nullable: true
|
11688
12396
|
type: object
|
11689
12397
|
TemplateResponseDocumentFormFieldRadio:
|
11690
12398
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
@@ -11695,8 +12403,6 @@ components:
|
|
11695
12403
|
-
|
11696
12404
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
11697
12405
|
-
|
11698
|
-
required:
|
11699
|
-
- type
|
11700
12406
|
properties:
|
11701
12407
|
type:
|
11702
12408
|
description: |-
|
@@ -11712,6 +12418,9 @@ components:
|
|
11712
12418
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
11713
12419
|
type: string
|
11714
12420
|
default: radio
|
12421
|
+
group:
|
12422
|
+
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
12423
|
+
type: string
|
11715
12424
|
type: object
|
11716
12425
|
TemplateResponseDocumentFormFieldSignature:
|
11717
12426
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
@@ -11721,8 +12430,6 @@ components:
|
|
11721
12430
|
-
|
11722
12431
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
11723
12432
|
-
|
11724
|
-
required:
|
11725
|
-
- type
|
11726
12433
|
properties:
|
11727
12434
|
type:
|
11728
12435
|
description: |-
|
@@ -11738,6 +12445,10 @@ components:
|
|
11738
12445
|
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
|
11739
12446
|
type: string
|
11740
12447
|
default: signature
|
12448
|
+
group:
|
12449
|
+
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
12450
|
+
type: string
|
12451
|
+
nullable: true
|
11741
12452
|
type: object
|
11742
12453
|
TemplateResponseDocumentFormFieldText:
|
11743
12454
|
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
|
@@ -11747,8 +12458,6 @@ components:
|
|
11747
12458
|
-
|
11748
12459
|
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
|
11749
12460
|
-
|
11750
|
-
required:
|
11751
|
-
- type
|
11752
12461
|
properties:
|
11753
12462
|
type:
|
11754
12463
|
description: |-
|
@@ -11790,6 +12499,10 @@ components:
|
|
11790
12499
|
- employer_identification_number
|
11791
12500
|
- custom_regex
|
11792
12501
|
nullable: true
|
12502
|
+
group:
|
12503
|
+
description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
|
12504
|
+
type: string
|
12505
|
+
nullable: true
|
11793
12506
|
type: object
|
11794
12507
|
TemplateResponseDocumentStaticFieldBase:
|
11795
12508
|
description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
|
@@ -11849,8 +12562,6 @@ components:
|
|
11849
12562
|
-
|
11850
12563
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
11851
12564
|
-
|
11852
|
-
required:
|
11853
|
-
- type
|
11854
12565
|
properties:
|
11855
12566
|
type:
|
11856
12567
|
description: |-
|
@@ -11875,8 +12586,6 @@ components:
|
|
11875
12586
|
-
|
11876
12587
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
11877
12588
|
-
|
11878
|
-
required:
|
11879
|
-
- type
|
11880
12589
|
properties:
|
11881
12590
|
type:
|
11882
12591
|
description: |-
|
@@ -11901,8 +12610,6 @@ components:
|
|
11901
12610
|
-
|
11902
12611
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
11903
12612
|
-
|
11904
|
-
required:
|
11905
|
-
- type
|
11906
12613
|
properties:
|
11907
12614
|
type:
|
11908
12615
|
description: |-
|
@@ -11927,8 +12634,6 @@ components:
|
|
11927
12634
|
-
|
11928
12635
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
11929
12636
|
-
|
11930
|
-
required:
|
11931
|
-
- type
|
11932
12637
|
properties:
|
11933
12638
|
type:
|
11934
12639
|
description: |-
|
@@ -11953,8 +12658,6 @@ components:
|
|
11953
12658
|
-
|
11954
12659
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
11955
12660
|
-
|
11956
|
-
required:
|
11957
|
-
- type
|
11958
12661
|
properties:
|
11959
12662
|
type:
|
11960
12663
|
description: |-
|
@@ -11979,8 +12682,6 @@ components:
|
|
11979
12682
|
-
|
11980
12683
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
11981
12684
|
-
|
11982
|
-
required:
|
11983
|
-
- type
|
11984
12685
|
properties:
|
11985
12686
|
type:
|
11986
12687
|
description: |-
|
@@ -12005,8 +12706,6 @@ components:
|
|
12005
12706
|
-
|
12006
12707
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
12007
12708
|
-
|
12008
|
-
required:
|
12009
|
-
- type
|
12010
12709
|
properties:
|
12011
12710
|
type:
|
12012
12711
|
description: |-
|
@@ -12031,8 +12730,6 @@ components:
|
|
12031
12730
|
-
|
12032
12731
|
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
|
12033
12732
|
-
|
12034
|
-
required:
|
12035
|
-
- type
|
12036
12733
|
properties:
|
12037
12734
|
type:
|
12038
12735
|
description: |-
|
@@ -12418,6 +13115,10 @@ components:
|
|
12418
13115
|
summary: 'Default Example'
|
12419
13116
|
value:
|
12420
13117
|
$ref: examples/json/FaxLineRemoveUserRequestExample.json
|
13118
|
+
FaxSendRequestExample:
|
13119
|
+
summary: 'Default Example'
|
13120
|
+
value:
|
13121
|
+
$ref: examples/json/FaxSendRequestExample.json
|
12421
13122
|
OAuthTokenGenerateRequestExample:
|
12422
13123
|
summary: 'OAuth Token Generate Example'
|
12423
13124
|
value:
|
@@ -12662,6 +13363,10 @@ components:
|
|
12662
13363
|
summary: 'Error 4XX failed_operation'
|
12663
13364
|
value:
|
12664
13365
|
$ref: examples/json/Error4XXResponseExample.json
|
13366
|
+
FaxGetResponseExample:
|
13367
|
+
summary: 'Fax Response'
|
13368
|
+
value:
|
13369
|
+
$ref: examples/json/FaxGetResponseExample.json
|
12665
13370
|
FaxLineResponseExample:
|
12666
13371
|
summary: 'Sample Fax Line Response'
|
12667
13372
|
value:
|
@@ -12674,6 +13379,10 @@ components:
|
|
12674
13379
|
summary: 'Sample Fax Line List Response'
|
12675
13380
|
value:
|
12676
13381
|
$ref: examples/json/FaxLineListResponseExample.json
|
13382
|
+
FaxListResponseExample:
|
13383
|
+
summary: 'Returns the properties and settings of multiple Faxes.'
|
13384
|
+
value:
|
13385
|
+
$ref: examples/json/FaxListResponseExample.json
|
12677
13386
|
ReportCreateResponseExample:
|
12678
13387
|
summary: Report
|
12679
13388
|
value:
|