@epilot/sdk 2.0.0-alpha.1 → 2.0.0-beta.2

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 (290) hide show
  1. package/README.md +123 -141
  2. package/dist/apis/access-token.cjs +90 -11
  3. package/dist/apis/access-token.d.cts +4 -4
  4. package/dist/apis/access-token.d.ts +4 -4
  5. package/dist/apis/access-token.js +86 -7
  6. package/dist/apis/address-suggestions.cjs +133 -11
  7. package/dist/apis/address-suggestions.d.cts +4 -4
  8. package/dist/apis/address-suggestions.d.ts +4 -4
  9. package/dist/apis/address-suggestions.js +129 -7
  10. package/dist/apis/address.cjs +85 -11
  11. package/dist/apis/address.d.cts +4 -4
  12. package/dist/apis/address.d.ts +4 -4
  13. package/dist/apis/address.js +81 -7
  14. package/dist/apis/ai-agents.cjs +216 -11
  15. package/dist/apis/ai-agents.d.cts +4 -4
  16. package/dist/apis/ai-agents.d.ts +4 -4
  17. package/dist/apis/ai-agents.js +212 -7
  18. package/dist/apis/app.cjs +574 -11
  19. package/dist/apis/app.d.cts +4 -4
  20. package/dist/apis/app.d.ts +4 -4
  21. package/dist/apis/app.js +570 -7
  22. package/dist/apis/audit-logs.cjs +56 -11
  23. package/dist/apis/audit-logs.d.cts +4 -4
  24. package/dist/apis/audit-logs.d.ts +4 -4
  25. package/dist/apis/audit-logs.js +52 -7
  26. package/dist/apis/automation.cjs +283 -11
  27. package/dist/apis/automation.d.cts +4 -4
  28. package/dist/apis/automation.d.ts +4 -4
  29. package/dist/apis/automation.js +279 -7
  30. package/dist/apis/billing.cjs +176 -11
  31. package/dist/apis/billing.d.cts +4 -4
  32. package/dist/apis/billing.d.ts +4 -4
  33. package/dist/apis/billing.js +172 -7
  34. package/dist/apis/blueprint-manifest.cjs +505 -11
  35. package/dist/apis/blueprint-manifest.d.cts +4 -4
  36. package/dist/apis/blueprint-manifest.d.ts +4 -4
  37. package/dist/apis/blueprint-manifest.js +501 -7
  38. package/dist/apis/consent.cjs +85 -11
  39. package/dist/apis/consent.d.cts +4 -4
  40. package/dist/apis/consent.d.ts +4 -4
  41. package/dist/apis/consent.js +81 -7
  42. package/dist/apis/customer-portal.cjs +2253 -11
  43. package/dist/apis/customer-portal.d.cts +4 -4
  44. package/dist/apis/customer-portal.d.ts +4 -4
  45. package/dist/apis/customer-portal.js +2249 -7
  46. package/dist/apis/data-management.cjs +241 -11
  47. package/dist/apis/data-management.d.cts +4 -4
  48. package/dist/apis/data-management.d.ts +4 -4
  49. package/dist/apis/data-management.js +237 -7
  50. package/dist/apis/deduplication.cjs +43 -11
  51. package/dist/apis/deduplication.d.cts +4 -4
  52. package/dist/apis/deduplication.d.ts +4 -4
  53. package/dist/apis/deduplication.js +39 -7
  54. package/dist/apis/design.cjs +220 -11
  55. package/dist/apis/design.d.cts +4 -4
  56. package/dist/apis/design.d.ts +4 -4
  57. package/dist/apis/design.js +216 -7
  58. package/dist/apis/document.cjs +79 -11
  59. package/dist/apis/document.d.cts +4 -4
  60. package/dist/apis/document.d.ts +4 -4
  61. package/dist/apis/document.js +75 -7
  62. package/dist/apis/email-settings.cjs +534 -11
  63. package/dist/apis/email-settings.d.cts +4 -4
  64. package/dist/apis/email-settings.d.ts +4 -4
  65. package/dist/apis/email-settings.js +530 -7
  66. package/dist/apis/email-template.cjs +123 -11
  67. package/dist/apis/email-template.d.cts +4 -4
  68. package/dist/apis/email-template.d.ts +4 -4
  69. package/dist/apis/email-template.js +119 -7
  70. package/dist/apis/entity-mapping.cjs +216 -11
  71. package/dist/apis/entity-mapping.d.cts +4 -4
  72. package/dist/apis/entity-mapping.d.ts +4 -4
  73. package/dist/apis/entity-mapping.js +212 -7
  74. package/dist/apis/entity.cjs +1601 -11
  75. package/dist/apis/entity.d.cts +4 -4
  76. package/dist/apis/entity.d.ts +4 -4
  77. package/dist/apis/entity.js +1597 -7
  78. package/dist/apis/environments.cjs +72 -11
  79. package/dist/apis/environments.d.cts +4 -4
  80. package/dist/apis/environments.d.ts +4 -4
  81. package/dist/apis/environments.js +68 -7
  82. package/dist/apis/erp-integration.cjs +587 -11
  83. package/dist/apis/erp-integration.d.cts +4 -4
  84. package/dist/apis/erp-integration.d.ts +4 -4
  85. package/dist/apis/erp-integration.js +583 -7
  86. package/dist/apis/event-catalog.cjs +131 -11
  87. package/dist/apis/event-catalog.d.cts +4 -4
  88. package/dist/apis/event-catalog.d.ts +4 -4
  89. package/dist/apis/event-catalog.js +127 -7
  90. package/dist/apis/file.cjs +574 -11
  91. package/dist/apis/file.d.cts +4 -4
  92. package/dist/apis/file.d.ts +4 -4
  93. package/dist/apis/file.js +570 -7
  94. package/dist/apis/iban.cjs +44 -11
  95. package/dist/apis/iban.d.cts +4 -4
  96. package/dist/apis/iban.d.ts +4 -4
  97. package/dist/apis/iban.js +40 -7
  98. package/dist/apis/journey.cjs +271 -11
  99. package/dist/apis/journey.d.cts +4 -4
  100. package/dist/apis/journey.d.ts +4 -4
  101. package/dist/apis/journey.js +267 -7
  102. package/dist/apis/kanban.cjs +165 -11
  103. package/dist/apis/kanban.d.cts +4 -4
  104. package/dist/apis/kanban.d.ts +4 -4
  105. package/dist/apis/kanban.js +161 -7
  106. package/dist/apis/message.cjs +674 -11
  107. package/dist/apis/message.d.cts +4 -4
  108. package/dist/apis/message.d.ts +4 -4
  109. package/dist/apis/message.js +670 -7
  110. package/dist/apis/metering.cjs +400 -11
  111. package/dist/apis/metering.d.cts +4 -4
  112. package/dist/apis/metering.d.ts +4 -4
  113. package/dist/apis/metering.js +396 -7
  114. package/dist/apis/notes.cjs +220 -11
  115. package/dist/apis/notes.d.cts +4 -4
  116. package/dist/apis/notes.d.ts +4 -4
  117. package/dist/apis/notes.js +216 -7
  118. package/dist/apis/notification.cjs +238 -11
  119. package/dist/apis/notification.d.cts +4 -4
  120. package/dist/apis/notification.d.ts +4 -4
  121. package/dist/apis/notification.js +234 -7
  122. package/dist/apis/organization.cjs +119 -11
  123. package/dist/apis/organization.d.cts +4 -4
  124. package/dist/apis/organization.d.ts +4 -4
  125. package/dist/apis/organization.js +115 -7
  126. package/dist/apis/partner-directory.cjs +283 -11
  127. package/dist/apis/partner-directory.d.cts +4 -4
  128. package/dist/apis/partner-directory.d.ts +4 -4
  129. package/dist/apis/partner-directory.js +279 -7
  130. package/dist/apis/permissions.cjs +179 -11
  131. package/dist/apis/permissions.d.cts +4 -4
  132. package/dist/apis/permissions.d.ts +4 -4
  133. package/dist/apis/permissions.js +175 -7
  134. package/dist/apis/pricing-tier.cjs +40 -14
  135. package/dist/apis/pricing-tier.d.cts +4 -4
  136. package/dist/apis/pricing-tier.d.ts +4 -4
  137. package/dist/apis/pricing-tier.js +33 -7
  138. package/dist/apis/pricing.cjs +440 -11
  139. package/dist/apis/pricing.d.cts +4 -4
  140. package/dist/apis/pricing.d.ts +4 -4
  141. package/dist/apis/pricing.js +436 -7
  142. package/dist/apis/purpose.cjs +181 -11
  143. package/dist/apis/purpose.d.cts +4 -4
  144. package/dist/apis/purpose.d.ts +4 -4
  145. package/dist/apis/purpose.js +177 -7
  146. package/dist/apis/sandbox.cjs +101 -11
  147. package/dist/apis/sandbox.d.cts +4 -4
  148. package/dist/apis/sandbox.d.ts +4 -4
  149. package/dist/apis/sandbox.js +97 -7
  150. package/dist/apis/submission.cjs +56 -11
  151. package/dist/apis/submission.d.cts +4 -4
  152. package/dist/apis/submission.d.ts +4 -4
  153. package/dist/apis/submission.js +52 -7
  154. package/dist/apis/targeting.cjs +276 -11
  155. package/dist/apis/targeting.d.cts +4 -4
  156. package/dist/apis/targeting.d.ts +4 -4
  157. package/dist/apis/targeting.js +272 -7
  158. package/dist/apis/template-variables.cjs +160 -11
  159. package/dist/apis/template-variables.d.cts +4 -4
  160. package/dist/apis/template-variables.d.ts +4 -4
  161. package/dist/apis/template-variables.js +156 -7
  162. package/dist/apis/user.cjs +489 -11
  163. package/dist/apis/user.d.cts +4 -4
  164. package/dist/apis/user.d.ts +4 -4
  165. package/dist/apis/user.js +485 -7
  166. package/dist/apis/validation-rules.cjs +121 -11
  167. package/dist/apis/validation-rules.d.cts +4 -4
  168. package/dist/apis/validation-rules.d.ts +4 -4
  169. package/dist/apis/validation-rules.js +117 -7
  170. package/dist/apis/webhooks.cjs +253 -11
  171. package/dist/apis/webhooks.d.cts +4 -4
  172. package/dist/apis/webhooks.d.ts +4 -4
  173. package/dist/apis/webhooks.js +249 -7
  174. package/dist/apis/workflow-definition.cjs +343 -11
  175. package/dist/apis/workflow-definition.d.cts +4 -4
  176. package/dist/apis/workflow-definition.d.ts +4 -4
  177. package/dist/apis/workflow-definition.js +339 -7
  178. package/dist/apis/workflow.cjs +403 -11
  179. package/dist/apis/workflow.d.cts +4 -4
  180. package/dist/apis/workflow.d.ts +4 -4
  181. package/dist/apis/workflow.js +399 -7
  182. package/dist/{chunk-YYLPAGF4.cjs → chunk-D7ICL3AM.cjs} +20 -9
  183. package/dist/{chunk-UCDXDIUX.js → chunk-DGCGLG7G.js} +18 -7
  184. package/dist/index.cjs +68 -220
  185. package/dist/index.d.cts +67 -69
  186. package/dist/index.d.ts +67 -69
  187. package/dist/index.js +66 -218
  188. package/dist/{types-C5cGIwtq.d.cts → types-BwBvJkY_.d.cts} +12 -6
  189. package/dist/{types-C5cGIwtq.d.ts → types-BwBvJkY_.d.ts} +12 -6
  190. package/package.json +3 -7
  191. package/dist/access-token-MYDOBCIY.cjs +0 -89
  192. package/dist/access-token-Y5JR7PRG.js +0 -89
  193. package/dist/address-3RQRG3MK.js +0 -84
  194. package/dist/address-LQUTDOUA.cjs +0 -84
  195. package/dist/address-suggestions-PEKSA7B2.cjs +0 -132
  196. package/dist/address-suggestions-QNK5JWNH.js +0 -132
  197. package/dist/ai-agents-MO4PK2RJ.cjs +0 -215
  198. package/dist/ai-agents-OHP2F243.js +0 -215
  199. package/dist/apis/discussion.cjs +0 -33
  200. package/dist/apis/discussion.d.cts +0 -18
  201. package/dist/apis/discussion.d.ts +0 -18
  202. package/dist/apis/discussion.js +0 -33
  203. package/dist/app-UUTBO3WJ.js +0 -573
  204. package/dist/app-XJGY6SHO.cjs +0 -573
  205. package/dist/audit-logs-4IJYIOXF.js +0 -55
  206. package/dist/audit-logs-UWLCPBB4.cjs +0 -55
  207. package/dist/automation-4UQADTDO.cjs +0 -282
  208. package/dist/automation-PVXTQLZX.js +0 -282
  209. package/dist/billing-FI4V4UX5.cjs +0 -175
  210. package/dist/billing-OMWNJHGW.js +0 -175
  211. package/dist/blueprint-manifest-CPQAL76N.cjs +0 -504
  212. package/dist/blueprint-manifest-FIMGDHSH.js +0 -504
  213. package/dist/chunk-3RG5ZIWI.js +0 -10
  214. package/dist/chunk-OBGZSXTJ.cjs +0 -10
  215. package/dist/consent-NHDCDJMK.js +0 -84
  216. package/dist/consent-R5GU3WCK.cjs +0 -84
  217. package/dist/customer-portal-6AV2W43T.cjs +0 -2252
  218. package/dist/customer-portal-EY57GJYV.js +0 -2252
  219. package/dist/data-management-ILQUYNTN.cjs +0 -240
  220. package/dist/data-management-QMXOLOEG.js +0 -240
  221. package/dist/deduplication-IVXANO7S.cjs +0 -42
  222. package/dist/deduplication-WN45DVK3.js +0 -42
  223. package/dist/design-ONRLY6XI.cjs +0 -219
  224. package/dist/design-UHMRO3PG.js +0 -219
  225. package/dist/discussion-4CZIG3ZM.cjs +0 -134
  226. package/dist/discussion-VWMWL2AF.js +0 -134
  227. package/dist/discussion.d-DQucoYl_.d.cts +0 -579
  228. package/dist/discussion.d-DQucoYl_.d.ts +0 -579
  229. package/dist/document-CN3JNXFF.js +0 -78
  230. package/dist/document-PCKNZA4K.cjs +0 -78
  231. package/dist/email-settings-ANURQMKZ.js +0 -533
  232. package/dist/email-settings-YE2XB2ZU.cjs +0 -533
  233. package/dist/email-template-4QI4YS4J.js +0 -122
  234. package/dist/email-template-BUJBC6HH.cjs +0 -122
  235. package/dist/entity-BCFE3UJT.cjs +0 -1600
  236. package/dist/entity-VEXNQC4Y.js +0 -1600
  237. package/dist/entity-mapping-PHRLSYP7.cjs +0 -215
  238. package/dist/entity-mapping-QK7MGNAW.js +0 -215
  239. package/dist/environments-266S44UM.cjs +0 -71
  240. package/dist/environments-AV7W6SLT.js +0 -71
  241. package/dist/erp-integration-5WNBCGWS.cjs +0 -586
  242. package/dist/erp-integration-EMI5WIWA.js +0 -586
  243. package/dist/event-catalog-DBWYKQ6J.cjs +0 -130
  244. package/dist/event-catalog-KKMXV5LB.js +0 -130
  245. package/dist/file-3ZLMS6TL.js +0 -573
  246. package/dist/file-Q66N5XMG.cjs +0 -573
  247. package/dist/iban-HSXVSIFW.cjs +0 -43
  248. package/dist/iban-Q27INTOC.js +0 -43
  249. package/dist/journey-DGKXVWZQ.js +0 -270
  250. package/dist/journey-T2Y72EBS.cjs +0 -270
  251. package/dist/kanban-A4B6RCJ2.cjs +0 -164
  252. package/dist/kanban-PP6WJVT2.js +0 -164
  253. package/dist/message-D6JY4GJH.cjs +0 -673
  254. package/dist/message-HFX2DDCV.js +0 -673
  255. package/dist/metering-63MJFCS2.cjs +0 -399
  256. package/dist/metering-F63PNFCZ.js +0 -399
  257. package/dist/notes-FTL5H4JE.cjs +0 -219
  258. package/dist/notes-GMWTQCMB.js +0 -219
  259. package/dist/notification-WXFSOORN.cjs +0 -237
  260. package/dist/notification-XHG3TIBW.js +0 -237
  261. package/dist/organization-CPXTUDJO.js +0 -118
  262. package/dist/organization-XIFV7MWP.cjs +0 -118
  263. package/dist/partner-directory-4WCHPJRO.js +0 -282
  264. package/dist/partner-directory-FKWPPO7F.cjs +0 -282
  265. package/dist/permissions-5E36GPG3.js +0 -178
  266. package/dist/permissions-PBTK5CCD.cjs +0 -178
  267. package/dist/pricing-FDWEBIQU.js +0 -439
  268. package/dist/pricing-FZQKL4DW.cjs +0 -439
  269. package/dist/pricing-tier-34O624R4.js +0 -36
  270. package/dist/pricing-tier-F4HE6WIM.cjs +0 -36
  271. package/dist/purpose-47HJIG2Q.cjs +0 -180
  272. package/dist/purpose-MX33NU5H.js +0 -180
  273. package/dist/sandbox-7QNLGFN2.cjs +0 -100
  274. package/dist/sandbox-TZCXHBJN.js +0 -100
  275. package/dist/submission-6LSPBI27.js +0 -55
  276. package/dist/submission-DBQNDJ4B.cjs +0 -55
  277. package/dist/targeting-HZRCLNIF.cjs +0 -275
  278. package/dist/targeting-MTQ6JBCY.js +0 -275
  279. package/dist/template-variables-S6IXK7SF.js +0 -159
  280. package/dist/template-variables-VPNIMC7L.cjs +0 -159
  281. package/dist/user-BHH4DAA5.cjs +0 -488
  282. package/dist/user-KBXFVRPI.js +0 -488
  283. package/dist/validation-rules-4V7KAWGW.cjs +0 -120
  284. package/dist/validation-rules-UGQY4ASY.js +0 -120
  285. package/dist/webhooks-JR475VD4.js +0 -252
  286. package/dist/webhooks-X64U3KCB.cjs +0 -252
  287. package/dist/workflow-7ANPQZDP.cjs +0 -402
  288. package/dist/workflow-DWSAHA5Q.js +0 -402
  289. package/dist/workflow-definition-2M3JBCUI.cjs +0 -342
  290. package/dist/workflow-definition-WLPGEU55.js +0 -342
