@epilot/sdk 2.4.4-alpha.0 → 2.4.4

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 (222) hide show
  1. package/dist/access-token.d-CnmUTOlq.d.cts +552 -0
  2. package/dist/access-token.d-CnmUTOlq.d.ts +552 -0
  3. package/dist/address-suggestions.d-_YwTOR-9.d.cts +339 -0
  4. package/dist/address-suggestions.d-_YwTOR-9.d.ts +339 -0
  5. package/dist/address.d-CwAPOVxa.d.cts +437 -0
  6. package/dist/address.d-CwAPOVxa.d.ts +437 -0
  7. package/dist/ai-agents.d-OkXfr2bz.d.cts +1339 -0
  8. package/dist/ai-agents.d-OkXfr2bz.d.ts +1339 -0
  9. package/dist/apis/access-token.d.cts +18 -0
  10. package/dist/apis/access-token.d.ts +12 -9
  11. package/dist/apis/address-suggestions.d.cts +18 -0
  12. package/dist/apis/address-suggestions.d.ts +12 -9
  13. package/dist/apis/address.d.cts +18 -0
  14. package/dist/apis/address.d.ts +12 -9
  15. package/dist/apis/ai-agents.d.cts +18 -0
  16. package/dist/apis/ai-agents.d.ts +12 -9
  17. package/dist/apis/app.d.cts +18 -0
  18. package/dist/apis/app.d.ts +12 -9
  19. package/dist/apis/audit-logs.d.cts +18 -0
  20. package/dist/apis/audit-logs.d.ts +12 -9
  21. package/dist/apis/automation.d.cts +18 -0
  22. package/dist/apis/automation.d.ts +12 -9
  23. package/dist/apis/billing.d.cts +18 -0
  24. package/dist/apis/billing.d.ts +12 -9
  25. package/dist/apis/blueprint-manifest.d.cts +18 -0
  26. package/dist/apis/blueprint-manifest.d.ts +12 -9
  27. package/dist/apis/calendar.d.cts +18 -0
  28. package/dist/apis/calendar.d.ts +12 -9
  29. package/dist/apis/configuration-hub.d.cts +18 -0
  30. package/dist/apis/configuration-hub.d.ts +12 -9
  31. package/dist/apis/consent.d.cts +18 -0
  32. package/dist/apis/consent.d.ts +12 -9
  33. package/dist/apis/customer-portal.d.cts +18 -0
  34. package/dist/apis/customer-portal.d.ts +12 -9
  35. package/dist/apis/dashboard.d.cts +18 -0
  36. package/dist/apis/dashboard.d.ts +12 -9
  37. package/dist/apis/data-governance.d.cts +18 -0
  38. package/dist/apis/data-governance.d.ts +12 -9
  39. package/dist/apis/deduplication.d.cts +18 -0
  40. package/dist/apis/deduplication.d.ts +12 -9
  41. package/dist/apis/design.d.cts +18 -0
  42. package/dist/apis/design.d.ts +12 -9
  43. package/dist/apis/document.d.cts +18 -0
  44. package/dist/apis/document.d.ts +12 -9
  45. package/dist/apis/email-settings.d.cts +18 -0
  46. package/dist/apis/email-settings.d.ts +12 -9
  47. package/dist/apis/email-template.d.cts +18 -0
  48. package/dist/apis/email-template.d.ts +12 -9
  49. package/dist/apis/entity-mapping.d.cts +18 -0
  50. package/dist/apis/entity-mapping.d.ts +12 -9
  51. package/dist/apis/entity.d.cts +18 -0
  52. package/dist/apis/entity.d.ts +12 -9
  53. package/dist/apis/environments.d.cts +18 -0
  54. package/dist/apis/environments.d.ts +12 -9
  55. package/dist/apis/event-catalog.d.cts +18 -0
  56. package/dist/apis/event-catalog.d.ts +12 -9
  57. package/dist/apis/file.d.cts +18 -0
  58. package/dist/apis/file.d.ts +12 -9
  59. package/dist/apis/iban.d.cts +18 -0
  60. package/dist/apis/iban.d.ts +12 -9
  61. package/dist/apis/integration-toolkit.d.cts +18 -0
  62. package/dist/apis/integration-toolkit.d.ts +12 -9
  63. package/dist/apis/journey.d.cts +18 -0
  64. package/dist/apis/journey.d.ts +12 -9
  65. package/dist/apis/kanban.d.cts +18 -0
  66. package/dist/apis/kanban.d.ts +12 -9
  67. package/dist/apis/message.d.cts +18 -0
  68. package/dist/apis/message.d.ts +12 -9
  69. package/dist/apis/metering.d.cts +18 -0
  70. package/dist/apis/metering.d.ts +12 -9
  71. package/dist/apis/notes.d.cts +18 -0
  72. package/dist/apis/notes.d.ts +12 -9
  73. package/dist/apis/notification.d.cts +18 -0
  74. package/dist/apis/notification.d.ts +12 -9
  75. package/dist/apis/organization.d.cts +18 -0
  76. package/dist/apis/organization.d.ts +12 -9
  77. package/dist/apis/partner-directory.d.cts +18 -0
  78. package/dist/apis/partner-directory.d.ts +12 -9
  79. package/dist/apis/permissions.d.cts +18 -0
  80. package/dist/apis/permissions.d.ts +12 -9
  81. package/dist/apis/pricing-tier.d.cts +18 -0
  82. package/dist/apis/pricing-tier.d.ts +12 -9
  83. package/dist/apis/pricing.d.cts +18 -0
  84. package/dist/apis/pricing.d.ts +12 -9
  85. package/dist/apis/purpose.d.cts +18 -0
  86. package/dist/apis/purpose.d.ts +12 -9
  87. package/dist/apis/query.d.cts +18 -0
  88. package/dist/apis/query.d.ts +12 -9
  89. package/dist/apis/sandbox.d.cts +18 -0
  90. package/dist/apis/sandbox.d.ts +12 -9
  91. package/dist/apis/sharing.d.cts +18 -0
  92. package/dist/apis/sharing.d.ts +12 -9
  93. package/dist/apis/submission.d.cts +18 -0
  94. package/dist/apis/submission.d.ts +12 -9
  95. package/dist/apis/target.d.cts +597 -0
  96. package/dist/apis/target.d.ts +591 -9
  97. package/dist/apis/targeting.d.cts +18 -0
  98. package/dist/apis/targeting.d.ts +12 -9
  99. package/dist/apis/template-variables.d.cts +18 -0
  100. package/dist/apis/template-variables.d.ts +12 -9
  101. package/dist/apis/user.d.cts +18 -0
  102. package/dist/apis/user.d.ts +12 -9
  103. package/dist/apis/validation-rules.d.cts +18 -0
  104. package/dist/apis/validation-rules.d.ts +12 -9
  105. package/dist/apis/webhooks.d.cts +18 -0
  106. package/dist/apis/webhooks.d.ts +12 -9
  107. package/dist/apis/workflow-definition.d.cts +18 -0
  108. package/dist/apis/workflow-definition.d.ts +12 -9
  109. package/dist/apis/workflow.d.cts +18 -0
  110. package/dist/apis/workflow.d.ts +12 -9
  111. package/dist/app.d-u7Dq42kU.d.cts +3391 -0
  112. package/dist/app.d-u7Dq42kU.d.ts +3391 -0
  113. package/dist/audit-logs.d-BRToFqeX.d.cts +287 -0
  114. package/dist/audit-logs.d-BRToFqeX.d.ts +287 -0
  115. package/dist/automation.d-Du6-uiz5.d.cts +5283 -0
  116. package/dist/automation.d-Du6-uiz5.d.ts +5283 -0
  117. package/dist/billing.d-Bs8Ku9qE.d.cts +993 -0
  118. package/dist/billing.d-Bs8Ku9qE.d.ts +993 -0
  119. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +4343 -0
  120. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +4343 -0
  121. package/dist/calendar.d-BEjLDagH.d.cts +353 -0
  122. package/dist/calendar.d-BEjLDagH.d.ts +353 -0
  123. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +478 -0
  124. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +478 -0
  125. package/dist/consent.d-C2PROHhX.d.cts +265 -0
  126. package/dist/consent.d-C2PROHhX.d.ts +265 -0
  127. package/dist/customer-portal.d-DyZ2n2dW.d.cts +16728 -0
  128. package/dist/customer-portal.d-DyZ2n2dW.d.ts +16728 -0
  129. package/dist/dashboard.d-CsGcA74I.d.cts +440 -0
  130. package/dist/dashboard.d-CsGcA74I.d.ts +440 -0
  131. package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
  132. package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
  133. package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
  134. package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
  135. package/dist/design.d-BRre8iLg.d.cts +2346 -0
  136. package/dist/design.d-BRre8iLg.d.ts +2346 -0
  137. package/dist/document.d-DN37pjdx.d.cts +648 -0
  138. package/dist/document.d-DN37pjdx.d.ts +648 -0
  139. package/dist/email-settings.d-B7Q_xT25.d.cts +2417 -0
  140. package/dist/email-settings.d-B7Q_xT25.d.ts +2417 -0
  141. package/dist/email-template.d-gtQkdaXM.d.cts +1188 -0
  142. package/dist/email-template.d-gtQkdaXM.d.ts +1188 -0
  143. package/dist/entity-mapping.d-DKSW3sfy.d.cts +1092 -0
  144. package/dist/entity-mapping.d-DKSW3sfy.d.ts +1092 -0
  145. package/dist/entity.d-BHR9dEon.d.cts +18479 -0
  146. package/dist/entity.d-BHR9dEon.d.ts +18479 -0
  147. package/dist/environments.d-BvqvN-PD.d.cts +382 -0
  148. package/dist/environments.d-BvqvN-PD.d.ts +382 -0
  149. package/dist/event-catalog.d-ENw6HO-w.d.cts +1511 -0
  150. package/dist/event-catalog.d-ENw6HO-w.d.ts +1511 -0
  151. package/dist/file.d-DcTJxjp7.d.cts +2992 -0
  152. package/dist/file.d-DcTJxjp7.d.ts +2992 -0
  153. package/dist/iban.d-BwdiGbxi.d.cts +70 -0
  154. package/dist/iban.d-BwdiGbxi.d.ts +70 -0
  155. package/dist/index.d.cts +182 -0
  156. package/dist/index.d.ts +182 -12
  157. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +5796 -0
  158. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +5796 -0
  159. package/dist/journey.d-ClXO0xK8.d.cts +1931 -0
  160. package/dist/journey.d-ClXO0xK8.d.ts +1931 -0
  161. package/dist/kanban.d-BHnSRCYW.d.cts +760 -0
  162. package/dist/kanban.d-BHnSRCYW.d.ts +760 -0
  163. package/dist/message.d-B5UuSqgw.d.cts +3811 -0
  164. package/dist/message.d-B5UuSqgw.d.ts +3811 -0
  165. package/dist/metering.d-DvtPv7wk.d.cts +1841 -0
  166. package/dist/metering.d-DvtPv7wk.d.ts +1841 -0
  167. package/dist/notes.d-BC-scR42.d.cts +1046 -0
  168. package/dist/notes.d-BC-scR42.d.ts +1046 -0
  169. package/dist/notification.d-BfBL3lga.d.cts +1147 -0
  170. package/dist/notification.d-BfBL3lga.d.ts +1147 -0
  171. package/dist/organization.d-DqwnNxMg.d.cts +1271 -0
  172. package/dist/organization.d-DqwnNxMg.d.ts +1271 -0
  173. package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
  174. package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
  175. package/dist/permissions.d-l6AT8SYP.d.cts +1279 -0
  176. package/dist/permissions.d-l6AT8SYP.d.ts +1279 -0
  177. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +81 -0
  178. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +81 -0
  179. package/dist/pricing.d-BHpMU4KU.d.cts +12255 -0
  180. package/dist/pricing.d-BHpMU4KU.d.ts +12255 -0
  181. package/dist/purpose.d-CbIYfTua.d.cts +372 -0
  182. package/dist/purpose.d-CbIYfTua.d.ts +372 -0
  183. package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
  184. package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
  185. package/dist/sandbox.d-BdbOFzDu.d.cts +465 -0
  186. package/dist/sandbox.d-BdbOFzDu.d.ts +465 -0
  187. package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
  188. package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
  189. package/dist/submission.d-BamwfhXw.d.cts +469 -0
  190. package/dist/submission.d-BamwfhXw.d.ts +469 -0
  191. package/dist/targeting.d-BNmcVsNS.d.cts +2057 -0
  192. package/dist/targeting.d-BNmcVsNS.d.ts +2057 -0
  193. package/dist/template-variables.d-Ble9TSBa.d.cts +1320 -0
  194. package/dist/template-variables.d-Ble9TSBa.d.ts +1320 -0
  195. package/dist/types-ChU9Acbv.d.cts +37 -0
  196. package/dist/types-ChU9Acbv.d.ts +37 -0
  197. package/dist/user.d-D18fe97W.d.cts +2270 -0
  198. package/dist/user.d-D18fe97W.d.ts +2270 -0
  199. package/dist/validation-rules.d-Db5c5zTf.d.cts +807 -0
  200. package/dist/validation-rules.d-Db5c5zTf.d.ts +807 -0
  201. package/dist/webhooks.d-pLHIL_io.d.cts +1256 -0
  202. package/dist/webhooks.d-pLHIL_io.d.ts +1256 -0
  203. package/dist/workflow-definition.d-DOeb0KVV.d.cts +1922 -0
  204. package/dist/workflow-definition.d-DOeb0KVV.d.ts +1922 -0
  205. package/dist/workflow.d-CMSKt8oN.d.cts +3151 -0
  206. package/dist/workflow.d-CMSKt8oN.d.ts +3151 -0
  207. package/package.json +1 -1
  208. package/dist/apis/_registry.d.ts +0 -8
  209. package/dist/authorize.d.ts +0 -3
  210. package/dist/bin/cli.d.ts +0 -1
  211. package/dist/client-factory.d.ts +0 -9
  212. package/dist/client-map.d.ts +0 -102
  213. package/dist/compact.d.ts +0 -22
  214. package/dist/help.d.ts +0 -12
  215. package/dist/large-response.d.ts +0 -9
  216. package/dist/openapi.d.ts +0 -12
  217. package/dist/overrides.d.ts +0 -9
  218. package/dist/proxy.d.ts +0 -14
  219. package/dist/registry.d.ts +0 -19
  220. package/dist/retry.d.ts +0 -11
  221. package/dist/sdk.d.ts +0 -29
  222. package/dist/types.d.ts +0 -53
