|
439 | 439 | "tags": [ |
440 | 440 | "DocuSign" |
441 | 441 | ], |
442 | | - "summary": "Create envelope using template (V2)", |
| 442 | + "summary": "DEPRECATED: Create envelope using template (V2)", |
443 | 443 | "description": "Create a new envelope using a specified template.", |
444 | 444 | "operationId": "CreateEnvelopeFromTemplate", |
445 | 445 | "x-ms-no-generic-test": true, |
|
536 | 536 | "tags": [ |
537 | 537 | "DocuSign" |
538 | 538 | ], |
539 | | - "summary": "DEPRECATED: Send envelope using template (V1)", |
| 539 | + "summary": "Create envelope using template", |
540 | 540 | "description": "Create a new envelope using a specified template.", |
541 | 541 | "operationId": "SendEnvelope", |
542 | 542 | "x-ms-no-generic-test": true, |
|
688 | 688 | "x-ms-visibility": "important" |
689 | 689 | } |
690 | 690 | }, |
| 691 | + "/accounts/{accountId}/envelopes/{envelopeId}/custom_fields": { |
| 692 | + "get": { |
| 693 | + "tags": [ |
| 694 | + "DocuSign" |
| 695 | + ], |
| 696 | + "summary": "Get envelope custom field", |
| 697 | + "description": "Get details for the specified envelope custom field.", |
| 698 | + "operationId": "GetEnvelopeCustomField", |
| 699 | + "consumes": [ |
| 700 | + "application/json", |
| 701 | + "text/json", |
| 702 | + "application/xml", |
| 703 | + "text/xml", |
| 704 | + "application/x-www-form-urlencoded" |
| 705 | + ], |
| 706 | + "produces": [ |
| 707 | + "application/json", |
| 708 | + "text/json", |
| 709 | + "application/xml", |
| 710 | + "text/xml" |
| 711 | + ], |
| 712 | + "parameters": [ |
| 713 | + { |
| 714 | + "name": "accountId", |
| 715 | + "in": "path", |
| 716 | + "description": "Account id", |
| 717 | + "required": true, |
| 718 | + "x-ms-summary": "Account", |
| 719 | + "x-ms-test-value": "insert account id", |
| 720 | + "x-ms-dynamic-values": { |
| 721 | + "operationId": "GetLoginAccounts", |
| 722 | + "value-collection": "loginAccounts", |
| 723 | + "value-path": "accountIdGuid", |
| 724 | + "value-title": "name" |
| 725 | + }, |
| 726 | + "type": "string" |
| 727 | + }, |
| 728 | + { |
| 729 | + "name": "envelopeId", |
| 730 | + "in": "path", |
| 731 | + "description": "Envelope id", |
| 732 | + "required": true, |
| 733 | + "x-ms-summary": "Envelope", |
| 734 | + "x-ms-test-value": "insert envelope id", |
| 735 | + "type": "string" |
| 736 | + }, |
| 737 | + { |
| 738 | + "name": "fieldName", |
| 739 | + "in": "query", |
| 740 | + "description": "Custom Field Name", |
| 741 | + "required": true, |
| 742 | + "x-ms-summary": "Custom Field Name", |
| 743 | + "x-ms-visibility": "important", |
| 744 | + "x-ms-dynamic-values": { |
| 745 | + "operationId": "GetAccountCustomFields", |
| 746 | + "parameters": { |
| 747 | + "accountId": { |
| 748 | + "parameter": "accountId" |
| 749 | + } |
| 750 | + }, |
| 751 | + "value-collection": "customFields", |
| 752 | + "value-path": "name", |
| 753 | + "value-title": "name" |
| 754 | + }, |
| 755 | + "type": "string" |
| 756 | + } |
| 757 | + ], |
| 758 | + "responses": { |
| 759 | + "200": { |
| 760 | + "description": "OK", |
| 761 | + "schema": { |
| 762 | + "$ref": "#/definitions/EnvelopeCustomFieldResponse" |
| 763 | + } |
| 764 | + } |
| 765 | + }, |
| 766 | + "deprecated": false, |
| 767 | + "x-ms-no-generic-test": true, |
| 768 | + "x-ms-visibility": "important" |
| 769 | + }, |
| 770 | + "put": { |
| 771 | + "tags":[ |
| 772 | + "DocuSign" |
| 773 | + ], |
| 774 | + "summary": "Update envelope custom field", |
| 775 | + "description": "Update value for the specified envelope custom field", |
| 776 | + "operationId": "UpdateEnvelopeCustomField", |
| 777 | + "consumes":[ |
| 778 | + "application/json", |
| 779 | + "text/json", |
| 780 | + "application/xml", |
| 781 | + "text/xml", |
| 782 | + "application/x-www-form-urlencoded" |
| 783 | + ], |
| 784 | + "produces":[ |
| 785 | + "application/json", |
| 786 | + "text/json", |
| 787 | + "application/xml", |
| 788 | + "text/xml" |
| 789 | + ], |
| 790 | + "parameters":[ |
| 791 | + { |
| 792 | + "name": "accountId", |
| 793 | + "in": "path", |
| 794 | + "description": "Account id", |
| 795 | + "required": true, |
| 796 | + "x-ms-summary": "Account", |
| 797 | + "x-ms-test-value": "insert account id", |
| 798 | + "x-ms-dynamic-values": { |
| 799 | + "operationId": "GetLoginAccounts", |
| 800 | + "value-collection": "loginAccounts", |
| 801 | + "value-path": "accountIdGuid", |
| 802 | + "value-title": "name" |
| 803 | + }, |
| 804 | + "type": "string" |
| 805 | + }, |
| 806 | + { |
| 807 | + "name": "envelopeId", |
| 808 | + "in": "path", |
| 809 | + "description": "Envelope id", |
| 810 | + "required": true, |
| 811 | + "x-ms-summary": "Envelope", |
| 812 | + "x-ms-test-value": "insert envelope id", |
| 813 | + "type": "string" |
| 814 | + }, |
| 815 | + { |
| 816 | + "name": "fieldId", |
| 817 | + "in": "query", |
| 818 | + "description": "Custom Field ID", |
| 819 | + "required": true, |
| 820 | + "x-ms-summary": "Field ID", |
| 821 | + "type": "string" |
| 822 | + }, |
| 823 | + { |
| 824 | + "name": "fieldType", |
| 825 | + "in":"query", |
| 826 | + "description": "Custom Field Type", |
| 827 | + "required":true, |
| 828 | + "x-ms-summary": "Field Type", |
| 829 | + "type":"string" |
| 830 | + }, |
| 831 | + { |
| 832 | + "name": "name", |
| 833 | + "in": "query", |
| 834 | + "description": "Custom Field Name", |
| 835 | + "required": true, |
| 836 | + "x-ms-summary": "Name", |
| 837 | + "type": "string" |
| 838 | + }, |
| 839 | + { |
| 840 | + "name": "value", |
| 841 | + "in": "query", |
| 842 | + "description": "Custom Field Value", |
| 843 | + "required": true, |
| 844 | + "x-ms-summary": "Value", |
| 845 | + "type": "string" |
| 846 | + } |
| 847 | + ], |
| 848 | + "responses": { |
| 849 | + "200": { |
| 850 | + "description": "OK", |
| 851 | + "schema": { |
| 852 | + "$ref": "#/definitions/UpdateEnvelopeCustomFieldResponse" |
| 853 | + } |
| 854 | + } |
| 855 | + }, |
| 856 | + "deprecated":false, |
| 857 | + "x-ms-visibility": "important", |
| 858 | + "x-ms-no-generic-test": true |
| 859 | + } |
| 860 | + }, |
691 | 861 | "/accounts/{accountId}/envelopes/{envelopeId}/views/sender": { |
692 | 862 | "post": { |
693 | 863 | "tags":[ |
|
1620 | 1790 | "x-ms-visibility": "internal" |
1621 | 1791 | } |
1622 | 1792 | }, |
| 1793 | + "/accounts/{accountId}/account_custom_fields": { |
| 1794 | + "get": { |
| 1795 | + "tags": [ |
| 1796 | + "DocuSign" |
| 1797 | + ], |
| 1798 | + "summary": "Get account custom fields", |
| 1799 | + "description": "Get the custom fields for a specified account.", |
| 1800 | + "operationId": "GetAccountCustomFields", |
| 1801 | + "consumes": [], |
| 1802 | + "produces": [ |
| 1803 | + "application/json", |
| 1804 | + "text/json", |
| 1805 | + "application/xml", |
| 1806 | + "text/xml" |
| 1807 | + ], |
| 1808 | + "parameters": [ |
| 1809 | + { |
| 1810 | + "name": "accountId", |
| 1811 | + "in": "path", |
| 1812 | + "description": "Account id", |
| 1813 | + "required": true, |
| 1814 | + "x-ms-summary": "Account", |
| 1815 | + "x-ms-test-value": "insert account id", |
| 1816 | + "x-ms-dynamic-values": { |
| 1817 | + "operationId": "GetLoginAccounts", |
| 1818 | + "value-collection": "loginAccounts", |
| 1819 | + "value-path": "accountIdGuid", |
| 1820 | + "value-title": "name" |
| 1821 | + }, |
| 1822 | + "type": "string" |
| 1823 | + } |
| 1824 | + ], |
| 1825 | + "responses": { |
| 1826 | + "200": { |
| 1827 | + "description": "OK" |
| 1828 | + } |
| 1829 | + }, |
| 1830 | + "deprecated": false, |
| 1831 | + "x-ms-visibility": "internal" |
| 1832 | + } |
| 1833 | + }, |
1623 | 1834 | "/accounts/{accountId}/folders": { |
1624 | 1835 | "get": { |
1625 | 1836 | "tags": [ |
|
2286 | 2497 | "deprecated": false, |
2287 | 2498 | "x-ms-visibility": "internal" |
2288 | 2499 | } |
| 2500 | + }, |
| 2501 | + "/build_number": { |
| 2502 | + "get": { |
| 2503 | + "tags": [ |
| 2504 | + "StaticResponse" |
| 2505 | + ], |
| 2506 | + "description": "Identifier for the currently deployed build.", |
| 2507 | + "summary": "Show build Number (For reference only. Do not include in a flow for execution)", |
| 2508 | + "operationId": "BuildNumber", |
| 2509 | + "parameters": [ |
| 2510 | + { |
| 2511 | + "name": "buildNumber", |
| 2512 | + "in": "body", |
| 2513 | + "x-ms-summary": "Build Number", |
| 2514 | + "schema": { |
| 2515 | + "$ref": "#/definitions/BuildNumberSchema" |
| 2516 | + }, |
| 2517 | + "x-ms-visibility": "important" |
| 2518 | + } |
| 2519 | + ], |
| 2520 | + "responses": { |
| 2521 | + "200": { |
| 2522 | + "description": "OK", |
| 2523 | + "schema": { |
| 2524 | + "type": "object" |
| 2525 | + } |
| 2526 | + } |
| 2527 | + }, |
| 2528 | + "deprecated": false, |
| 2529 | + "x-ms-visibility": "advanced" |
| 2530 | + } |
| 2531 | + }, |
| 2532 | + "/build_number_schema": { |
| 2533 | + "get": { |
| 2534 | + "tags": [ |
| 2535 | + "StaticResponse" |
| 2536 | + ], |
| 2537 | + "description": "Get schema for a build number.", |
| 2538 | + "operationId": "StaticResponseForBuildNumberSchema", |
| 2539 | + "responses": { |
| 2540 | + "200": { |
| 2541 | + "description": "OK", |
| 2542 | + "schema": { |
| 2543 | + "type": "object" |
| 2544 | + } |
| 2545 | + } |
| 2546 | + }, |
| 2547 | + "deprecated": false, |
| 2548 | + "x-ms-visibility": "internal" |
| 2549 | + } |
2289 | 2550 | } |
2290 | 2551 | }, |
2291 | 2552 | "definitions": { |
|
2869 | 3130 | "value-path":"Schema" |
2870 | 3131 | } |
2871 | 3132 | }, |
| 3133 | + "BuildNumberSchema": { |
| 3134 | + "description": "Build number schema", |
| 3135 | + "type": "object", |
| 3136 | + "properties": {}, |
| 3137 | + "x-ms-dynamic-schema": { |
| 3138 | + "operationId": "StaticResponseForBuildNumberSchema", |
| 3139 | + "value-path":"Schema" |
| 3140 | + } |
| 3141 | + }, |
2872 | 3142 | "AccountCustomFields": { |
2873 | 3143 | "description": "An object that represents custom fields.", |
2874 | 3144 | "type": "object", |
|
3316 | 3586 | } |
3317 | 3587 | } |
3318 | 3588 | }, |
| 3589 | + "EnvelopeCustomFieldResponse": { |
| 3590 | + "type": "object", |
| 3591 | + "properties": { |
| 3592 | + "fieldId": { |
| 3593 | + "description": "The id of the envelope custom field.", |
| 3594 | + "type": "string", |
| 3595 | + "x-ms-summary": "Field ID", |
| 3596 | + "x-ms-visibility": "important" |
| 3597 | + }, |
| 3598 | + "fieldType": { |
| 3599 | + "description": "The type of the envelope custom field.", |
| 3600 | + "type": "string", |
| 3601 | + "x-ms-summary": "Field Type", |
| 3602 | + "x-ms-visibility": "important" |
| 3603 | + }, |
| 3604 | + "name": { |
| 3605 | + "description": "The name of the envelope custom field.", |
| 3606 | + "type": "string", |
| 3607 | + "x-ms-summary": "Name", |
| 3608 | + "x-ms-visibility": "important" |
| 3609 | + } |
| 3610 | + } |
| 3611 | + }, |
| 3612 | + "UpdateEnvelopeCustomFieldResponse": { |
| 3613 | + "type": "object", |
| 3614 | + "properties": { |
| 3615 | + "fieldId": { |
| 3616 | + "description": "The id of the envelope custom field.", |
| 3617 | + "type": "string", |
| 3618 | + "x-ms-summary": "Field ID", |
| 3619 | + "x-ms-visibility": "important" |
| 3620 | + }, |
| 3621 | + "fieldType": { |
| 3622 | + "description": "The type of the envelope custom field.", |
| 3623 | + "type": "string", |
| 3624 | + "x-ms-summary": "Field Type", |
| 3625 | + "x-ms-visibility": "important" |
| 3626 | + }, |
| 3627 | + "name": { |
| 3628 | + "description": "The name of the envelope custom field.", |
| 3629 | + "type": "string", |
| 3630 | + "x-ms-summary": "Name", |
| 3631 | + "x-ms-visibility": "important" |
| 3632 | + }, |
| 3633 | + "value": { |
| 3634 | + "description": "The value of the envelope custom field.", |
| 3635 | + "type": "string", |
| 3636 | + "x-ms-summary": "Value", |
| 3637 | + "x-ms-visibility": "important" |
| 3638 | + } |
| 3639 | + } |
| 3640 | + }, |
3319 | 3641 | "Folder": { |
3320 | 3642 | "type": "object", |
3321 | 3643 | "properties": { |
|
0 commit comments