@@ -1,2252 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-OBGZSXTJ.cjs');
2
-
3
- // src/definitions/customer-portal.json
4
- var openapi = "3.0.3";
5
- var info = {
6
- title: "",
7
- version: ""
8
- };
9
- var paths = {
10
- "/v2/portal/portal": {
11
- post: {
12
- operationId: "upsertPortal",
13
- parameters: [
14
- {
15
- in: "query",
16
- name: "origin",
17
- required: true
18
- },
19
- {
20
- in: "query",
21
- name: "portal_id",
22
- required: false
23
- }
24
- ],
25
- requestBody: {
26
- required: true,
27
- content: {
28
- "application/json": {}
29
- }
30
- },
31
- responses: {}
32
- }
33
- },
34
- "/v2/portal/public/user": {
35
- post: {
36
- operationId: "createUser",
37
- parameters: [
38
- {
39
- in: "query",
40
- name: "origin",
41
- required: true
42
- }
43
- ],
44
- requestBody: {
45
- required: true,
46
- content: {
47
- "application/json": {}
48
- }
49
- },
50
- responses: {}
51
- }
52
- },
53
- "/v3/portal/public/user": {
54
- post: {
55
- operationId: "createUserV3",
56
- parameters: [
57
- {
58
- in: "query",
59
- name: "portal_id",
60
- required: true
61
- }
62
- ],
63
- requestBody: {
64
- required: true,
65
- content: {
66
- "application/json": {}
67
- }
68
- },
69
- responses: {}
70
- }
71
- },
72
- "/v2/portal/token/validate": {
73
- post: {
74
- operationId: "validateToken",
75
- responses: {}
76
- }
77
- },
78
- "/v2/portal/token/revoke": {
79
- post: {
80
- operationId: "revokeToken",
81
- requestBody: {
82
- required: true,
83
- content: {
84
- "application/json": {}
85
- }
86
- },
87
- responses: {}
88
- }
89
- },
90
- "/v2/portal/public/config": {
91
- get: {
92
- operationId: "getPortalConfigByDomain",
93
- parameters: [
94
- {
95
- in: "query",
96
- name: "domain",
97
- required: true
98
- }
99
- ],
100
- responses: {}
101
- }
102
- },
103
- "/v2/portal/config": {
104
- get: {
105
- operationId: "getPortalConfig",
106
- parameters: [
107
- {
108
- in: "query",
109
- name: "origin",
110
- required: false
111
- }
112
- ],
113
- responses: {}
114
- },
115
- delete: {
116
- operationId: "deletePortal",
117
- parameters: [
118
- {
119
- in: "query",
120
- name: "origin",
121
- required: true
122
- }
123
- ],
124
- responses: {}
125
- }
126
- },
127
- "/v2/portal/extensions": {
128
- get: {
129
- operationId: "getPortalExtensions",
130
- parameters: [
131
- {
132
- in: "query",
133
- name: "origin",
134
- required: false
135
- }
136
- ],
137
- responses: {}
138
- }
139
- },
140
- "/v2/portal/public/extensions": {
141
- get: {
142
- operationId: "getPublicPortalExtensionDetails",
143
- parameters: [
144
- {
145
- in: "query",
146
- name: "org_id",
147
- required: true
148
- },
149
- {
150
- in: "query",
151
- name: "origin",
152
- required: true
153
- }
154
- ],
155
- responses: {}
156
- }
157
- },
158
- "/v3/portal/extensions": {
159
- get: {
160
- operationId: "getPortalExtensionsV3",
161
- parameters: [
162
- {
163
- in: "query",
164
- name: "portal_id",
165
- required: true
166
- }
167
- ],
168
- responses: {}
169
- }
170
- },
171
- "/v3/portal/public/extensions": {
172
- get: {
173
- operationId: "getPublicPortalExtensionDetailsV3",
174
- parameters: [
175
- {
176
- in: "query",
177
- name: "org_id",
178
- required: false
179
- },
180
- {
181
- in: "query",
182
- name: "portal_id",
183
- required: false
184
- },
185
- {
186
- in: "query",
187
- name: "domain",
188
- required: false
189
- }
190
- ],
191
- responses: {}
192
- }
193
- },
194
- "/v2/portal/consumption": {
195
- get: {
196
- operationId: "getConsumption",
197
- parameters: [
198
- {
199
- in: "query",
200
- name: "app_id",
201
- required: false
202
- },
203
- {
204
- in: "query",
205
- name: "extensionId",
206
- required: true
207
- },
208
- {
209
- in: "query",
210
- name: "hookId",
211
- required: true
212
- },
213
- {
214
- in: "query",
215
- name: "meter_id",
216
- required: false,
217
- deprecated: true
218
- },
219
- {
220
- in: "query",
221
- name: "from",
222
- required: true
223
- },
224
- {
225
- in: "query",
226
- name: "to",
227
- required: true
228
- },
229
- {
230
- in: "query",
231
- name: "interval",
232
- required: true
233
- },
234
- {
235
- in: "query",
236
- name: "context_entities",
237
- required: false
238
- }
239
- ],
240
- responses: {}
241
- }
242
- },
243
- "/v2/portal/costs": {
244
- get: {
245
- operationId: "getCosts",
246
- parameters: [
247
- {
248
- in: "query",
249
- name: "app_id",
250
- required: false
251
- },
252
- {
253
- in: "query",
254
- name: "extensionId",
255
- required: true
256
- },
257
- {
258
- in: "query",
259
- name: "hookId",
260
- required: true
261
- },
262
- {
263
- in: "query",
264
- name: "meter_id",
265
- required: false,
266
- deprecated: true
267
- },
268
- {
269
- in: "query",
270
- name: "from",
271
- required: true
272
- },
273
- {
274
- in: "query",
275
- name: "to",
276
- required: true
277
- },
278
- {
279
- in: "query",
280
- name: "interval",
281
- required: true
282
- },
283
- {
284
- in: "query",
285
- name: "context_entities",
286
- required: false
287
- }
288
- ],
289
- responses: {}
290
- }
291
- },
292
- "/v2/portal/prices": {
293
- get: {
294
- operationId: "getPrices",
295
- parameters: [
296
- {
297
- in: "query",
298
- name: "app_id",
299
- required: false
300
- },
301
- {
302
- in: "query",
303
- name: "extensionId",
304
- required: true
305
- },
306
- {
307
- in: "query",
308
- name: "hookId",
309
- required: true
310
- },
311
- {
312
- in: "query",
313
- name: "meter_id",
314
- required: false,
315
- deprecated: true
316
- },
317
- {
318
- in: "query",
319
- name: "from",
320
- required: true
321
- },
322
- {
323
- in: "query",
324
- name: "to",
325
- required: true
326
- },
327
- {
328
- in: "query",
329
- name: "interval",
330
- required: true
331
- },
332
- {
333
- in: "query",
334
- name: "context_entities",
335
- required: false
336
- }
337
- ],
338
- responses: {}
339
- }
340
- },
341
- "/v2/portal/external-links": {
342
- get: {
343
- operationId: "getExternalLinks",
344
- parameters: [
345
- {
346
- in: "query",
347
- name: "origin",
348
- required: false
349
- },
350
- {
351
- in: "query",
352
- name: "contactId",
353
- required: false
354
- }
355
- ],
356
- responses: {}
357
- }
358
- },
359
- "/v2/portal/resolve:external-link/{id}": {
360
- get: {
361
- operationId: "getResolvedExternalLink",
362
- deprecated: true,
363
- parameters: [
364
- {
365
- in: "path",
366
- name: "id",
367
- required: true
368
- },
369
- {
370
- in: "query",
371
- name: "origin",
372
- required: false
373
- },
374
- {
375
- in: "query",
376
- name: "contactId",
377
- required: false
378
- }
379
- ],
380
- responses: {}
381
- }
382
- },
383
- "/v3/portal/external-links": {
384
- get: {
385
- operationId: "getExternalLinksV3",
386
- parameters: [
387
- {
388
- in: "query",
389
- name: "portal_id",
390
- required: false
391
- },
392
- {
393
- in: "query",
394
- name: "contactId",
395
- required: false
396
- }
397
- ],
398
- responses: {}
399
- }
400
- },
401
- "/v3/portal/resolve:external-link/{id}": {
402
- get: {
403
- operationId: "getResolvedExternalLinkV3",
404
- deprecated: true,
405
- parameters: [
406
- {
407
- in: "path",
408
- name: "id",
409
- required: true
410
- },
411
- {
412
- in: "query",
413
- name: "portal_id",
414
- required: false
415
- },
416
- {
417
- in: "query",
418
- name: "contactId",
419
- required: false
420
- }
421
- ],
422
- responses: {}
423
- }
424
- },
425
- "/v2/portal/resolve:seamless-link": {
426
- get: {
427
- operationId: "getResolvedSeamlessLink",
428
- parameters: [
429
- {
430
- in: "query",
431
- name: "app_id",
432
- required: false
433
- },
434
- {
435
- in: "query",
436
- name: "extension_id",
437
- required: true
438
- },
439
- {
440
- in: "query",
441
- name: "link_id",
442
- required: true
443
- },
444
- {
445
- in: "query",
446
- name: "context_entities",
447
- required: false
448
- }
449
- ],
450
- responses: {}
451
- }
452
- },
453
- "/v2/portal/public/portal/config": {
454
- get: {
455
- operationId: "getPublicPortalConfig",
456
- parameters: [
457
- {
458
- in: "query",
459
- name: "org_id",
460
- required: true
461
- },
462
- {
463
- in: "query",
464
- name: "origin",
465
- required: true
466
- }
467
- ],
468
- responses: {}
469
- }
470
- },
471
- "/v2/portal/org/portal/config": {
472
- get: {
473
- operationId: "getOrgPortalConfig",
474
- parameters: [
475
- {
476
- in: "query",
477
- name: "origin",
478
- required: true
479
- }
480
- ],
481
- responses: {}
482
- }
483
- },
484
- "/v3/portal/public/portal/config": {
485
- get: {
486
- operationId: "getPublicPortalConfigV3",
487
- parameters: [
488
- {
489
- in: "query",
490
- name: "org_id",
491
- required: true
492
- },
493
- {
494
- in: "query",
495
- name: "portal_id",
496
- required: true
497
- }
498
- ],
499
- responses: {}
500
- }
501
- },
502
- "/v3/portal/org/portal/config": {
503
- get: {
504
- operationId: "getOrgPortalConfigV3",
505
- parameters: [
506
- {
507
- in: "query",
508
- name: "portal_id",
509
- required: true
510
- }
511
- ],
512
- responses: {}
513
- }
514
- },
515
- "/v2/portal/configs": {
516
- get: {
517
- operationId: "getAllPortalConfigs",
518
- responses: {}
519
- }
520
- },
521
- "/v2/portal/email-templates": {
522
- post: {
523
- operationId: "upsertEmailTemplates",
524
- parameters: [
525
- {
526
- in: "query",
527
- name: "origin",
528
- required: true
529
- }
530
- ],
531
- requestBody: {
532
- required: true,
533
- content: {
534
- "application/json": {}
535
- }
536
- },
537
- responses: {}
538
- },
539
- get: {
540
- operationId: "getEmailTemplates",
541
- parameters: [
542
- {
543
- in: "query",
544
- name: "origin",
545
- required: true
546
- }
547
- ],
548
- responses: {}
549
- }
550
- },
551
- "/v3/portal/email-templates/{portal_id}": {
552
- post: {
553
- operationId: "upsertEmailTemplatesByPortalId",
554
- parameters: [
555
- {
556
- in: "path",
557
- name: "portal_id",
558
- required: true
559
- }
560
- ],
561
- requestBody: {
562
- required: true,
563
- content: {
564
- "application/json": {}
565
- }
566
- },
567
- responses: {}
568
- },
569
- get: {
570
- operationId: "getEmailTemplatesByPortalId",
571
- parameters: [
572
- {
573
- in: "path",
574
- name: "portal_id",
575
- required: true
576
- }
577
- ],
578
- responses: {}
579
- }
580
- },
581
- "/v2/portal/public-widgets": {
582
- get: {
583
- operationId: "getPublicPortalWidgets",
584
- parameters: [
585
- {
586
- in: "query",
587
- name: "org_id",
588
- required: true
589
- },
590
- {
591
- in: "query",
592
- name: "origin",
593
- required: true
594
- }
595
- ],
596
- responses: {}
597
- }
598
- },
599
- "/v2/portal/widgets": {
600
- post: {
601
- operationId: "upsertPortalWidget",
602
- parameters: [
603
- {
604
- in: "query",
605
- name: "origin",
606
- required: true
607
- }
608
- ],
609
- requestBody: {
610
- required: true,
611
- content: {
612
- "application/json": {}
613
- }
614
- },
615
- responses: {}
616
- },
617
- get: {
618
- operationId: "getPortalWidgets",
619
- parameters: [
620
- {
621
- in: "query",
622
- name: "origin",
623
- required: false
624
- },
625
- {
626
- in: "query",
627
- name: "contract_id",
628
- required: false
629
- }
630
- ],
631
- responses: {}
632
- }
633
- },
634
- "/v2/portal/replace-ecp-template-variables": {
635
- post: {
636
- operationId: "replaceECPTemplateVariables",
637
- requestBody: {
638
- content: {
639
- "application/json": {}
640
- }
641
- },
642
- responses: {}
643
- }
644
- },
645
- "/v2/portal/org/settings": {
646
- get: {
647
- operationId: "getOrganizationSettings",
648
- deprecated: true,
649
- responses: {}
650
- }
651
- },
652
- "/v2/portal/schemas": {
653
- get: {
654
- operationId: "getSchemas",
655
- responses: {}
656
- }
657
- },
658
- "/v2/portal/public/schemas": {
659
- get: {
660
- operationId: "getSchemasByDomain",
661
- parameters: [
662
- {
663
- in: "query",
664
- name: "domain",
665
- required: true
666
- }
667
- ],
668
- responses: {}
669
- }
670
- },
671
- "/v2/portal/public/org/settings": {
672
- get: {
673
- operationId: "getOrganizationSettingsByDomain",
674
- parameters: [
675
- {
676
- in: "query",
677
- name: "domain",
678
- required: true
679
- }
680
- ],
681
- responses: {}
682
- }
683
- },
684
- "/v2/portal/extra-permission-attributes": {
685
- get: {
686
- operationId: "extraPermissionAttributes",
687
- responses: {}
688
- }
689
- },
690
- "/v2/portal/validate/caa-records": {
691
- post: {
692
- operationId: "validateCaaRecords",
693
- parameters: [
694
- {
695
- in: "query",
696
- name: "origin",
697
- required: true
698
- }
699
- ],
700
- responses: {}
701
- }
702
- },
703
- "/v3/portal/validate/caa-records": {
704
- post: {
705
- operationId: "validateCaaRecordsV3",
706
- parameters: [
707
- {
708
- in: "query",
709
- name: "portal_id",
710
- required: true
711
- }
712
- ],
713
- responses: {}
714
- }
715
- },
716
- "/v2/portal/contact": {
717
- get: {
718
- operationId: "getContact",
719
- responses: {}
720
- },
721
- patch: {
722
- operationId: "updateContact",
723
- requestBody: {
724
- content: {
725
- "application/json": {}
726
- }
727
- },
728
- responses: {}
729
- }
730
- },
731
- "/v2/portal/ecp/contact": {
732
- get: {
733
- operationId: "getECPContact",
734
- parameters: [
735
- {
736
- in: "query",
737
- name: "id",
738
- required: true
739
- }
740
- ],
741
- responses: {}
742
- }
743
- },
744
- "/v2/portal/public/contact/exists": {
745
- post: {
746
- operationId: "checkContactExists",
747
- parameters: [
748
- {
749
- in: "query",
750
- name: "origin",
751
- required: true
752
- }
753
- ],
754
- requestBody: {
755
- required: true,
756
- content: {
757
- "application/json": {}
758
- }
759
- },
760
- responses: {}
761
- }
762
- },
763
- "/v3/portal/public/contact/exists": {
764
- post: {
765
- operationId: "checkContactExistsV3",
766
- parameters: [
767
- {
768
- in: "query",
769
- name: "portal_id",
770
- required: true
771
- }
772
- ],
773
- requestBody: {
774
- required: true,
775
- content: {
776
- "application/json": {}
777
- }
778
- },
779
- responses: {}
780
- }
781
- },
782
- "/v2/portal/contact/valid/secondary/attributes": {
783
- get: {
784
- operationId: "getValidSecondaryAttributes",
785
- responses: {}
786
- }
787
- },
788
- "/v2/portal/user": {
789
- get: {
790
- operationId: "getPortalUser",
791
- responses: {}
792
- },
793
- patch: {
794
- operationId: "updatePortalUser",
795
- requestBody: {
796
- content: {
797
- "application/json": {}
798
- }
799
- },
800
- responses: {}
801
- },
802
- delete: {
803
- operationId: "deletePortalUser",
804
- responses: {}
805
- }
806
- },
807
- "/v2/portal/user/update/email": {
808
- put: {
809
- operationId: "updatePortalUserEmail",
810
- requestBody: {
811
- required: true,
812
- content: {
813
- "application/json": {}
814
- }
815
- },
816
- responses: {}
817
- }
818
- },
819
- "/v2/portal/user/resend/confirmation-email/{id}": {
820
- post: {
821
- operationId: "resendConfirmationEmail",
822
- parameters: [
823
- {
824
- in: "path",
825
- name: "id",
826
- required: true
827
- }
828
- ],
829
- responses: {}
830
- }
831
- },
832
- "/v2/portal/users/by-related-entity": {
833
- get: {
834
- operationId: "fetchPortalUsersByRelatedEntity",
835
- parameters: [
836
- {
837
- in: "query",
838
- name: "entity_id",
839
- required: true
840
- },
841
- {
842
- in: "query",
843
- name: "slug",
844
- required: true
845
- }
846
- ],
847
- responses: {}
848
- }
849
- },
850
- "/v2/portal/user/confirm": {
851
- get: {
852
- operationId: "confirmUser",
853
- parameters: [
854
- {
855
- in: "query",
856
- name: "confirmation_link_token",
857
- required: true
858
- },
859
- {
860
- in: "query",
861
- name: "use_redirect",
862
- required: false
863
- }
864
- ],
865
- responses: {}
866
- }
867
- },
868
- "/v2/portal/user/confirm/{id}": {
869
- get: {
870
- operationId: "confirmUserWithUserId",
871
- parameters: [
872
- {
873
- in: "query",
874
- name: "origin",
875
- required: true
876
- },
877
- {
878
- in: "path",
879
- name: "id",
880
- required: true
881
- },
882
- {
883
- in: "query",
884
- name: "org_id",
885
- required: true
886
- }
887
- ],
888
- responses: {}
889
- }
890
- },
891
- "/v2/portal/public/user/exists": {
892
- get: {
893
- operationId: "userExists",
894
- parameters: [
895
- {
896
- in: "query",
897
- name: "email",
898
- required: true
899
- },
900
- {
901
- in: "query",
902
- name: "org_id",
903
- required: true
904
- },
905
- {
906
- in: "query",
907
- name: "origin",
908
- required: false
909
- }
910
- ],
911
- responses: {}
912
- }
913
- },
914
- "/v3/portal/public/user/exists": {
915
- get: {
916
- operationId: "userExistsV3",
917
- parameters: [
918
- {
919
- in: "query",
920
- name: "email",
921
- required: true
922
- },
923
- {
924
- in: "query",
925
- name: "org_id",
926
- required: true
927
- },
928
- {
929
- in: "query",
930
- name: "portal_id",
931
- required: false
932
- }
933
- ],
934
- responses: {}
935
- }
936
- },
937
- "/v2/portal/recipients-to-notify": {
938
- post: {
939
- operationId: "getRecipientsToNotifyOnAutomation",
940
- requestBody: {
941
- content: {
942
- "application/json": {}
943
- }
944
- },
945
- responses: {}
946
- }
947
- },
948
- "/v2/portal/configure-distribution": {
949
- get: {
950
- operationId: "configureDistribution",
951
- parameters: [
952
- {
953
- in: "query",
954
- name: "origin",
955
- required: true
956
- }
957
- ],
958
- responses: {}
959
- }
960
- },
961
- "/v3/portal/configure-distribution": {
962
- get: {
963
- operationId: "configureDistributionV3",
964
- parameters: [
965
- {
966
- in: "query",
967
- name: "portal_id",
968
- required: true
969
- }
970
- ],
971
- responses: {}
972
- }
973
- },
974
- "/v2/portal/order": {
975
- get: {
976
- operationId: "getAllOrders",
977
- parameters: [
978
- {
979
- in: "query",
980
- name: "from",
981
- required: false
982
- },
983
- {
984
- in: "query",
985
- name: "size",
986
- required: false
987
- }
988
- ],
989
- responses: {}
990
- }
991
- },
992
- "/v2/portal/order/{id}/acceptance": {
993
- post: {
994
- operationId: "postOrderAcceptance",
995
- parameters: [
996
- {
997
- in: "path",
998
- name: "id",
999
- required: true
1000
- }
1001
- ],
1002
- requestBody: {
1003
- content: {
1004
- "application/json": {}
1005
- }
1006
- },
1007
- responses: {}
1008
- }
1009
- },
1010
- "/v2/portal/order/{id}": {
1011
- get: {
1012
- operationId: "getOrder",
1013
- parameters: [
1014
- {
1015
- in: "path",
1016
- name: "id",
1017
- required: true
1018
- }
1019
- ],
1020
- responses: {}
1021
- },
1022
- patch: {
1023
- operationId: "updateOrder",
1024
- parameters: [
1025
- {
1026
- in: "path",
1027
- name: "id",
1028
- required: true
1029
- }
1030
- ],
1031
- requestBody: {
1032
- content: {
1033
- "application/json": {}
1034
- }
1035
- },
1036
- responses: {}
1037
- }
1038
- },
1039
- "/v2/portal/opportunity": {
1040
- get: {
1041
- operationId: "getAllOpportunities",
1042
- parameters: [
1043
- {
1044
- in: "query",
1045
- name: "from",
1046
- required: false
1047
- },
1048
- {
1049
- in: "query",
1050
- name: "size",
1051
- required: false
1052
- }
1053
- ],
1054
- responses: {}
1055
- }
1056
- },
1057
- "/v2/portal/opportunities/searchable-attributes": {
1058
- get: {
1059
- operationId: "getSearchableAttributesForOpportunities",
1060
- parameters: [
1061
- {
1062
- in: "query",
1063
- name: "from",
1064
- required: false
1065
- },
1066
- {
1067
- in: "query",
1068
- name: "size",
1069
- required: false
1070
- }
1071
- ],
1072
- responses: {}
1073
- }
1074
- },
1075
- "/v2/portal/opportunities/search": {
1076
- post: {
1077
- operationId: "getSearchResultsForOpportunities",
1078
- parameters: [
1079
- {
1080
- in: "query",
1081
- name: "from",
1082
- required: false
1083
- },
1084
- {
1085
- in: "query",
1086
- name: "size",
1087
- required: false
1088
- }
1089
- ],
1090
- requestBody: {
1091
- required: true,
1092
- content: {
1093
- "application/json": {}
1094
- }
1095
- },
1096
- responses: {}
1097
- }
1098
- },
1099
- "/v2/portal/opportunities/{id}": {
1100
- get: {
1101
- operationId: "getOpportunity",
1102
- parameters: [
1103
- {
1104
- in: "path",
1105
- name: "id",
1106
- required: true
1107
- }
1108
- ],
1109
- responses: {}
1110
- },
1111
- patch: {
1112
- operationId: "updateOpportunity",
1113
- parameters: [
1114
- {
1115
- in: "path",
1116
- name: "id",
1117
- required: true
1118
- }
1119
- ],
1120
- requestBody: {
1121
- required: true,
1122
- content: {
1123
- "application/json": {}
1124
- }
1125
- },
1126
- responses: {}
1127
- }
1128
- },
1129
- "/v2/portal/request": {
1130
- get: {
1131
- operationId: "getAllRequests",
1132
- parameters: [
1133
- {
1134
- in: "query",
1135
- name: "from",
1136
- required: false
1137
- },
1138
- {
1139
- in: "query",
1140
- name: "size",
1141
- required: false
1142
- }
1143
- ],
1144
- responses: {}
1145
- }
1146
- },
1147
- "/v2/portal/contract": {
1148
- get: {
1149
- operationId: "getAllContracts",
1150
- parameters: [
1151
- {
1152
- in: "query",
1153
- name: "from",
1154
- required: false
1155
- },
1156
- {
1157
- in: "query",
1158
- name: "size",
1159
- required: false
1160
- }
1161
- ],
1162
- responses: {}
1163
- }
1164
- },
1165
- "/v2/portal/contract/{id}": {
1166
- get: {
1167
- operationId: "getContract",
1168
- parameters: [
1169
- {
1170
- in: "path",
1171
- name: "id",
1172
- required: true
1173
- }
1174
- ],
1175
- responses: {}
1176
- },
1177
- patch: {
1178
- operationId: "updateContract",
1179
- parameters: [
1180
- {
1181
- in: "path",
1182
- name: "id",
1183
- required: true
1184
- }
1185
- ],
1186
- requestBody: {
1187
- required: true,
1188
- content: {
1189
- "application/json": {}
1190
- }
1191
- },
1192
- responses: {}
1193
- }
1194
- },
1195
- "/v2/portal/contract/by-identifiers": {
1196
- post: {
1197
- operationId: "addContractByIdentifiers",
1198
- requestBody: {
1199
- required: true,
1200
- content: {
1201
- "application/json": {}
1202
- }
1203
- },
1204
- responses: {}
1205
- }
1206
- },
1207
- "/v2/portal/entity/identifiers/{slug}": {
1208
- get: {
1209
- operationId: "getEntityIdentifiers",
1210
- parameters: [
1211
- {
1212
- in: "path",
1213
- name: "slug",
1214
- required: true
1215
- }
1216
- ],
1217
- responses: {}
1218
- }
1219
- },
1220
- "/v2/portal/entity/{slug}/{id}/activity": {
1221
- get: {
1222
- operationId: "getEntityActivityFeed",
1223
- parameters: [
1224
- {
1225
- in: "path",
1226
- name: "slug",
1227
- required: true
1228
- },
1229
- {
1230
- in: "path",
1231
- name: "id",
1232
- required: true
1233
- },
1234
- {
1235
- in: "query",
1236
- name: "after"
1237
- },
1238
- {
1239
- in: "query",
1240
- name: "before"
1241
- },
1242
- {
1243
- in: "query",
1244
- name: "from"
1245
- },
1246
- {
1247
- in: "query",
1248
- name: "size"
1249
- },
1250
- {
1251
- in: "query",
1252
- name: "type"
1253
- },
1254
- {
1255
- in: "query",
1256
- name: "include_relations"
1257
- }
1258
- ],
1259
- responses: {}
1260
- }
1261
- },
1262
- "/v2/portal/{slug}/{id}:validateRule": {
1263
- get: {
1264
- operationId: "validateCadenceEntityEditRules",
1265
- parameters: [
1266
- {
1267
- in: "path",
1268
- name: "slug",
1269
- required: true
1270
- },
1271
- {
1272
- in: "path",
1273
- name: "id",
1274
- required: true
1275
- },
1276
- {
1277
- in: "query",
1278
- name: "attribute"
1279
- }
1280
- ],
1281
- responses: {}
1282
- }
1283
- },
1284
- "/v2/portal/entities-by-payment/{id}": {
1285
- get: {
1286
- operationId: "searchPaymentRelationsInEntities",
1287
- parameters: [
1288
- {
1289
- in: "path",
1290
- name: "id",
1291
- required: true
1292
- }
1293
- ],
1294
- responses: {}
1295
- }
1296
- },
1297
- "/v2/portal/entity/activity": {
1298
- put: {
1299
- operationId: "createCustomEntityActivity",
1300
- parameters: [
1301
- {
1302
- in: "query",
1303
- name: "entities",
1304
- deprecated: true,
1305
- style: "form"
1306
- }
1307
- ],
1308
- requestBody: {
1309
- content: {
1310
- "application/json": {}
1311
- }
1312
- },
1313
- responses: {}
1314
- }
1315
- },
1316
- "/v2/portal/entity/file": {
1317
- post: {
1318
- operationId: "saveEntityFile",
1319
- requestBody: {
1320
- required: true,
1321
- content: {
1322
- "application/json": {}
1323
- }
1324
- },
1325
- responses: {}
1326
- },
1327
- delete: {
1328
- operationId: "deleteEntityFile",
1329
- requestBody: {
1330
- required: true,
1331
- content: {
1332
- "application/json": {}
1333
- }
1334
- },
1335
- responses: {}
1336
- }
1337
- },
1338
- "/v2/portal/portal/files": {
1339
- post: {
1340
- operationId: "savePortalFiles",
1341
- requestBody: {
1342
- required: true,
1343
- content: {
1344
- "application/json": {}
1345
- }
1346
- },
1347
- responses: {}
1348
- }
1349
- },
1350
- "/v2/portal/registration/identifiers": {
1351
- get: {
1352
- operationId: "getRegistrationIdentifiers",
1353
- responses: {}
1354
- }
1355
- },
1356
- "/v2/portal/user/files": {
1357
- get: {
1358
- operationId: "getAllFiles",
1359
- deprecated: true,
1360
- parameters: [
1361
- {
1362
- in: "query",
1363
- name: "from",
1364
- required: true
1365
- },
1366
- {
1367
- in: "query",
1368
- name: "size",
1369
- required: true
1370
- },
1371
- {
1372
- in: "query",
1373
- name: "entity_ids"
1374
- },
1375
- {
1376
- in: "query",
1377
- name: "file_types"
1378
- }
1379
- ],
1380
- responses: {}
1381
- }
1382
- },
1383
- "/v2/portal/user/file/{id}": {
1384
- get: {
1385
- operationId: "getFileById",
1386
- parameters: [
1387
- {
1388
- in: "path",
1389
- name: "id",
1390
- required: true
1391
- }
1392
- ],
1393
- responses: {}
1394
- }
1395
- },
1396
- "/v2/portal/user/file/{id}/downloaded": {
1397
- post: {
1398
- operationId: "trackFileDownloaded",
1399
- parameters: [
1400
- {
1401
- in: "path",
1402
- name: "id",
1403
- required: true
1404
- }
1405
- ],
1406
- responses: {}
1407
- }
1408
- },
1409
- "/v2/portal/user/files/count-by-entity": {
1410
- get: {
1411
- operationId: "getFilesCountByEntity",
1412
- deprecated: true,
1413
- responses: {}
1414
- }
1415
- },
1416
- "/v2/portal/billing/events": {
1417
- get: {
1418
- operationId: "getBillingEvents",
1419
- parameters: [
1420
- {
1421
- in: "query",
1422
- name: "from",
1423
- required: false
1424
- },
1425
- {
1426
- in: "query",
1427
- name: "size",
1428
- required: false
1429
- },
1430
- {
1431
- name: "entity_id",
1432
- in: "query",
1433
- required: false
1434
- },
1435
- {
1436
- name: "event_type",
1437
- in: "query"
1438
- },
1439
- {
1440
- name: "paid",
1441
- in: "query"
1442
- },
1443
- {
1444
- name: "date_after",
1445
- in: "query"
1446
- },
1447
- {
1448
- name: "date_before",
1449
- in: "query"
1450
- },
1451
- {
1452
- name: "sort",
1453
- in: "query"
1454
- }
1455
- ],
1456
- responses: {}
1457
- }
1458
- },
1459
- "/v2/portal/billing/customers/balance": {
1460
- get: {
1461
- operationId: "getCustomerBalance",
1462
- responses: {}
1463
- }
1464
- },
1465
- "/v2/portal/billing/accounts/{id}": {
1466
- parameters: [
1467
- {
1468
- in: "path",
1469
- name: "id",
1470
- required: true
1471
- }
1472
- ],
1473
- get: {
1474
- operationId: "getBillingAccount",
1475
- responses: {}
1476
- }
1477
- },
1478
- "/v2/portal/admin:login-as-user": {
1479
- post: {
1480
- operationId: "loginToPortalAsUser",
1481
- requestBody: {
1482
- required: true,
1483
- content: {
1484
- "application/json": {}
1485
- }
1486
- },
1487
- responses: {}
1488
- }
1489
- },
1490
- "/v2/portal/entity/{schema}/access": {
1491
- post: {
1492
- operationId: "triggerEntityAccessEvent",
1493
- parameters: [
1494
- {
1495
- name: "schema",
1496
- in: "path",
1497
- required: true
1498
- },
1499
- {
1500
- name: "entity_id",
1501
- in: "query",
1502
- required: false
1503
- },
1504
- {
1505
- name: "origin",
1506
- in: "query",
1507
- required: true
1508
- }
1509
- ],
1510
- responses: {}
1511
- }
1512
- },
1513
- "/v3/portal/entity/{schema}/access": {
1514
- post: {
1515
- operationId: "triggerEntityAccessEventV3",
1516
- parameters: [
1517
- {
1518
- name: "schema",
1519
- in: "path",
1520
- required: true
1521
- },
1522
- {
1523
- name: "entity_id",
1524
- in: "query",
1525
- required: false
1526
- },
1527
- {
1528
- name: "portal_id",
1529
- in: "query",
1530
- required: true
1531
- }
1532
- ],
1533
- responses: {}
1534
- }
1535
- },
1536
- "/v2/portal/entity:get": {
1537
- post: {
1538
- operationId: "getPortalUserEntity",
1539
- requestBody: {
1540
- content: {
1541
- "application/json": {}
1542
- }
1543
- },
1544
- responses: {}
1545
- }
1546
- },
1547
- "/v2/portal/entity:search": {
1548
- post: {
1549
- operationId: "searchPortalUserEntities",
1550
- requestBody: {
1551
- content: {
1552
- "application/json": {}
1553
- }
1554
- },
1555
- responses: {}
1556
- }
1557
- },
1558
- "/v2/portal/can-trigger-portal-flow": {
1559
- post: {
1560
- operationId: "canTriggerPortalFlow",
1561
- parameters: [
1562
- {
1563
- in: "query",
1564
- name: "origin",
1565
- required: false,
1566
- deprecated: true
1567
- },
1568
- {
1569
- in: "query",
1570
- name: "portal_id",
1571
- required: true
1572
- }
1573
- ],
1574
- requestBody: {
1575
- required: true,
1576
- content: {
1577
- "application/json": {}
1578
- }
1579
- },
1580
- responses: {}
1581
- }
1582
- },
1583
- "/v2/portal/automation-context": {
1584
- get: {
1585
- operationId: "getAutomationContext",
1586
- parameters: [
1587
- {
1588
- in: "query",
1589
- name: "activity_id",
1590
- required: true
1591
- },
1592
- {
1593
- in: "query",
1594
- name: "type",
1595
- required: true
1596
- }
1597
- ],
1598
- responses: {}
1599
- }
1600
- },
1601
- "/v2/portal/workflow/{workflow_id}/{step_id}:markDone": {
1602
- put: {
1603
- operationId: "updateWorkflowStepAsDone",
1604
- parameters: [
1605
- {
1606
- in: "path",
1607
- name: "workflow_id",
1608
- required: true
1609
- },
1610
- {
1611
- in: "path",
1612
- name: "step_id",
1613
- required: true
1614
- }
1615
- ],
1616
- responses: {}
1617
- }
1618
- },
1619
- "/v2/portal/entity/{slug}/{id}/workflows": {
1620
- get: {
1621
- operationId: "getEntityWorkflows",
1622
- parameters: [
1623
- {
1624
- in: "path",
1625
- name: "slug",
1626
- required: true
1627
- },
1628
- {
1629
- in: "path",
1630
- name: "id",
1631
- required: true
1632
- }
1633
- ],
1634
- responses: {}
1635
- }
1636
- },
1637
- "/v2/portal/metering/reading/photo": {
1638
- post: {
1639
- operationId: "uploadMeterReadingPhoto",
1640
- requestBody: {
1641
- required: true,
1642
- content: {
1643
- "application/json": {}
1644
- }
1645
- },
1646
- responses: {}
1647
- }
1648
- },
1649
- "/v2/portal/metering/reading": {
1650
- post: {
1651
- operationId: "createMeterReading",
1652
- parameters: [
1653
- {
1654
- name: "override_plausibility",
1655
- in: "query",
1656
- required: false
1657
- }
1658
- ],
1659
- requestBody: {
1660
- required: true,
1661
- content: {
1662
- "application/json": {}
1663
- }
1664
- },
1665
- responses: {}
1666
- }
1667
- },
1668
- "/v2/portal/metering/reading/allowed-range/{meter_id}": {
1669
- get: {
1670
- operationId: "getAllowedMeterReadingRange",
1671
- parameters: [
1672
- {
1673
- in: "path",
1674
- name: "meter_id",
1675
- required: true
1676
- },
1677
- {
1678
- in: "query",
1679
- name: "origin",
1680
- required: false
1681
- },
1682
- {
1683
- in: "query",
1684
- name: "timestamp",
1685
- required: false
1686
- },
1687
- {
1688
- in: "query",
1689
- name: "context_entities",
1690
- required: false
1691
- }
1692
- ],
1693
- responses: {}
1694
- }
1695
- },
1696
- "/v2/portal/public/sso/login": {
1697
- post: {
1698
- operationId: "ssoLogin",
1699
- parameters: [
1700
- {
1701
- in: "query",
1702
- name: "origin",
1703
- required: true
1704
- },
1705
- {
1706
- in: "query",
1707
- name: "org_id",
1708
- required: true
1709
- },
1710
- {
1711
- in: "query",
1712
- name: "contact_id",
1713
- required: false
1714
- }
1715
- ],
1716
- requestBody: {
1717
- content: {
1718
- "application/json": {}
1719
- }
1720
- },
1721
- responses: {}
1722
- }
1723
- },
1724
- "/v3/portal/public/sso/login": {
1725
- post: {
1726
- operationId: "ssoLoginV3",
1727
- parameters: [
1728
- {
1729
- in: "query",
1730
- name: "portal_id",
1731
- required: true
1732
- },
1733
- {
1734
- in: "query",
1735
- name: "org_id",
1736
- required: true
1737
- },
1738
- {
1739
- in: "query",
1740
- name: "contact_id",
1741
- required: false
1742
- }
1743
- ],
1744
- requestBody: {
1745
- content: {
1746
- "application/json": {}
1747
- }
1748
- },
1749
- responses: {}
1750
- }
1751
- },
1752
- "/v2/portal/public/sso/redirect": {
1753
- post: {
1754
- operationId: "ssoRedirect",
1755
- parameters: [
1756
- {
1757
- in: "query",
1758
- name: "web_uri",
1759
- required: true
1760
- }
1761
- ],
1762
- requestBody: {
1763
- required: true,
1764
- content: {
1765
- "multipart/form-data": {}
1766
- }
1767
- },
1768
- responses: {}
1769
- }
1770
- },
1771
- "/v2/portal/public/sso/callback": {
1772
- post: {
1773
- operationId: "ssoCallback",
1774
- parameters: [
1775
- {
1776
- in: "query",
1777
- name: "domain"
1778
- }
1779
- ],
1780
- requestBody: {
1781
- required: true,
1782
- content: {
1783
- "application/json": {}
1784
- }
1785
- },
1786
- responses: {}
1787
- }
1788
- },
1789
- "/v2/portal/pages/{id}": {
1790
- parameters: [
1791
- {
1792
- in: "path",
1793
- name: "id",
1794
- required: true
1795
- }
1796
- ],
1797
- get: {
1798
- operationId: "getPortalPage",
1799
- responses: {}
1800
- },
1801
- put: {
1802
- operationId: "updatePortalPage",
1803
- requestBody: {
1804
- required: true,
1805
- content: {
1806
- "application/json": {}
1807
- }
1808
- },
1809
- responses: {}
1810
- },
1811
- delete: {
1812
- operationId: "deletePortalPage",
1813
- responses: {}
1814
- }
1815
- },
1816
- "/v2/portal/pages": {
1817
- parameters: [
1818
- {
1819
- in: "query",
1820
- name: "domain",
1821
- required: true
1822
- }
1823
- ],
1824
- get: {
1825
- operationId: "getPortalPages",
1826
- parameters: [
1827
- {
1828
- in: "query",
1829
- name: "fields",
1830
- required: false
1831
- },
1832
- {
1833
- in: "query",
1834
- name: "filter",
1835
- required: false
1836
- },
1837
- {
1838
- in: "query",
1839
- name: "contract_id",
1840
- required: false,
1841
- deprecated: true
1842
- },
1843
- {
1844
- in: "query",
1845
- name: "context_entities",
1846
- required: false
1847
- }
1848
- ],
1849
- responses: {}
1850
- },
1851
- post: {
1852
- operationId: "createPortalPage",
1853
- requestBody: {
1854
- required: true,
1855
- content: {
1856
- "application/json": {}
1857
- }
1858
- },
1859
- responses: {}
1860
- }
1861
- },
1862
- "/v2/portal/public/pages": {
1863
- get: {
1864
- operationId: "getPublicPages",
1865
- parameters: [
1866
- {
1867
- in: "query",
1868
- name: "domain",
1869
- required: true
1870
- },
1871
- {
1872
- in: "query",
1873
- name: "fields",
1874
- required: false
1875
- },
1876
- {
1877
- in: "query",
1878
- name: "filter",
1879
- required: false
1880
- }
1881
- ],
1882
- responses: {}
1883
- }
1884
- },
1885
- "/v2/portal/pages/default": {
1886
- get: {
1887
- operationId: "getDefaultPages",
1888
- responses: {}
1889
- }
1890
- },
1891
- "/v2/portal/pages/{id}/blocks": {
1892
- parameters: [
1893
- {
1894
- in: "path",
1895
- name: "id",
1896
- required: true
1897
- }
1898
- ],
1899
- post: {
1900
- operationId: "createPortalPageBlock",
1901
- requestBody: {
1902
- required: true,
1903
- content: {
1904
- "application/json": {}
1905
- }
1906
- },
1907
- responses: {}
1908
- },
1909
- get: {
1910
- operationId: "getPortalPageBlocks",
1911
- responses: {}
1912
- }
1913
- },
1914
- "/v2/portal/pages/{id}/blocks/{block_id}": {
1915
- parameters: [
1916
- {
1917
- in: "path",
1918
- name: "id",
1919
- required: true
1920
- },
1921
- {
1922
- in: "path",
1923
- name: "block_id",
1924
- required: true
1925
- }
1926
- ],
1927
- get: {
1928
- operationId: "getPortalPageBlock",
1929
- responses: {}
1930
- },
1931
- put: {
1932
- operationId: "updatePortalPageBlock",
1933
- requestBody: {
1934
- required: true,
1935
- content: {
1936
- "application/json": {}
1937
- }
1938
- },
1939
- responses: {}
1940
- },
1941
- delete: {
1942
- operationId: "deletePortalPageBlock",
1943
- responses: {}
1944
- }
1945
- },
1946
- "/v2/portal/public/user/entry-point": {
1947
- get: {
1948
- operationId: "getUserEntryPoint",
1949
- parameters: [
1950
- {
1951
- in: "query",
1952
- name: "email",
1953
- required: true
1954
- },
1955
- {
1956
- in: "query",
1957
- name: "domain",
1958
- required: true
1959
- }
1960
- ],
1961
- responses: {}
1962
- }
1963
- },
1964
- "/v2/portal/campaign/{campaign_id}/entity:status": {
1965
- put: {
1966
- operationId: "updateCampaignPortalBlockStatus",
1967
- parameters: [
1968
- {
1969
- in: "path",
1970
- name: "campaign_id",
1971
- required: true
1972
- }
1973
- ],
1974
- requestBody: {
1975
- required: true,
1976
- content: {
1977
- "application/json": {}
1978
- }
1979
- },
1980
- responses: {}
1981
- }
1982
- },
1983
- "/v2/portal/notifications/entity:status": {
1984
- put: {
1985
- operationId: "updateNotificationsStatus",
1986
- requestBody: {
1987
- required: true,
1988
- content: {
1989
- "application/json": {}
1990
- }
1991
- },
1992
- responses: {}
1993
- }
1994
- },
1995
- "/v2/portal/public/m-login/deregister/{client_id}/{user_id}": {
1996
- delete: {
1997
- operationId: "deRegisterMLoginUser",
1998
- parameters: [
1999
- {
2000
- in: "path",
2001
- name: "client_id",
2002
- required: true
2003
- },
2004
- {
2005
- in: "path",
2006
- name: "user_id",
2007
- required: true
2008
- }
2009
- ],
2010
- responses: {}
2011
- }
2012
- },
2013
- "/v2/portal/public/m-login/notify-interest-change/{client_id}/{user_id}": {
2014
- post: {
2015
- operationId: "notifyMLoginInterestChange",
2016
- parameters: [
2017
- {
2018
- in: "path",
2019
- name: "client_id",
2020
- required: true
2021
- },
2022
- {
2023
- in: "path",
2024
- name: "user_id",
2025
- required: true
2026
- }
2027
- ],
2028
- requestBody: {
2029
- required: true,
2030
- content: {
2031
- "application/json": {}
2032
- }
2033
- },
2034
- responses: {}
2035
- }
2036
- },
2037
- "/v3/portal/config": {
2038
- post: {
2039
- operationId: "createPortalConfig",
2040
- requestBody: {
2041
- required: true,
2042
- content: {
2043
- "application/json": {}
2044
- }
2045
- },
2046
- responses: {}
2047
- }
2048
- },
2049
- "/v3/portal/config/{portal_id}": {
2050
- get: {
2051
- operationId: "getPortalConfigV3",
2052
- parameters: [
2053
- {
2054
- in: "path",
2055
- name: "portal_id",
2056
- required: true
2057
- }
2058
- ],
2059
- responses: {}
2060
- },
2061
- put: {
2062
- operationId: "putPortalConfig",
2063
- parameters: [
2064
- {
2065
- in: "path",
2066
- name: "portal_id",
2067
- required: true
2068
- }
2069
- ],
2070
- requestBody: {
2071
- required: true,
2072
- content: {
2073
- "application/json": {}
2074
- }
2075
- },
2076
- responses: {}
2077
- },
2078
- delete: {
2079
- operationId: "deletePortalConfig",
2080
- parameters: [
2081
- {
2082
- in: "path",
2083
- name: "portal_id",
2084
- required: true
2085
- }
2086
- ],
2087
- responses: {}
2088
- }
2089
- },
2090
- "/v3/portal/configs": {
2091
- get: {
2092
- operationId: "listAllPortalConfigs",
2093
- responses: {}
2094
- }
2095
- },
2096
- "/v3/portal/config/swap": {
2097
- post: {
2098
- operationId: "swapPortalConfig",
2099
- requestBody: {
2100
- required: true,
2101
- content: {
2102
- "application/json": {}
2103
- }
2104
- },
2105
- responses: {}
2106
- }
2107
- },
2108
- "/v3/portal/partner/invite": {
2109
- post: {
2110
- operationId: "invitePartner",
2111
- requestBody: {
2112
- required: true,
2113
- content: {
2114
- "application/json": {}
2115
- }
2116
- },
2117
- responses: {}
2118
- }
2119
- },
2120
- "/v3/portal/partner/list": {
2121
- get: {
2122
- operationId: "listBusinessPartners",
2123
- responses: {}
2124
- }
2125
- },
2126
- "/v3/portal/partner/{partner_id}/resend-invitation": {
2127
- post: {
2128
- operationId: "resendPartnerInvitation",
2129
- parameters: [
2130
- {
2131
- name: "partner_id",
2132
- in: "path",
2133
- required: true
2134
- }
2135
- ],
2136
- responses: {}
2137
- }
2138
- },
2139
- "/v3/portal/partner/{partner_id}/revoke": {
2140
- delete: {
2141
- operationId: "revokePartner",
2142
- parameters: [
2143
- {
2144
- name: "partner_id",
2145
- in: "path",
2146
- required: true
2147
- }
2148
- ],
2149
- responses: {}
2150
- }
2151
- },
2152
- "/v3/portal/partner/{partner_id}/disable": {
2153
- post: {
2154
- operationId: "disablePartner",
2155
- parameters: [
2156
- {
2157
- name: "partner_id",
2158
- in: "path",
2159
- required: true
2160
- }
2161
- ],
2162
- responses: {}
2163
- }
2164
- },
2165
- "/v3/portal/partner/{partner_id}/enable": {
2166
- post: {
2167
- operationId: "enablePartner",
2168
- parameters: [
2169
- {
2170
- name: "partner_id",
2171
- in: "path",
2172
- required: true
2173
- }
2174
- ],
2175
- responses: {}
2176
- }
2177
- }
2178
- };
2179
- var components = {
2180
- responses: {
2181
- InvalidRequest: {
2182
- content: {
2183
- "application/json": {}
2184
- }
2185
- },
2186
- Unauthorized: {
2187
- content: {
2188
- "application/json": {}
2189
- }
2190
- },
2191
- Forbidden: {
2192
- content: {
2193
- "application/json": {}
2194
- }
2195
- },
2196
- ForbiddenByRule: {
2197
- content: {
2198
- "application/json": {}
2199
- }
2200
- },
2201
- Conflict: {
2202
- content: {
2203
- "application/json": {}
2204
- }
2205
- },
2206
- ContractAssignmentConflict: {
2207
- content: {
2208
- "application/json": {}
2209
- }
2210
- },
2211
- NotFound: {
2212
- content: {
2213
- "application/json": {}
2214
- }
2215
- },
2216
- InternalServerError: {
2217
- content: {
2218
- "application/json": {}
2219
- }
2220
- },
2221
- ConfirmUserInvalidRequest: {
2222
- content: {
2223
- "application/json": {}
2224
- }
2225
- },
2226
- InvalidRequestCreateMeterReading: {
2227
- content: {
2228
- "application/json": {}
2229
- }
2230
- }
2231
- }
2232
- };
2233
- var servers = [
2234
- {
2235
- url: "https://customer-portal-api.sls.epilot.io"
2236
- }
2237
- ];
2238
- var customer_portal_default = {
2239
- openapi,
2240
- info,
2241
- paths,
2242
- components,
2243
- servers
2244
- };
2245
-
2246
-
2247
-
2248
-
2249
-
2250
-
2251
-
2252
- exports.components = components; exports.default = customer_portal_default; exports.info = info; exports.openapi = openapi; exports.paths = paths; exports.servers = servers;