@@ -0,0 +1,993 @@
1
+ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
+
3
+ /* Auto-copied from billing-client */
4
+ /* eslint-disable */
5
+
6
+
7
+
8
+ declare namespace Components {
9
+ namespace Schemas {
10
+ export interface Balance {
11
+ /**
12
+ * Current balance of the customer in cents. (precision 2)
13
+ * example:
14
+ * 8990
15
+ */
16
+ balance?: number;
17
+ /**
18
+ * Current balance of the customer in decimal string representation.
19
+ * example:
20
+ * 89.90
21
+ */
22
+ balance_decimal?: string;
23
+ balance_currency?: /**
24
+ * Currency code in ISO 4217 format
25
+ * example:
26
+ * EUR
27
+ */
28
+ Currency;
29
+ }
30
+ /**
31
+ * A base billing event to be inherited by all billing events.
32
+ */
33
+ export interface BaseBillingEvent {
34
+ [name: string]: any;
35
+ _id?: /**
36
+ * Entity ID
37
+ * example:
38
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
39
+ */
40
+ EntityId;
41
+ /**
42
+ * Title of entity
43
+ */
44
+ _title?: string;
45
+ /**
46
+ * Organization Id the entity belongs to
47
+ */
48
+ _org?: string;
49
+ _schema?: /**
50
+ * URL-friendly identifier for the entity schema
51
+ * example:
52
+ * contact
53
+ */
54
+ EntitySlug;
55
+ _tags?: string[];
56
+ _created_at?: string;
57
+ _updated_at?: string;
58
+ /**
59
+ * Amount to be paid in cents i.e. precision 2
60
+ * example:
61
+ * 10050
62
+ */
63
+ billing_amount: number;
64
+ /**
65
+ * Amount to be paid in cents in decimal string representation
66
+ * example:
67
+ * 100.50
68
+ */
69
+ billing_amount_decimal: string;
70
+ billing_currency: /**
71
+ * Currency code in ISO 4217 format
72
+ * example:
73
+ * EUR
74
+ */
75
+ Currency;
76
+ /**
77
+ * Unique identifier for event, used to reference the event to a 3rd party resource such as a SAP Installment.
78
+ * example:
79
+ * d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e
80
+ */
81
+ external_id?: string;
82
+ contract: {
83
+ $relation?: EntityRelationItem[];
84
+ };
85
+ }
86
+ export interface BaseEntity {
87
+ [name: string]: any;
88
+ _id?: /**
89
+ * Entity ID
90
+ * example:
91
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
92
+ */
93
+ EntityId;
94
+ /**
95
+ * Title of entity
96
+ */
97
+ _title?: string;
98
+ /**
99
+ * Organization Id the entity belongs to
100
+ */
101
+ _org?: string;
102
+ _schema?: /**
103
+ * URL-friendly identifier for the entity schema
104
+ * example:
105
+ * contact
106
+ */
107
+ EntitySlug;
108
+ _tags?: string[];
109
+ _created_at?: string;
110
+ _updated_at?: string;
111
+ }
112
+ /**
113
+ * An entity that describes a billing event such as a future installment or a reimbursement back to the customer.
114
+ */
115
+ export type BillingEvent = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ /* An entity that describes an installment billing event. */ InstallmentEvent | /* An entity that describes a reimbursement billing event. */ ReimbursementEvent;
116
+ export interface Contract {
117
+ [name: string]: any;
118
+ _id?: /**
119
+ * Entity ID
120
+ * example:
121
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
122
+ */
123
+ EntityId;
124
+ /**
125
+ * Title of entity
126
+ */
127
+ _title?: string;
128
+ /**
129
+ * Organization Id the entity belongs to
130
+ */
131
+ _org?: string;
132
+ _schema?: /**
133
+ * URL-friendly identifier for the entity schema
134
+ * example:
135
+ * contact
136
+ */
137
+ EntitySlug;
138
+ _tags?: string[];
139
+ _created_at?: string;
140
+ _updated_at?: string;
141
+ /**
142
+ * The name of the contract.
143
+ * example:
144
+ * Grid Contract
145
+ */
146
+ contract_name?: string;
147
+ /**
148
+ * The unique identifier of the contract.
149
+ * example:
150
+ * 12345
151
+ */
152
+ contract_number?: string;
153
+ /**
154
+ * The status of the contract.
155
+ * example:
156
+ * approved
157
+ */
158
+ status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
159
+ /**
160
+ * A brief description of the contract.
161
+ * example:
162
+ * This contract is for the supply of widgets.
163
+ */
164
+ description?: string;
165
+ /**
166
+ * The account number associated with the contract.
167
+ * example:
168
+ * 67890
169
+ */
170
+ account_number?: string;
171
+ /**
172
+ * The branch associated with the contract.
173
+ * example:
174
+ * power
175
+ */
176
+ branch?: "power" | "gas" | "water" | "waste_water" | "district_heating";
177
+ /**
178
+ * The billing address associated with the contract.
179
+ * example:
180
+ * 123 Main St, Anytown
181
+ */
182
+ billing_address?: string;
183
+ /**
184
+ * The delivery address associated with the contract.
185
+ * example:
186
+ * 456 Elm St, Anytown
187
+ */
188
+ delivery_address?: string;
189
+ /**
190
+ * Any additional addresses associated with the contract.
191
+ * example:
192
+ * 789 Oak St, Anytown
193
+ */
194
+ additional_addresses?: string;
195
+ /**
196
+ * The date on which the contract was terminated.
197
+ * example:
198
+ * 2022-01-01
199
+ */
200
+ termination_date?: string;
201
+ /**
202
+ * The reason for the termination of the contract.
203
+ * example:
204
+ * Non-payment
205
+ */
206
+ termination_reason?: string;
207
+ /**
208
+ * The billing period associated with the contract.
209
+ * example:
210
+ * monthly
211
+ */
212
+ billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
213
+ /**
214
+ * The duration of the billing period.
215
+ * example:
216
+ * 30
217
+ */
218
+ billing_duration_amount?: number;
219
+ /**
220
+ * The duration of the renewal period.
221
+ * example:
222
+ * 365
223
+ */
224
+ renewal_duration_amount?: number;
225
+ /**
226
+ * The unit of time for the renewal period.
227
+ * example:
228
+ * years
229
+ */
230
+ renewal_duration_unit?: "weeks" | "months" | "years";
231
+ /**
232
+ * The amount of notice required for termination of the contract.
233
+ * example:
234
+ * 30
235
+ */
236
+ notice_time_amount?: number;
237
+ /**
238
+ * The unit of time for the notice period.
239
+ * example:
240
+ * months
241
+ */
242
+ notice_time_unit?: "weeks" | "months" | "years";
243
+ /**
244
+ * The start date of the contract.
245
+ * example:
246
+ * 2021-01-01
247
+ */
248
+ start_date?: string;
249
+ /**
250
+ * Defines the day of the month in which the installments are due.
251
+ * example:
252
+ * 2
253
+ */
254
+ billing_due_day?: number;
255
+ /**
256
+ * Set amount for installments in cents. (precision 2)
257
+ * example:
258
+ * 10050
259
+ */
260
+ installment_amount?: number;
261
+ /**
262
+ * Current balance of the contract in cents. (precision 2)
263
+ * example:
264
+ * 8990
265
+ */
266
+ balance?: number;
267
+ balance_currency?: /**
268
+ * Currency code in ISO 4217 format
269
+ * example:
270
+ * EUR
271
+ */
272
+ Currency;
273
+ }
274
+ export interface ContractItem {
275
+ [name: string]: any;
276
+ _id: /**
277
+ * Entity ID
278
+ * example:
279
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
280
+ */
281
+ EntityId;
282
+ /**
283
+ * Title of entity
284
+ */
285
+ _title: string;
286
+ /**
287
+ * Organization Id the entity belongs to
288
+ */
289
+ _org: string;
290
+ _schema?: /**
291
+ * URL-friendly identifier for the entity schema
292
+ * example:
293
+ * contact
294
+ */
295
+ EntitySlug;
296
+ _tags?: string[];
297
+ _created_at: string;
298
+ _updated_at: string;
299
+ /**
300
+ * The name of the contract.
301
+ * example:
302
+ * Grid Contract
303
+ */
304
+ contract_name?: string;
305
+ /**
306
+ * The unique identifier of the contract.
307
+ * example:
308
+ * 12345
309
+ */
310
+ contract_number?: string;
311
+ /**
312
+ * The status of the contract.
313
+ * example:
314
+ * approved
315
+ */
316
+ status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
317
+ /**
318
+ * A brief description of the contract.
319
+ * example:
320
+ * This contract is for the supply of widgets.
321
+ */
322
+ description?: string;
323
+ /**
324
+ * The account number associated with the contract.
325
+ * example:
326
+ * 67890
327
+ */
328
+ account_number?: string;
329
+ /**
330
+ * The branch associated with the contract.
331
+ * example:
332
+ * power
333
+ */
334
+ branch?: "power" | "gas" | "water" | "waste_water" | "district_heating";
335
+ /**
336
+ * The billing address associated with the contract.
337
+ * example:
338
+ * 123 Main St, Anytown
339
+ */
340
+ billing_address?: string;
341
+ /**
342
+ * The delivery address associated with the contract.
343
+ * example:
344
+ * 456 Elm St, Anytown
345
+ */
346
+ delivery_address?: string;
347
+ /**
348
+ * Any additional addresses associated with the contract.
349
+ * example:
350
+ * 789 Oak St, Anytown
351
+ */
352
+ additional_addresses?: string;
353
+ /**
354
+ * The date on which the contract was terminated.
355
+ * example:
356
+ * 2022-01-01
357
+ */
358
+ termination_date?: string;
359
+ /**
360
+ * The reason for the termination of the contract.
361
+ * example:
362
+ * Non-payment
363
+ */
364
+ termination_reason?: string;
365
+ /**
366
+ * The billing period associated with the contract.
367
+ * example:
368
+ * monthly
369
+ */
370
+ billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
371
+ /**
372
+ * The duration of the billing period.
373
+ * example:
374
+ * 30
375
+ */
376
+ billing_duration_amount?: number;
377
+ /**
378
+ * The duration of the renewal period.
379
+ * example:
380
+ * 365
381
+ */
382
+ renewal_duration_amount?: number;
383
+ /**
384
+ * The unit of time for the renewal period.
385
+ * example:
386
+ * years
387
+ */
388
+ renewal_duration_unit?: "weeks" | "months" | "years";
389
+ /**
390
+ * The amount of notice required for termination of the contract.
391
+ * example:
392
+ * 30
393
+ */
394
+ notice_time_amount?: number;
395
+ /**
396
+ * The unit of time for the notice period.
397
+ * example:
398
+ * months
399
+ */
400
+ notice_time_unit?: "weeks" | "months" | "years";
401
+ /**
402
+ * The start date of the contract.
403
+ * example:
404
+ * 2021-01-01
405
+ */
406
+ start_date?: string;
407
+ /**
408
+ * Defines the day of the month in which the installments are due.
409
+ * example:
410
+ * 2
411
+ */
412
+ billing_due_day?: number;
413
+ /**
414
+ * Set amount for installments in cents. (precision 2)
415
+ * example:
416
+ * 10050
417
+ */
418
+ installment_amount?: number;
419
+ /**
420
+ * Current balance of the contract in cents. (precision 2)
421
+ * example:
422
+ * 8990
423
+ */
424
+ balance?: number;
425
+ balance_currency?: /**
426
+ * Currency code in ISO 4217 format
427
+ * example:
428
+ * EUR
429
+ */
430
+ Currency;
431
+ }
432
+ /**
433
+ * Currency code in ISO 4217 format
434
+ * example:
435
+ * EUR
436
+ */
437
+ export type Currency = string;
438
+ /**
439
+ * Entity ID
440
+ * example:
441
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
442
+ */
443
+ export type EntityId = string;
444
+ export interface EntityRelationItem {
445
+ /**
446
+ * Entity ID for the related contract.
447
+ * example:
448
+ * f589786b-3024-43cd-9cb3-5a3c953f2896
449
+ */
450
+ entity_id?: string;
451
+ }
452
+ /**
453
+ * URL-friendly identifier for the entity schema
454
+ * example:
455
+ * contact
456
+ */
457
+ export type EntitySlug = "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event";
458
+ /**
459
+ * An entity that describes an installment billing event.
460
+ */
461
+ export interface InstallmentEvent {
462
+ [name: string]: any;
463
+ _id?: /**
464
+ * Entity ID
465
+ * example:
466
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
467
+ */
468
+ EntityId;
469
+ /**
470
+ * Title of entity
471
+ */
472
+ _title?: string;
473
+ /**
474
+ * Organization Id the entity belongs to
475
+ */
476
+ _org?: string;
477
+ _schema?: /**
478
+ * URL-friendly identifier for the entity schema
479
+ * example:
480
+ * contact
481
+ */
482
+ EntitySlug;
483
+ _tags?: string[];
484
+ _created_at?: string;
485
+ _updated_at?: string;
486
+ /**
487
+ * Amount to be paid in cents i.e. precision 2
488
+ * example:
489
+ * 10050
490
+ */
491
+ billing_amount: number;
492
+ /**
493
+ * Amount to be paid in cents in decimal string representation
494
+ * example:
495
+ * 100.50
496
+ */
497
+ billing_amount_decimal: string;
498
+ billing_currency: /**
499
+ * Currency code in ISO 4217 format
500
+ * example:
501
+ * EUR
502
+ */
503
+ Currency;
504
+ /**
505
+ * Unique identifier for event, used to reference the event to a 3rd party resource such as a SAP Installment.
506
+ * example:
507
+ * d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e
508
+ */
509
+ external_id?: string;
510
+ contract: {
511
+ $relation?: EntityRelationItem[];
512
+ };
513
+ /**
514
+ * Type of the billing event.
515
+ * example:
516
+ * installment
517
+ */
518
+ type: "installment";
519
+ /**
520
+ * Date on which the installment is due.
521
+ */
522
+ due_date: string; // date-time
523
+ /**
524
+ * Date on which the installment is paid by the customer.
525
+ */
526
+ paid_date?: string; // date-time
527
+ }
528
+ /**
529
+ * An entity that describes a reimbursement billing event.
530
+ */
531
+ export interface ReimbursementEvent {
532
+ [name: string]: any;
533
+ _id?: /**
534
+ * Entity ID
535
+ * example:
536
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
537
+ */
538
+ EntityId;
539
+ /**
540
+ * Title of entity
541
+ */
542
+ _title?: string;
543
+ /**
544
+ * Organization Id the entity belongs to
545
+ */
546
+ _org?: string;
547
+ _schema?: /**
548
+ * URL-friendly identifier for the entity schema
549
+ * example:
550
+ * contact
551
+ */
552
+ EntitySlug;
553
+ _tags?: string[];
554
+ _created_at?: string;
555
+ _updated_at?: string;
556
+ /**
557
+ * Amount to be paid in cents i.e. precision 2
558
+ * example:
559
+ * 10050
560
+ */
561
+ billing_amount: number;
562
+ /**
563
+ * Amount to be paid in cents in decimal string representation
564
+ * example:
565
+ * 100.50
566
+ */
567
+ billing_amount_decimal: string;
568
+ billing_currency: /**
569
+ * Currency code in ISO 4217 format
570
+ * example:
571
+ * EUR
572
+ */
573
+ Currency;
574
+ /**
575
+ * Unique identifier for event, used to reference the event to a 3rd party resource such as a SAP Installment.
576
+ * example:
577
+ * d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e
578
+ */
579
+ external_id?: string;
580
+ contract: {
581
+ $relation?: EntityRelationItem[];
582
+ };
583
+ /**
584
+ * Type of the billing event.
585
+ * example:
586
+ * reimbursement
587
+ */
588
+ type: "reimbursement";
589
+ /**
590
+ * Date on which the customer is reimbursed.
591
+ */
592
+ paid_date?: string; // date-time
593
+ }
594
+ }
595
+ }
596
+ declare namespace Paths {
597
+ namespace CreateBillingEvent {
598
+ /**
599
+ * An entity that describes a billing event such as a future installment or a reimbursement back to the customer.
600
+ */
601
+ export type RequestBody = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ /* An entity that describes an installment billing event. */ Components.Schemas.InstallmentEvent | /* An entity that describes a reimbursement billing event. */ Components.Schemas.ReimbursementEvent;
602
+ namespace Responses {
603
+ /**
604
+ * An entity that describes a billing event such as a future installment or a reimbursement back to the customer.
605
+ */
606
+ export type $201 = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ /* An entity that describes an installment billing event. */ Components.Schemas.InstallmentEvent | /* An entity that describes a reimbursement billing event. */ Components.Schemas.ReimbursementEvent;
607
+ }
608
+ }
609
+ namespace CreateContractEntity {
610
+ export type RequestBody = Components.Schemas.Contract;
611
+ namespace Responses {
612
+ export type $201 = Components.Schemas.ContractItem;
613
+ }
614
+ }
615
+ namespace DeleteBillingEvent {
616
+ namespace Parameters {
617
+ export type Id = string;
618
+ }
619
+ export interface PathParameters {
620
+ id: Parameters.Id;
621
+ }
622
+ namespace Responses {
623
+ export interface $204 {
624
+ }
625
+ }
626
+ }
627
+ namespace DeleteContractEntity {
628
+ namespace Parameters {
629
+ export type Id = string;
630
+ }
631
+ export interface PathParameters {
632
+ id: Parameters.Id;
633
+ }
634
+ namespace Responses {
635
+ export type $204 = Components.Schemas.ContractItem;
636
+ }
637
+ }
638
+ namespace GetBillingEvent {
639
+ namespace Parameters {
640
+ export type Id = string;
641
+ }
642
+ export interface PathParameters {
643
+ id: Parameters.Id;
644
+ }
645
+ namespace Responses {
646
+ export type $200 = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent;
647
+ }
648
+ }
649
+ namespace GetBillingEventByExternalId {
650
+ namespace Parameters {
651
+ export type ExternalId = string;
652
+ }
653
+ export interface PathParameters {
654
+ external_id: Parameters.ExternalId;
655
+ }
656
+ namespace Responses {
657
+ export type $200 = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent;
658
+ }
659
+ }
660
+ namespace GetBillingEvents {
661
+ namespace Parameters {
662
+ /**
663
+ * List billing events after this date
664
+ */
665
+ export type DateAfter = string; // date-time
666
+ /**
667
+ * List billing events before this date
668
+ */
669
+ export type DateBefore = string; // date-time
670
+ export type EntityId = string[];
671
+ /**
672
+ * Type of billing event to filter by
673
+ */
674
+ export type EventType = "installment" | "reimbursement";
675
+ /**
676
+ * Initial offset to set for the search results
677
+ * example:
678
+ * 0
679
+ */
680
+ export type From = number;
681
+ /**
682
+ * Size of the search results
683
+ * example:
684
+ * 100
685
+ */
686
+ export type Size = number;
687
+ }
688
+ export interface QueryParameters {
689
+ from?: /**
690
+ * Initial offset to set for the search results
691
+ * example:
692
+ * 0
693
+ */
694
+ Parameters.From;
695
+ size?: /**
696
+ * Size of the search results
697
+ * example:
698
+ * 100
699
+ */
700
+ Parameters.Size;
701
+ entity_id?: Parameters.EntityId;
702
+ event_type?: /* Type of billing event to filter by */ Parameters.EventType;
703
+ date_after?: /* List billing events after this date */ Parameters.DateAfter /* date-time */;
704
+ date_before?: /* List billing events before this date */ Parameters.DateBefore /* date-time */;
705
+ }
706
+ namespace Responses {
707
+ export interface $200 {
708
+ hits?: number;
709
+ results?: /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent[];
710
+ }
711
+ }
712
+ }
713
+ namespace GetCustomerBalance {
714
+ namespace Parameters {
715
+ /**
716
+ * example:
717
+ * 1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e
718
+ */
719
+ export type Id = string;
720
+ }
721
+ export interface PathParameters {
722
+ id: /**
723
+ * example:
724
+ * 1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e
725
+ */
726
+ Parameters.Id;
727
+ }
728
+ namespace Responses {
729
+ export type $200 = Components.Schemas.Balance;
730
+ }
731
+ }
732
+ namespace UpdateBillingEvent {
733
+ namespace Parameters {
734
+ export type Id = string;
735
+ }
736
+ export interface PathParameters {
737
+ id: Parameters.Id;
738
+ }
739
+ export type RequestBody = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent;
740
+ namespace Responses {
741
+ export type $200 = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent;
742
+ }
743
+ }
744
+ namespace UpdateContractEntity {
745
+ namespace Parameters {
746
+ export type Id = string;
747
+ }
748
+ export interface PathParameters {
749
+ id: Parameters.Id;
750
+ }
751
+ export type RequestBody = Components.Schemas.Contract;
752
+ namespace Responses {
753
+ export type $200 = Components.Schemas.ContractItem;
754
+ }
755
+ }
756
+ }
757
+
758
+
759
+ interface OperationMethods {
760
+ /**
761
+ * getBillingEvents - getBillingEvents
762
+ *
763
+ * Get and filter billing events such as installments and reimbursements.
764
+ */
765
+ 'getBillingEvents'(
766
+ parameters?: Parameters<Paths.GetBillingEvents.QueryParameters> | null,
767
+ data?: any,
768
+ config?: AxiosRequestConfig
769
+ ): OperationResponse<Paths.GetBillingEvents.Responses.$200>
770
+ /**
771
+ * createBillingEvent - createBillingEvent
772
+ *
773
+ * Create a new billing event.
774
+ */
775
+ 'createBillingEvent'(
776
+ parameters?: Parameters<UnknownParamsObject> | null,
777
+ data?: Paths.CreateBillingEvent.RequestBody,
778
+ config?: AxiosRequestConfig
779
+ ): OperationResponse<Paths.CreateBillingEvent.Responses.$201>
780
+ /**
781
+ * getBillingEvent - getBillingEvent
782
+ *
783
+ * Get a single billing event by ID.
784
+ */
785
+ 'getBillingEvent'(
786
+ parameters?: Parameters<Paths.GetBillingEvent.PathParameters> | null,
787
+ data?: any,
788
+ config?: AxiosRequestConfig
789
+ ): OperationResponse<Paths.GetBillingEvent.Responses.$200>
790
+ /**
791
+ * updateBillingEvent - updateBillingEvent
792
+ *
793
+ * Update an existing billing event.
794
+ */
795
+ 'updateBillingEvent'(
796
+ parameters?: Parameters<Paths.UpdateBillingEvent.PathParameters> | null,
797
+ data?: Paths.UpdateBillingEvent.RequestBody,
798
+ config?: AxiosRequestConfig
799
+ ): OperationResponse<Paths.UpdateBillingEvent.Responses.$200>
800
+ /**
801
+ * deleteBillingEvent - deleteBillingEvent
802
+ *
803
+ * Delete an existing billing event.
804
+ */
805
+ 'deleteBillingEvent'(
806
+ parameters?: Parameters<Paths.DeleteBillingEvent.PathParameters> | null,
807
+ data?: any,
808
+ config?: AxiosRequestConfig
809
+ ): OperationResponse<Paths.DeleteBillingEvent.Responses.$204>
810
+ /**
811
+ * getBillingEventByExternalId - getBillingEventByExternalId
812
+ *
813
+ * Get a single billing event by External ID.
814
+ */
815
+ 'getBillingEventByExternalId'(
816
+ parameters?: Parameters<Paths.GetBillingEventByExternalId.PathParameters> | null,
817
+ data?: any,
818
+ config?: AxiosRequestConfig
819
+ ): OperationResponse<Paths.GetBillingEventByExternalId.Responses.$200>
820
+ /**
821
+ * createContractEntity - createContractEntity
822
+ *
823
+ * Create a new contract entity.
824
+ */
825
+ 'createContractEntity'(
826
+ parameters?: Parameters<UnknownParamsObject> | null,
827
+ data?: Paths.CreateContractEntity.RequestBody,
828
+ config?: AxiosRequestConfig
829
+ ): OperationResponse<Paths.CreateContractEntity.Responses.$201>
830
+ /**
831
+ * updateContractEntity - updateContractEntity
832
+ *
833
+ * Update an existing contract entity.
834
+ */
835
+ 'updateContractEntity'(
836
+ parameters?: Parameters<Paths.UpdateContractEntity.PathParameters> | null,
837
+ data?: Paths.UpdateContractEntity.RequestBody,
838
+ config?: AxiosRequestConfig
839
+ ): OperationResponse<Paths.UpdateContractEntity.Responses.$200>
840
+ /**
841
+ * deleteContractEntity - deleteContractEntity
842
+ *
843
+ * Delete an existing contract entity.
844
+ */
845
+ 'deleteContractEntity'(
846
+ parameters?: Parameters<Paths.DeleteContractEntity.PathParameters> | null,
847
+ data?: any,
848
+ config?: AxiosRequestConfig
849
+ ): OperationResponse<Paths.DeleteContractEntity.Responses.$204>
850
+ /**
851
+ * getCustomerBalance - getCustomerBalance
852
+ *
853
+ * Get total balance across all contracts and orders of a customer entity.
854
+ */
855
+ 'getCustomerBalance'(
856
+ parameters?: Parameters<Paths.GetCustomerBalance.PathParameters> | null,
857
+ data?: any,
858
+ config?: AxiosRequestConfig
859
+ ): OperationResponse<Paths.GetCustomerBalance.Responses.$200>
860
+ }
861
+
862
+ interface PathsDictionary {
863
+ ['/v1/billing/events']: {
864
+ /**
865
+ * getBillingEvents - getBillingEvents
866
+ *
867
+ * Get and filter billing events such as installments and reimbursements.
868
+ */
869
+ 'get'(
870
+ parameters?: Parameters<Paths.GetBillingEvents.QueryParameters> | null,
871
+ data?: any,
872
+ config?: AxiosRequestConfig
873
+ ): OperationResponse<Paths.GetBillingEvents.Responses.$200>
874
+ /**
875
+ * createBillingEvent - createBillingEvent
876
+ *
877
+ * Create a new billing event.
878
+ */
879
+ 'post'(
880
+ parameters?: Parameters<UnknownParamsObject> | null,
881
+ data?: Paths.CreateBillingEvent.RequestBody,
882
+ config?: AxiosRequestConfig
883
+ ): OperationResponse<Paths.CreateBillingEvent.Responses.$201>
884
+ }
885
+ ['/v1/billing/events/{id}']: {
886
+ /**
887
+ * getBillingEvent - getBillingEvent
888
+ *
889
+ * Get a single billing event by ID.
890
+ */
891
+ 'get'(
892
+ parameters?: Parameters<Paths.GetBillingEvent.PathParameters> | null,
893
+ data?: any,
894
+ config?: AxiosRequestConfig
895
+ ): OperationResponse<Paths.GetBillingEvent.Responses.$200>
896
+ /**
897
+ * updateBillingEvent - updateBillingEvent
898
+ *
899
+ * Update an existing billing event.
900
+ */
901
+ 'patch'(
902
+ parameters?: Parameters<Paths.UpdateBillingEvent.PathParameters> | null,
903
+ data?: Paths.UpdateBillingEvent.RequestBody,
904
+ config?: AxiosRequestConfig
905
+ ): OperationResponse<Paths.UpdateBillingEvent.Responses.$200>
906
+ /**
907
+ * deleteBillingEvent - deleteBillingEvent
908
+ *
909
+ * Delete an existing billing event.
910
+ */
911
+ 'delete'(
912
+ parameters?: Parameters<Paths.DeleteBillingEvent.PathParameters> | null,
913
+ data?: any,
914
+ config?: AxiosRequestConfig
915
+ ): OperationResponse<Paths.DeleteBillingEvent.Responses.$204>
916
+ }
917
+ ['/v1/billing/external/{external_id}']: {
918
+ /**
919
+ * getBillingEventByExternalId - getBillingEventByExternalId
920
+ *
921
+ * Get a single billing event by External ID.
922
+ */
923
+ 'get'(
924
+ parameters?: Parameters<Paths.GetBillingEventByExternalId.PathParameters> | null,
925
+ data?: any,
926
+ config?: AxiosRequestConfig
927
+ ): OperationResponse<Paths.GetBillingEventByExternalId.Responses.$200>
928
+ }
929
+ ['/v1/billing/contracts']: {
930
+ /**
931
+ * createContractEntity - createContractEntity
932
+ *
933
+ * Create a new contract entity.
934
+ */
935
+ 'post'(
936
+ parameters?: Parameters<UnknownParamsObject> | null,
937
+ data?: Paths.CreateContractEntity.RequestBody,
938
+ config?: AxiosRequestConfig
939
+ ): OperationResponse<Paths.CreateContractEntity.Responses.$201>
940
+ }
941
+ ['/v1/billing/contracts/{id}']: {
942
+ /**
943
+ * updateContractEntity - updateContractEntity
944
+ *
945
+ * Update an existing contract entity.
946
+ */
947
+ 'patch'(
948
+ parameters?: Parameters<Paths.UpdateContractEntity.PathParameters> | null,
949
+ data?: Paths.UpdateContractEntity.RequestBody,
950
+ config?: AxiosRequestConfig
951
+ ): OperationResponse<Paths.UpdateContractEntity.Responses.$200>
952
+ /**
953
+ * deleteContractEntity - deleteContractEntity
954
+ *
955
+ * Delete an existing contract entity.
956
+ */
957
+ 'delete'(
958
+ parameters?: Parameters<Paths.DeleteContractEntity.PathParameters> | null,
959
+ data?: any,
960
+ config?: AxiosRequestConfig
961
+ ): OperationResponse<Paths.DeleteContractEntity.Responses.$204>
962
+ }
963
+ ['/v1/billing/customers/{id}/balance']: {
964
+ /**
965
+ * getCustomerBalance - getCustomerBalance
966
+ *
967
+ * Get total balance across all contracts and orders of a customer entity.
968
+ */
969
+ 'get'(
970
+ parameters?: Parameters<Paths.GetCustomerBalance.PathParameters> | null,
971
+ data?: any,
972
+ config?: AxiosRequestConfig
973
+ ): OperationResponse<Paths.GetCustomerBalance.Responses.$200>
974
+ }
975
+ }
976
+
977
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
978
+
979
+
980
+ type Balance = Components.Schemas.Balance;
981
+ type BaseBillingEvent = Components.Schemas.BaseBillingEvent;
982
+ type BaseEntity = Components.Schemas.BaseEntity;
983
+ type BillingEvent = Components.Schemas.BillingEvent;
984
+ type Contract = Components.Schemas.Contract;
985
+ type ContractItem = Components.Schemas.ContractItem;
986
+ type Currency = Components.Schemas.Currency;
987
+ type EntityId = Components.Schemas.EntityId;
988
+ type EntityRelationItem = Components.Schemas.EntityRelationItem;
989
+ type EntitySlug = Components.Schemas.EntitySlug;
990
+ type InstallmentEvent = Components.Schemas.InstallmentEvent;
991
+ type ReimbursementEvent = Components.Schemas.ReimbursementEvent;
992
+
993
+ export { type Balance as B, type Client as C, type EntityId as E, type InstallmentEvent as I, type OperationMethods as O, Paths as P, type ReimbursementEvent as R, Components as a, type PathsDictionary as b, type BaseBillingEvent as c, type BaseEntity as d, type BillingEvent as e, type Contract as f, type ContractItem as g, type Currency as h, type EntityRelationItem as i, type EntitySlug as j };