|
3 | 3 | "info": { |
4 | 4 | "version": "1.0", |
5 | 5 | "title": "DocuSign Demo", |
| 6 | + "x-ms-keywords": "DocuSign Demo", |
6 | 7 | "description": "DocuSign helps organizations connect and automate how they prepare, sign, act on, and manage agreements. The DocuSign Demo connector connects only to DocuSign Demo environments but offers the same functionality as the regular DocuSign connector. Any documents in a DocuSign Demo environment are not legally binding. For all non-demo uses, use the regular DocuSign connector.", |
7 | 8 | "x-ms-deployment-version": "1.0.0", |
8 | 9 | "x-ms-api-annotation": { |
|
948 | 949 | "x-ms-visibility": "important" |
949 | 950 | } |
950 | 951 | }, |
| 952 | + "/accounts/salesCopilotAccount/envelopes/getRelatedActivities": { |
| 953 | + "get": { |
| 954 | + "tags": [ |
| 955 | + "DocuSign" |
| 956 | + ], |
| 957 | + "summary": "Sales Copilot: Get Related Activities", |
| 958 | + "description": "Sales Copilot: Get Related Activities.", |
| 959 | + "operationId": "scp-get-related-activities", |
| 960 | + "x-ms-no-generic-test": true, |
| 961 | + "consumes": [ |
| 962 | + "application/json", |
| 963 | + "text/json", |
| 964 | + "application/xml", |
| 965 | + "text/xml", |
| 966 | + "application/x-www-form-urlencoded" |
| 967 | + ], |
| 968 | + "produces": [ |
| 969 | + "application/json", |
| 970 | + "text/json", |
| 971 | + "application/xml", |
| 972 | + "text/xml" |
| 973 | + ], |
| 974 | + "parameters": [ |
| 975 | + { |
| 976 | + "name": "recordType", |
| 977 | + "in": "query", |
| 978 | + "required": true, |
| 979 | + "enum": [ |
| 980 | + "account", |
| 981 | + "opportunity", |
| 982 | + "lead" |
| 983 | + ], |
| 984 | + "type": "string" |
| 985 | + }, |
| 986 | + { |
| 987 | + "name": "recordId", |
| 988 | + "in": "query", |
| 989 | + "required": true, |
| 990 | + "type": "string" |
| 991 | + }, |
| 992 | + { |
| 993 | + "name": "startDateTime", |
| 994 | + "description": "Enter start date-time in the format: 2017-05-02T01:44Z", |
| 995 | + "in": "query", |
| 996 | + "type": "string", |
| 997 | + "required": false, |
| 998 | + "format": "date-time" |
| 999 | + }, |
| 1000 | + { |
| 1001 | + "name": "endDateTime", |
| 1002 | + "description": "Enter end date-time in the format: 2017-05-02T01:44Z", |
| 1003 | + "in": "query", |
| 1004 | + "type": "string", |
| 1005 | + "format": "date-time" |
| 1006 | + }, |
| 1007 | + { |
| 1008 | + "name": "top", |
| 1009 | + "description": "Top envelopes to be returned", |
| 1010 | + "in": "query", |
| 1011 | + "type": "integer", |
| 1012 | + "format": "int32" |
| 1013 | + }, |
| 1014 | + { |
| 1015 | + "name": "skip", |
| 1016 | + "description": "Envelopes to be skipped", |
| 1017 | + "in": "query", |
| 1018 | + "type": "integer", |
| 1019 | + "format": "int32" |
| 1020 | + }, |
| 1021 | + { |
| 1022 | + "name": "crmType", |
| 1023 | + "in": "query", |
| 1024 | + "enum": [ |
| 1025 | + "Dynamics365" |
| 1026 | + ], |
| 1027 | + "type": "string" |
| 1028 | + }, |
| 1029 | + { |
| 1030 | + "name": "crmOrgUrl", |
| 1031 | + "in": "query", |
| 1032 | + "type": "string" |
| 1033 | + } |
| 1034 | + ], |
| 1035 | + "responses": { |
| 1036 | + "200": { |
| 1037 | + "description": "Success", |
| 1038 | + "schema": { |
| 1039 | + "$ref": "#/definitions/ActivityListResponseEnvelope" |
| 1040 | + } |
| 1041 | + }, |
| 1042 | + "400": { |
| 1043 | + "description": "Bad Request", |
| 1044 | + "schema": { |
| 1045 | + "$ref": "#/definitions/ApiError" |
| 1046 | + } |
| 1047 | + }, |
| 1048 | + "500": { |
| 1049 | + "description": "Server Error", |
| 1050 | + "schema": { |
| 1051 | + "$ref": "#/definitions/ApiError" |
| 1052 | + } |
| 1053 | + } |
| 1054 | + }, |
| 1055 | + "x-ms-openai-data": { |
| 1056 | + "openai-enabled": true |
| 1057 | + } |
| 1058 | + } |
| 1059 | + }, |
| 1060 | + "/accounts/salesCopilotAccount/envelopes/getRelatedRecords": { |
| 1061 | + "get": { |
| 1062 | + "tags": [ |
| 1063 | + "DocuSign" |
| 1064 | + ], |
| 1065 | + "summary": "Sales Copilot: Get Related Records", |
| 1066 | + "description": "Sales Copilot: Get Related Records.", |
| 1067 | + "operationId": "scp-get-related-records", |
| 1068 | + "x-ms-no-generic-test": true, |
| 1069 | + "consumes": [ |
| 1070 | + "application/json", |
| 1071 | + "text/json", |
| 1072 | + "application/xml", |
| 1073 | + "text/xml", |
| 1074 | + "application/x-www-form-urlencoded" |
| 1075 | + ], |
| 1076 | + "produces": [ |
| 1077 | + "application/json", |
| 1078 | + "text/json", |
| 1079 | + "application/xml", |
| 1080 | + "text/xml" |
| 1081 | + ], |
| 1082 | + "parameters": [ |
| 1083 | + { |
| 1084 | + "name": "recordType", |
| 1085 | + "in": "query", |
| 1086 | + "required": true, |
| 1087 | + "enum": [ |
| 1088 | + "account", |
| 1089 | + "opportunity", |
| 1090 | + "lead" |
| 1091 | + ], |
| 1092 | + "type": "string" |
| 1093 | + }, |
| 1094 | + { |
| 1095 | + "name": "recordId", |
| 1096 | + "in": "query", |
| 1097 | + "required": true, |
| 1098 | + "type": "string" |
| 1099 | + }, |
| 1100 | + { |
| 1101 | + "name": "startDateTime", |
| 1102 | + "description": "Enter start date-time in the format: 2017-05-02T01:44Z", |
| 1103 | + "in": "query", |
| 1104 | + "type": "string", |
| 1105 | + "required": false, |
| 1106 | + "format": "date-time" |
| 1107 | + }, |
| 1108 | + { |
| 1109 | + "name": "top", |
| 1110 | + "description": "Top envelopes to be returned", |
| 1111 | + "in": "query", |
| 1112 | + "type": "integer", |
| 1113 | + "format": "int32" |
| 1114 | + }, |
| 1115 | + { |
| 1116 | + "name": "skip", |
| 1117 | + "description": "Envelopes to be skipped", |
| 1118 | + "in": "query", |
| 1119 | + "type": "integer", |
| 1120 | + "format": "int32" |
| 1121 | + }, |
| 1122 | + { |
| 1123 | + "name": "crmType", |
| 1124 | + "in": "query", |
| 1125 | + "enum": [ |
| 1126 | + "Dynamics365" |
| 1127 | + ], |
| 1128 | + "type": "string" |
| 1129 | + }, |
| 1130 | + { |
| 1131 | + "name": "crmOrgUrl", |
| 1132 | + "in": "query", |
| 1133 | + "type": "string" |
| 1134 | + } |
| 1135 | + ], |
| 1136 | + "responses": { |
| 1137 | + "200": { |
| 1138 | + "description": "Success", |
| 1139 | + "schema": { |
| 1140 | + "$ref": "#/definitions/DocumentRecordListResponseEnvelope" |
| 1141 | + } |
| 1142 | + }, |
| 1143 | + "400": { |
| 1144 | + "description": "Bad Request", |
| 1145 | + "schema": { |
| 1146 | + "$ref": "#/definitions/ApiError" |
| 1147 | + } |
| 1148 | + }, |
| 1149 | + "401": { |
| 1150 | + "description": "Unauthorized", |
| 1151 | + "schema": { |
| 1152 | + "$ref": "#/definitions/ApiError" |
| 1153 | + } |
| 1154 | + }, |
| 1155 | + "500": { |
| 1156 | + "description": "Server Error", |
| 1157 | + "schema": { |
| 1158 | + "$ref": "#/definitions/ApiError" |
| 1159 | + } |
| 1160 | + } |
| 1161 | + }, |
| 1162 | + "x-ms-openai-data": { |
| 1163 | + "openai-enabled": true |
| 1164 | + } |
| 1165 | + } |
| 1166 | + }, |
951 | 1167 | "/accounts/{accountId}/envelopes/createFromTemplate": { |
952 | 1168 | "post": { |
953 | 1169 | "tags": [ |
|
2565 | 2781 | "deprecated": false, |
2566 | 2782 | "x-ms-visibility": "important", |
2567 | 2783 | "x-ms-no-generic-test": true |
2568 | | - }, |
| 2784 | + } |
2569 | 2785 | }, |
2570 | 2786 | "/login_information": { |
2571 | 2787 | "get": { |
|
4570 | 4786 | } |
4571 | 4787 | } |
4572 | 4788 | }, |
| 4789 | + "Activity": { |
| 4790 | + "required": [ |
| 4791 | + "dateTime", |
| 4792 | + "description", |
| 4793 | + "title" |
| 4794 | + ], |
| 4795 | + "type": "object", |
| 4796 | + "properties": { |
| 4797 | + "title": { |
| 4798 | + "minLength": 1, |
| 4799 | + "type": "string" |
| 4800 | + }, |
| 4801 | + "description": { |
| 4802 | + "minLength": 1, |
| 4803 | + "type": "string" |
| 4804 | + }, |
| 4805 | + "dateTime": { |
| 4806 | + "type": "string", |
| 4807 | + "format": "date-time" |
| 4808 | + }, |
| 4809 | + "url": { |
| 4810 | + "type": "string" |
| 4811 | + }, |
| 4812 | + "additionalProperties": { |
| 4813 | + "type": "object", |
| 4814 | + "properties": { |
| 4815 | + "additionalProperties": { |
| 4816 | + "type": "string" |
| 4817 | + } |
| 4818 | + }, |
| 4819 | + "x-ms-summary": "Additional Properties" |
| 4820 | + } |
| 4821 | + }, |
| 4822 | + "additionalProperties": false |
| 4823 | + }, |
| 4824 | + "DocumentRecord": { |
| 4825 | + "required": [ |
| 4826 | + "recordId", |
| 4827 | + "recordTitle", |
| 4828 | + "recordTypeDisplayName", |
| 4829 | + "recordTypePluralDisplayName", |
| 4830 | + "recordType" |
| 4831 | + ], |
| 4832 | + "type": "object", |
| 4833 | + "properties": { |
| 4834 | + "recordId": { |
| 4835 | + "minLength": 1, |
| 4836 | + "type": "string" |
| 4837 | + }, |
| 4838 | + "recordTypeDisplayName": { |
| 4839 | + "minLength": 1, |
| 4840 | + "type": "string" |
| 4841 | + }, |
| 4842 | + "recordTypePluralDisplayName": { |
| 4843 | + "minLength": 1, |
| 4844 | + "type": "string" |
| 4845 | + }, |
| 4846 | + "recordType": { |
| 4847 | + "minLength": 1, |
| 4848 | + "type": "string" |
| 4849 | + }, |
| 4850 | + "recordTitle": { |
| 4851 | + "minLength": 1, |
| 4852 | + "type": "string" |
| 4853 | + }, |
| 4854 | + "url": { |
| 4855 | + "type": "string" |
| 4856 | + }, |
| 4857 | + "additionalProperties": { |
| 4858 | + "type": "object", |
| 4859 | + "properties": { |
| 4860 | + "additionalProperties": { |
| 4861 | + "type": "string" |
| 4862 | + } |
| 4863 | + }, |
| 4864 | + "x-ms-summary": "Additional Properties" |
| 4865 | + } |
| 4866 | + }, |
| 4867 | + "additionalProperties": false |
| 4868 | + }, |
4573 | 4869 | "Envelope": { |
4574 | 4870 | "type": "object", |
4575 | 4871 | "properties": { |
|
4639 | 4935 | } |
4640 | 4936 | } |
4641 | 4937 | }, |
| 4938 | + "ActivityListResponseEnvelope": { |
| 4939 | + "type": "object", |
| 4940 | + "properties": { |
| 4941 | + "value": { |
| 4942 | + "description": "Related activies", |
| 4943 | + "type": "array", |
| 4944 | + "items": { |
| 4945 | + "$ref": "#/definitions/Activity" |
| 4946 | + }, |
| 4947 | + "x-ms-summary": "Related activities" |
| 4948 | + }, |
| 4949 | + "hasMoreResults": { |
| 4950 | + "type": "boolean" |
| 4951 | + } |
| 4952 | + }, |
| 4953 | + "additionalProperties": false |
| 4954 | + }, |
| 4955 | + "DocumentRecordListResponseEnvelope": { |
| 4956 | + "type": "object", |
| 4957 | + "properties": { |
| 4958 | + "value": { |
| 4959 | + "description": "Related records", |
| 4960 | + "type": "array", |
| 4961 | + "items": { |
| 4962 | + "$ref": "#/definitions/DocumentRecord" |
| 4963 | + }, |
| 4964 | + "x-ms-summary": "Related records" |
| 4965 | + }, |
| 4966 | + "hasMoreResults": { |
| 4967 | + "type": "boolean" |
| 4968 | + } |
| 4969 | + }, |
| 4970 | + "additionalProperties": false |
| 4971 | + }, |
| 4972 | + "ApiError": { |
| 4973 | + "required": [ |
| 4974 | + "errorCode" |
| 4975 | + ], |
| 4976 | + "type": "object", |
| 4977 | + "properties": { |
| 4978 | + "errorCode": { |
| 4979 | + "minLength": 1, |
| 4980 | + "type": "string" |
| 4981 | + }, |
| 4982 | + "errorMessage": { |
| 4983 | + "type": "string" |
| 4984 | + }, |
| 4985 | + "activityId": { |
| 4986 | + "type": "string" |
| 4987 | + }, |
| 4988 | + "details": { |
| 4989 | + "type": "object", |
| 4990 | + "additionalProperties": { } |
| 4991 | + } |
| 4992 | + }, |
| 4993 | + "additionalProperties": false |
| 4994 | + }, |
4642 | 4995 | "CreateEnvelopeResponse": { |
4643 | 4996 | "type": "object", |
4644 | 4997 | "properties": { |
|
0 commit comments