@revenexx/sdk 0.0.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 (182) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +148 -0
  3. package/dist/cjs/package.json +3 -0
  4. package/dist/cjs/sdk.js +16340 -0
  5. package/dist/cjs/sdk.js.map +1 -0
  6. package/dist/esm/package.json +3 -0
  7. package/dist/esm/sdk.js +16250 -0
  8. package/dist/esm/sdk.js.map +1 -0
  9. package/dist/iife/sdk.js +20101 -0
  10. package/package.json +56 -0
  11. package/src/channel.ts +158 -0
  12. package/src/client.ts +950 -0
  13. package/src/enums/adapter.ts +4 -0
  14. package/src/enums/attribute-boolean-status.ts +7 -0
  15. package/src/enums/attribute-datetime-status.ts +7 -0
  16. package/src/enums/attribute-email-status.ts +7 -0
  17. package/src/enums/attribute-enum-status.ts +7 -0
  18. package/src/enums/attribute-float-status.ts +7 -0
  19. package/src/enums/attribute-integer-status.ts +7 -0
  20. package/src/enums/attribute-ip-status.ts +7 -0
  21. package/src/enums/attribute-line-status.ts +7 -0
  22. package/src/enums/attribute-longtext-status.ts +7 -0
  23. package/src/enums/attribute-mediumtext-status.ts +7 -0
  24. package/src/enums/attribute-point-status.ts +7 -0
  25. package/src/enums/attribute-polygon-status.ts +7 -0
  26. package/src/enums/attribute-relationship-status.ts +7 -0
  27. package/src/enums/attribute-string-status.ts +7 -0
  28. package/src/enums/attribute-text-status.ts +7 -0
  29. package/src/enums/attribute-url-status.ts +7 -0
  30. package/src/enums/attribute-varchar-status.ts +7 -0
  31. package/src/enums/build-runtime.ts +73 -0
  32. package/src/enums/code.ts +16 -0
  33. package/src/enums/collection.ts +4 -0
  34. package/src/enums/column-boolean-status.ts +7 -0
  35. package/src/enums/column-datetime-status.ts +7 -0
  36. package/src/enums/column-email-status.ts +7 -0
  37. package/src/enums/column-enum-status.ts +7 -0
  38. package/src/enums/column-float-status.ts +7 -0
  39. package/src/enums/column-integer-status.ts +7 -0
  40. package/src/enums/column-ip-status.ts +7 -0
  41. package/src/enums/column-line-status.ts +7 -0
  42. package/src/enums/column-longtext-status.ts +7 -0
  43. package/src/enums/column-mediumtext-status.ts +7 -0
  44. package/src/enums/column-point-status.ts +7 -0
  45. package/src/enums/column-polygon-status.ts +7 -0
  46. package/src/enums/column-relationship-status.ts +7 -0
  47. package/src/enums/column-string-status.ts +7 -0
  48. package/src/enums/column-text-status.ts +7 -0
  49. package/src/enums/column-url-status.ts +7 -0
  50. package/src/enums/column-varchar-status.ts +7 -0
  51. package/src/enums/compression.ts +5 -0
  52. package/src/enums/database-type.ts +4 -0
  53. package/src/enums/deployment-status.ts +8 -0
  54. package/src/enums/execution-status.ts +7 -0
  55. package/src/enums/execution-trigger.ts +5 -0
  56. package/src/enums/framework.ts +17 -0
  57. package/src/enums/gravity.ts +11 -0
  58. package/src/enums/health-antivirus-status.ts +5 -0
  59. package/src/enums/health-status-status.ts +4 -0
  60. package/src/enums/index-status.ts +7 -0
  61. package/src/enums/message-status.ts +7 -0
  62. package/src/enums/method.ts +9 -0
  63. package/src/enums/output.ts +9 -0
  64. package/src/enums/permissions.ts +22 -0
  65. package/src/enums/priority.ts +4 -0
  66. package/src/enums/range.ts +5 -0
  67. package/src/enums/runtime.ts +73 -0
  68. package/src/enums/runtimes.ts +73 -0
  69. package/src/enums/scopes.ts +57 -0
  70. package/src/enums/theme.ts +4 -0
  71. package/src/enums/timezone.ts +421 -0
  72. package/src/enums/type.ts +5 -0
  73. package/src/enums/use-cases.ts +9 -0
  74. package/src/id.ts +47 -0
  75. package/src/index.ts +92 -0
  76. package/src/models.ts +6013 -0
  77. package/src/operator.ts +308 -0
  78. package/src/permission.ts +57 -0
  79. package/src/query.ts +576 -0
  80. package/src/role.ts +100 -0
  81. package/src/service.ts +30 -0
  82. package/src/services/apps.ts +2473 -0
  83. package/src/services/avatars.ts +744 -0
  84. package/src/services/carts.ts +1057 -0
  85. package/src/services/channels.ts +227 -0
  86. package/src/services/customers.ts +729 -0
  87. package/src/services/greetings.ts +294 -0
  88. package/src/services/locale.ts +198 -0
  89. package/src/services/markets.ts +796 -0
  90. package/src/services/messaging.ts +3463 -0
  91. package/src/services/products.ts +3100 -0
  92. package/src/services/realtime.ts +537 -0
  93. package/src/services/search.ts +346 -0
  94. package/src/services/sites.ts +1847 -0
  95. package/src/services/storage.ts +1076 -0
  96. package/src/services/tokens.ts +314 -0
  97. package/types/channel.d.ts +74 -0
  98. package/types/client.d.ts +211 -0
  99. package/types/enums/adapter.d.ts +4 -0
  100. package/types/enums/attribute-boolean-status.d.ts +7 -0
  101. package/types/enums/attribute-datetime-status.d.ts +7 -0
  102. package/types/enums/attribute-email-status.d.ts +7 -0
  103. package/types/enums/attribute-enum-status.d.ts +7 -0
  104. package/types/enums/attribute-float-status.d.ts +7 -0
  105. package/types/enums/attribute-integer-status.d.ts +7 -0
  106. package/types/enums/attribute-ip-status.d.ts +7 -0
  107. package/types/enums/attribute-line-status.d.ts +7 -0
  108. package/types/enums/attribute-longtext-status.d.ts +7 -0
  109. package/types/enums/attribute-mediumtext-status.d.ts +7 -0
  110. package/types/enums/attribute-point-status.d.ts +7 -0
  111. package/types/enums/attribute-polygon-status.d.ts +7 -0
  112. package/types/enums/attribute-relationship-status.d.ts +7 -0
  113. package/types/enums/attribute-string-status.d.ts +7 -0
  114. package/types/enums/attribute-text-status.d.ts +7 -0
  115. package/types/enums/attribute-url-status.d.ts +7 -0
  116. package/types/enums/attribute-varchar-status.d.ts +7 -0
  117. package/types/enums/build-runtime.d.ts +73 -0
  118. package/types/enums/code.d.ts +16 -0
  119. package/types/enums/collection.d.ts +4 -0
  120. package/types/enums/column-boolean-status.d.ts +7 -0
  121. package/types/enums/column-datetime-status.d.ts +7 -0
  122. package/types/enums/column-email-status.d.ts +7 -0
  123. package/types/enums/column-enum-status.d.ts +7 -0
  124. package/types/enums/column-float-status.d.ts +7 -0
  125. package/types/enums/column-integer-status.d.ts +7 -0
  126. package/types/enums/column-ip-status.d.ts +7 -0
  127. package/types/enums/column-line-status.d.ts +7 -0
  128. package/types/enums/column-longtext-status.d.ts +7 -0
  129. package/types/enums/column-mediumtext-status.d.ts +7 -0
  130. package/types/enums/column-point-status.d.ts +7 -0
  131. package/types/enums/column-polygon-status.d.ts +7 -0
  132. package/types/enums/column-relationship-status.d.ts +7 -0
  133. package/types/enums/column-string-status.d.ts +7 -0
  134. package/types/enums/column-text-status.d.ts +7 -0
  135. package/types/enums/column-url-status.d.ts +7 -0
  136. package/types/enums/column-varchar-status.d.ts +7 -0
  137. package/types/enums/compression.d.ts +5 -0
  138. package/types/enums/database-type.d.ts +4 -0
  139. package/types/enums/deployment-status.d.ts +8 -0
  140. package/types/enums/execution-status.d.ts +7 -0
  141. package/types/enums/execution-trigger.d.ts +5 -0
  142. package/types/enums/framework.d.ts +17 -0
  143. package/types/enums/gravity.d.ts +11 -0
  144. package/types/enums/health-antivirus-status.d.ts +5 -0
  145. package/types/enums/health-status-status.d.ts +4 -0
  146. package/types/enums/index-status.d.ts +7 -0
  147. package/types/enums/message-status.d.ts +7 -0
  148. package/types/enums/method.d.ts +9 -0
  149. package/types/enums/output.d.ts +9 -0
  150. package/types/enums/permissions.d.ts +22 -0
  151. package/types/enums/priority.d.ts +4 -0
  152. package/types/enums/range.d.ts +5 -0
  153. package/types/enums/runtime.d.ts +73 -0
  154. package/types/enums/runtimes.d.ts +73 -0
  155. package/types/enums/scopes.d.ts +57 -0
  156. package/types/enums/theme.d.ts +4 -0
  157. package/types/enums/timezone.d.ts +421 -0
  158. package/types/enums/type.d.ts +5 -0
  159. package/types/enums/use-cases.d.ts +9 -0
  160. package/types/id.d.ts +20 -0
  161. package/types/index.d.ts +92 -0
  162. package/types/models.d.ts +5830 -0
  163. package/types/operator.d.ts +180 -0
  164. package/types/permission.d.ts +43 -0
  165. package/types/query.d.ts +442 -0
  166. package/types/role.d.ts +70 -0
  167. package/types/service.d.ts +11 -0
  168. package/types/services/apps.d.ts +932 -0
  169. package/types/services/avatars.d.ts +318 -0
  170. package/types/services/carts.d.ts +352 -0
  171. package/types/services/channels.d.ts +75 -0
  172. package/types/services/customers.d.ts +231 -0
  173. package/types/services/greetings.d.ts +101 -0
  174. package/types/services/locale.d.ts +64 -0
  175. package/types/services/markets.d.ts +274 -0
  176. package/types/services/messaging.d.ts +1324 -0
  177. package/types/services/products.d.ts +1014 -0
  178. package/types/services/realtime.d.ts +134 -0
  179. package/types/services/search.d.ts +131 -0
  180. package/types/services/sites.d.ts +689 -0
  181. package/types/services/storage.d.ts +421 -0
  182. package/types/services/tokens.d.ts +119 -0
@@ -0,0 +1,932 @@
1
+ import { Client, UploadProgress } from '../client';
2
+ import type { Models } from '../models';
3
+ import { Runtime } from '../enums/runtime';
4
+ import { Scopes } from '../enums/scopes';
5
+ import { Runtimes } from '../enums/runtimes';
6
+ import { UseCases } from '../enums/use-cases';
7
+ import { Range } from '../enums/range';
8
+ import { Type } from '../enums/type';
9
+ import { Method } from '../enums/method';
10
+ export declare class Apps {
11
+ client: Client;
12
+ constructor(client: Client);
13
+ /**
14
+ * List all Apps in the active project. Pass `search` to filter by name.
15
+ *
16
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
17
+ * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
18
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
19
+ * @throws {RevenexxException}
20
+ * @returns {Promise<Models.FunctionList>}
21
+ */
22
+ appsList(params?: {
23
+ queries?: string[];
24
+ search?: string;
25
+ total?: boolean;
26
+ }): Promise<Models.FunctionList>;
27
+ /**
28
+ * List all Apps in the active project. Pass `search` to filter by name.
29
+ *
30
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
31
+ * @param {string} search - Search term to filter your list results. Max length: 256 chars.
32
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
33
+ * @throws {RevenexxException}
34
+ * @returns {Promise<Models.FunctionList>}
35
+ * @deprecated Use the object parameter style method for a better developer experience.
36
+ */
37
+ appsList(queries?: string[], search?: string, total?: boolean): Promise<Models.FunctionList>;
38
+ /**
39
+ * Create a new revenexx App. An App is the deployment surface for code that runs on the platform — backend jobs, APIs, integrations. The created App owns subsequent deployments and executions.
40
+ *
41
+ * Phase 1 mirrors the underlying Functions runtime 1:1; future phases will add manifest validation, registry coupling and schema migrations.
42
+ *
43
+ * @param {string} params.functionId - Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
44
+ * @param {string} params.name - Function name. Max length: 128 chars.
45
+ * @param {Runtime} params.runtime - Execution runtime.
46
+ * @param {string} params.commands - Build Commands.
47
+ * @param {boolean} params.enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
48
+ * @param {string} params.entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
49
+ * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
50
+ * @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
51
+ * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
52
+ * @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
53
+ * @param {string} params.providerBranch - Production branch for the repo linked to the function.
54
+ * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the function.
55
+ * @param {string} params.providerRootDirectory - Path to function code in the linked repo.
56
+ * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
57
+ * @param {string} params.schedule - Schedule CRON syntax.
58
+ * @param {Scopes[]} params.scopes - List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
59
+ * @param {string} params.specification - Runtime specification for the function and builds.
60
+ * @param {number} params.timeout - Function maximum execution time in seconds.
61
+ * @throws {RevenexxException}
62
+ * @returns {Promise<Models.Function>}
63
+ */
64
+ appsCreate(params: {
65
+ functionId: string;
66
+ name: string;
67
+ runtime: Runtime;
68
+ commands?: string;
69
+ enabled?: boolean;
70
+ entrypoint?: string;
71
+ events?: string[];
72
+ execute?: string[];
73
+ installationId?: string;
74
+ logging?: boolean;
75
+ providerBranch?: string;
76
+ providerRepositoryId?: string;
77
+ providerRootDirectory?: string;
78
+ providerSilentMode?: boolean;
79
+ schedule?: string;
80
+ scopes?: Scopes[];
81
+ specification?: string;
82
+ timeout?: number;
83
+ }): Promise<Models.Function>;
84
+ /**
85
+ * Create a new revenexx App. An App is the deployment surface for code that runs on the platform — backend jobs, APIs, integrations. The created App owns subsequent deployments and executions.
86
+ *
87
+ * Phase 1 mirrors the underlying Functions runtime 1:1; future phases will add manifest validation, registry coupling and schema migrations.
88
+ *
89
+ * @param {string} functionId - Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
90
+ * @param {string} name - Function name. Max length: 128 chars.
91
+ * @param {Runtime} runtime - Execution runtime.
92
+ * @param {string} commands - Build Commands.
93
+ * @param {boolean} enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
94
+ * @param {string} entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
95
+ * @param {string[]} events - Events list. Maximum of 100 events are allowed.
96
+ * @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
97
+ * @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
98
+ * @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
99
+ * @param {string} providerBranch - Production branch for the repo linked to the function.
100
+ * @param {string} providerRepositoryId - Repository ID of the repo linked to the function.
101
+ * @param {string} providerRootDirectory - Path to function code in the linked repo.
102
+ * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
103
+ * @param {string} schedule - Schedule CRON syntax.
104
+ * @param {Scopes[]} scopes - List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
105
+ * @param {string} specification - Runtime specification for the function and builds.
106
+ * @param {number} timeout - Function maximum execution time in seconds.
107
+ * @throws {RevenexxException}
108
+ * @returns {Promise<Models.Function>}
109
+ * @deprecated Use the object parameter style method for a better developer experience.
110
+ */
111
+ appsCreate(functionId: string, name: string, runtime: Runtime, commands?: string, enabled?: boolean, entrypoint?: string, events?: string[], execute?: string[], installationId?: string, logging?: boolean, providerBranch?: string, providerRepositoryId?: string, providerRootDirectory?: string, providerSilentMode?: boolean, schedule?: string, scopes?: Scopes[], specification?: string, timeout?: number): Promise<Models.Function>;
112
+ /**
113
+ * List apps published to the Marketplace. Proxies the App Registry on Console with `?published=true` filter.
114
+ *
115
+ * @param {string} params.search - Search by app name, title or vendor.
116
+ * @param {number} params.perPage - Items per page.
117
+ * @param {number} params.page - Page number.
118
+ * @throws {RevenexxException}
119
+ * @returns {Promise<{}>}
120
+ */
121
+ appsListMarketplace(params?: {
122
+ search?: string;
123
+ perPage?: number;
124
+ page?: number;
125
+ }): Promise<{}>;
126
+ /**
127
+ * List apps published to the Marketplace. Proxies the App Registry on Console with `?published=true` filter.
128
+ *
129
+ * @param {string} search - Search by app name, title or vendor.
130
+ * @param {number} perPage - Items per page.
131
+ * @param {number} page - Page number.
132
+ * @throws {RevenexxException}
133
+ * @returns {Promise<{}>}
134
+ * @deprecated Use the object parameter style method for a better developer experience.
135
+ */
136
+ appsListMarketplace(search?: string, perPage?: number, page?: number): Promise<{}>;
137
+ /**
138
+ * Install a Marketplace app on the calling project's tenant. Body: { owner, name }.
139
+ *
140
+ * @param {string} params.name - App name.
141
+ * @param {string} params.owner - Owner tenant slug of the app being installed.
142
+ * @throws {RevenexxException}
143
+ * @returns {Promise<{}>}
144
+ */
145
+ appsInstallFromMarketplace(params: {
146
+ name: string;
147
+ owner: string;
148
+ }): Promise<{}>;
149
+ /**
150
+ * Install a Marketplace app on the calling project's tenant. Body: { owner, name }.
151
+ *
152
+ * @param {string} name - App name.
153
+ * @param {string} owner - Owner tenant slug of the app being installed.
154
+ * @throws {RevenexxException}
155
+ * @returns {Promise<{}>}
156
+ * @deprecated Use the object parameter style method for a better developer experience.
157
+ */
158
+ appsInstallFromMarketplace(name: string, owner: string): Promise<{}>;
159
+ /**
160
+ * Get a list of all runtimes available for an App. Identical content to `functions.listRuntimes()`.
161
+ *
162
+ * @throws {RevenexxException}
163
+ * @returns {Promise<Models.RuntimeList>}
164
+ */
165
+ appsListRuntimes(): Promise<Models.RuntimeList>;
166
+ /**
167
+ * List the compute specifications (CPU + memory) available to Apps in this project.
168
+ *
169
+ * @throws {RevenexxException}
170
+ * @returns {Promise<Models.SpecificationList>}
171
+ */
172
+ appsListSpecifications(): Promise<Models.SpecificationList>;
173
+ /**
174
+ * List the curated catalogue of App templates that can be used as starting points.
175
+ *
176
+ * @param {Runtimes[]} params.runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
177
+ * @param {UseCases[]} params.useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
178
+ * @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
179
+ * @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
180
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
181
+ * @throws {RevenexxException}
182
+ * @returns {Promise<Models.TemplateFunctionList>}
183
+ */
184
+ appsListTemplates(params?: {
185
+ runtimes?: Runtimes[];
186
+ useCases?: UseCases[];
187
+ limit?: number;
188
+ offset?: number;
189
+ total?: boolean;
190
+ }): Promise<Models.TemplateFunctionList>;
191
+ /**
192
+ * List the curated catalogue of App templates that can be used as starting points.
193
+ *
194
+ * @param {Runtimes[]} runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
195
+ * @param {UseCases[]} useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
196
+ * @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
197
+ * @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
198
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
199
+ * @throws {RevenexxException}
200
+ * @returns {Promise<Models.TemplateFunctionList>}
201
+ * @deprecated Use the object parameter style method for a better developer experience.
202
+ */
203
+ appsListTemplates(runtimes?: Runtimes[], useCases?: UseCases[], limit?: number, offset?: number, total?: boolean): Promise<Models.TemplateFunctionList>;
204
+ /**
205
+ * Get a single App template by its ID.
206
+ *
207
+ * @param {string} params.templateId - Template ID.
208
+ * @throws {RevenexxException}
209
+ * @returns {Promise<Models.TemplateFunction>}
210
+ */
211
+ appsGetTemplate(params: {
212
+ templateId: string;
213
+ }): Promise<Models.TemplateFunction>;
214
+ /**
215
+ * Get a single App template by its ID.
216
+ *
217
+ * @param {string} templateId - Template ID.
218
+ * @throws {RevenexxException}
219
+ * @returns {Promise<Models.TemplateFunction>}
220
+ * @deprecated Use the object parameter style method for a better developer experience.
221
+ */
222
+ appsGetTemplate(templateId: string): Promise<Models.TemplateFunction>;
223
+ /**
224
+ * Get aggregated usage stats across all Apps in the project for the requested time range.
225
+ *
226
+ * @param {Range} params.range - Date range.
227
+ * @throws {RevenexxException}
228
+ * @returns {Promise<Models.UsageFunctions>}
229
+ */
230
+ appsListUsage(params?: {
231
+ range?: Range;
232
+ }): Promise<Models.UsageFunctions>;
233
+ /**
234
+ * Get aggregated usage stats across all Apps in the project for the requested time range.
235
+ *
236
+ * @param {Range} range - Date range.
237
+ * @throws {RevenexxException}
238
+ * @returns {Promise<Models.UsageFunctions>}
239
+ * @deprecated Use the object parameter style method for a better developer experience.
240
+ */
241
+ appsListUsage(range?: Range): Promise<Models.UsageFunctions>;
242
+ /**
243
+ * Delete an App and all of its deployments. Cascades to the App Registry — Console removes the matching `RegisteredApp` row.
244
+ *
245
+ * @param {string} params.functionId - App ID.
246
+ * @throws {RevenexxException}
247
+ * @returns {Promise<{}>}
248
+ */
249
+ appsDelete(params: {
250
+ functionId: string;
251
+ }): Promise<{}>;
252
+ /**
253
+ * Delete an App and all of its deployments. Cascades to the App Registry — Console removes the matching `RegisteredApp` row.
254
+ *
255
+ * @param {string} functionId - App ID.
256
+ * @throws {RevenexxException}
257
+ * @returns {Promise<{}>}
258
+ * @deprecated Use the object parameter style method for a better developer experience.
259
+ */
260
+ appsDelete(functionId: string): Promise<{}>;
261
+ /**
262
+ * Get an App by its unique ID.
263
+ *
264
+ * @param {string} params.functionId - Function ID.
265
+ * @throws {RevenexxException}
266
+ * @returns {Promise<Models.Function>}
267
+ */
268
+ appsGet(params: {
269
+ functionId: string;
270
+ }): Promise<Models.Function>;
271
+ /**
272
+ * Get an App by its unique ID.
273
+ *
274
+ * @param {string} functionId - Function ID.
275
+ * @throws {RevenexxException}
276
+ * @returns {Promise<Models.Function>}
277
+ * @deprecated Use the object parameter style method for a better developer experience.
278
+ */
279
+ appsGet(functionId: string): Promise<Models.Function>;
280
+ /**
281
+ * Update an App. Use this endpoint to rename, change runtime, schedule, environment variables and other configuration.
282
+ *
283
+ * @param {string} params.functionId - Function ID.
284
+ * @param {string} params.name - Function name. Max length: 128 chars.
285
+ * @param {string} params.commands - Build Commands.
286
+ * @param {boolean} params.enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
287
+ * @param {string} params.entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
288
+ * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
289
+ * @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
290
+ * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Controle System) deployment.
291
+ * @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
292
+ * @param {string} params.providerBranch - Production branch for the repo linked to the function
293
+ * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the function
294
+ * @param {string} params.providerRootDirectory - Path to function code in the linked repo.
295
+ * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
296
+ * @param {Runtime} params.runtime - Execution runtime.
297
+ * @param {string} params.schedule - Schedule CRON syntax.
298
+ * @param {Scopes[]} params.scopes - List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
299
+ * @param {string} params.specification - Runtime specification for the function and builds.
300
+ * @param {number} params.timeout - Maximum execution time in seconds.
301
+ * @throws {RevenexxException}
302
+ * @returns {Promise<Models.Function>}
303
+ */
304
+ appsUpdate(params: {
305
+ functionId: string;
306
+ name: string;
307
+ commands?: string;
308
+ enabled?: boolean;
309
+ entrypoint?: string;
310
+ events?: string[];
311
+ execute?: string[];
312
+ installationId?: string;
313
+ logging?: boolean;
314
+ providerBranch?: string;
315
+ providerRepositoryId?: string;
316
+ providerRootDirectory?: string;
317
+ providerSilentMode?: boolean;
318
+ runtime?: Runtime;
319
+ schedule?: string;
320
+ scopes?: Scopes[];
321
+ specification?: string;
322
+ timeout?: number;
323
+ }): Promise<Models.Function>;
324
+ /**
325
+ * Update an App. Use this endpoint to rename, change runtime, schedule, environment variables and other configuration.
326
+ *
327
+ * @param {string} functionId - Function ID.
328
+ * @param {string} name - Function name. Max length: 128 chars.
329
+ * @param {string} commands - Build Commands.
330
+ * @param {boolean} enabled - Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.
331
+ * @param {string} entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
332
+ * @param {string[]} events - Events list. Maximum of 100 events are allowed.
333
+ * @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
334
+ * @param {string} installationId - Appwrite Installation ID for VCS (Version Controle System) deployment.
335
+ * @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
336
+ * @param {string} providerBranch - Production branch for the repo linked to the function
337
+ * @param {string} providerRepositoryId - Repository ID of the repo linked to the function
338
+ * @param {string} providerRootDirectory - Path to function code in the linked repo.
339
+ * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
340
+ * @param {Runtime} runtime - Execution runtime.
341
+ * @param {string} schedule - Schedule CRON syntax.
342
+ * @param {Scopes[]} scopes - List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
343
+ * @param {string} specification - Runtime specification for the function and builds.
344
+ * @param {number} timeout - Maximum execution time in seconds.
345
+ * @throws {RevenexxException}
346
+ * @returns {Promise<Models.Function>}
347
+ * @deprecated Use the object parameter style method for a better developer experience.
348
+ */
349
+ appsUpdate(functionId: string, name: string, commands?: string, enabled?: boolean, entrypoint?: string, events?: string[], execute?: string[], installationId?: string, logging?: boolean, providerBranch?: string, providerRepositoryId?: string, providerRootDirectory?: string, providerSilentMode?: boolean, runtime?: Runtime, schedule?: string, scopes?: Scopes[], specification?: string, timeout?: number): Promise<Models.Function>;
350
+ /**
351
+ * Set the active deployment for an App. The chosen deployment must already be `ready`.
352
+ *
353
+ * @param {string} params.functionId - Function ID.
354
+ * @param {string} params.deploymentId - Deployment ID.
355
+ * @throws {RevenexxException}
356
+ * @returns {Promise<Models.Function>}
357
+ */
358
+ appsUpdateDeployment(params: {
359
+ functionId: string;
360
+ deploymentId: string;
361
+ }): Promise<Models.Function>;
362
+ /**
363
+ * Set the active deployment for an App. The chosen deployment must already be `ready`.
364
+ *
365
+ * @param {string} functionId - Function ID.
366
+ * @param {string} deploymentId - Deployment ID.
367
+ * @throws {RevenexxException}
368
+ * @returns {Promise<Models.Function>}
369
+ * @deprecated Use the object parameter style method for a better developer experience.
370
+ */
371
+ appsUpdateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
372
+ /**
373
+ * List the deployment history of an App.
374
+ *
375
+ * @param {string} params.functionId - Function ID.
376
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
377
+ * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
378
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
379
+ * @throws {RevenexxException}
380
+ * @returns {Promise<Models.DeploymentList>}
381
+ */
382
+ appsListDeployments(params: {
383
+ functionId: string;
384
+ queries?: string[];
385
+ search?: string;
386
+ total?: boolean;
387
+ }): Promise<Models.DeploymentList>;
388
+ /**
389
+ * List the deployment history of an App.
390
+ *
391
+ * @param {string} functionId - Function ID.
392
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
393
+ * @param {string} search - Search term to filter your list results. Max length: 256 chars.
394
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
395
+ * @throws {RevenexxException}
396
+ * @returns {Promise<Models.DeploymentList>}
397
+ * @deprecated Use the object parameter style method for a better developer experience.
398
+ */
399
+ appsListDeployments(functionId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.DeploymentList>;
400
+ /**
401
+ * Upload a new code deployment for an App. Accepts a `.tar.gz`
402
+ * archive containing the App source. Phase 2 will extract the
403
+ * manifest from this archive and validate it against the App
404
+ * Registry before kicking off the build.
405
+ *
406
+ * @param {string} params.functionId - Function ID.
407
+ * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
408
+ * @param {string} params.code - Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
409
+ * @param {string} params.commands - Build Commands.
410
+ * @param {string} params.entrypoint - Entrypoint File.
411
+ * @throws {RevenexxException}
412
+ * @returns {Promise<Models.Deployment>}
413
+ */
414
+ appsCreateDeployment(params: {
415
+ functionId: string;
416
+ activate: boolean;
417
+ code: string;
418
+ commands?: string;
419
+ entrypoint?: string;
420
+ onProgress?: (progress: UploadProgress) => void;
421
+ }): Promise<Models.Deployment>;
422
+ /**
423
+ * Upload a new code deployment for an App. Accepts a `.tar.gz`
424
+ * archive containing the App source. Phase 2 will extract the
425
+ * manifest from this archive and validate it against the App
426
+ * Registry before kicking off the build.
427
+ *
428
+ * @param {string} functionId - Function ID.
429
+ * @param {boolean} activate - Automatically activate the deployment when it is finished building.
430
+ * @param {string} code - Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
431
+ * @param {string} commands - Build Commands.
432
+ * @param {string} entrypoint - Entrypoint File.
433
+ * @throws {RevenexxException}
434
+ * @returns {Promise<Models.Deployment>}
435
+ * @deprecated Use the object parameter style method for a better developer experience.
436
+ */
437
+ appsCreateDeployment(functionId: string, activate: boolean, code: string, commands?: string, entrypoint?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
438
+ /**
439
+ * Re-deploy an existing build under a new deployment ID. Useful for promoting a known-good preview build to production without rebuilding.
440
+ *
441
+ * @param {string} params.functionId - Function ID.
442
+ * @param {string} params.deploymentId - Deployment ID.
443
+ * @param {string} params.buildId - Build unique ID.
444
+ * @throws {RevenexxException}
445
+ * @returns {Promise<Models.Deployment>}
446
+ */
447
+ appsCreateDuplicateDeployment(params: {
448
+ functionId: string;
449
+ deploymentId: string;
450
+ buildId?: string;
451
+ }): Promise<Models.Deployment>;
452
+ /**
453
+ * Re-deploy an existing build under a new deployment ID. Useful for promoting a known-good preview build to production without rebuilding.
454
+ *
455
+ * @param {string} functionId - Function ID.
456
+ * @param {string} deploymentId - Deployment ID.
457
+ * @param {string} buildId - Build unique ID.
458
+ * @throws {RevenexxException}
459
+ * @returns {Promise<Models.Deployment>}
460
+ * @deprecated Use the object parameter style method for a better developer experience.
461
+ */
462
+ appsCreateDuplicateDeployment(functionId: string, deploymentId: string, buildId?: string): Promise<Models.Deployment>;
463
+ /**
464
+ * Create a new App deployment from a template in the App Templates catalogue.
465
+ *
466
+ * @param {string} params.functionId - Function ID.
467
+ * @param {string} params.owner - The name of the owner of the template.
468
+ * @param {string} params.reference - Reference value, can be a commit hash, branch name, or release tag
469
+ * @param {string} params.repository - Repository name of the template.
470
+ * @param {string} params.rootDirectory - Path to function code in the template repo.
471
+ * @param {Type} params.type - Type for the reference provided. Can be commit, branch, or tag
472
+ * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
473
+ * @throws {RevenexxException}
474
+ * @returns {Promise<Models.Deployment>}
475
+ */
476
+ appsCreateTemplateDeployment(params: {
477
+ functionId: string;
478
+ owner: string;
479
+ reference: string;
480
+ repository: string;
481
+ rootDirectory: string;
482
+ type: Type;
483
+ activate?: boolean;
484
+ }): Promise<Models.Deployment>;
485
+ /**
486
+ * Create a new App deployment from a template in the App Templates catalogue.
487
+ *
488
+ * @param {string} functionId - Function ID.
489
+ * @param {string} owner - The name of the owner of the template.
490
+ * @param {string} reference - Reference value, can be a commit hash, branch name, or release tag
491
+ * @param {string} repository - Repository name of the template.
492
+ * @param {string} rootDirectory - Path to function code in the template repo.
493
+ * @param {Type} type - Type for the reference provided. Can be commit, branch, or tag
494
+ * @param {boolean} activate - Automatically activate the deployment when it is finished building.
495
+ * @throws {RevenexxException}
496
+ * @returns {Promise<Models.Deployment>}
497
+ * @deprecated Use the object parameter style method for a better developer experience.
498
+ */
499
+ appsCreateTemplateDeployment(functionId: string, owner: string, reference: string, repository: string, rootDirectory: string, type: Type, activate?: boolean): Promise<Models.Deployment>;
500
+ /**
501
+ * Trigger a new deployment from the App's connected Git repository.
502
+ *
503
+ * @param {string} params.functionId - Function ID.
504
+ * @param {string} params.reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
505
+ * @param {Type} params.type - Type of reference passed. Allowed values are: branch, commit
506
+ * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
507
+ * @throws {RevenexxException}
508
+ * @returns {Promise<Models.Deployment>}
509
+ */
510
+ appsCreateVcsDeployment(params: {
511
+ functionId: string;
512
+ reference: string;
513
+ type: Type;
514
+ activate?: boolean;
515
+ }): Promise<Models.Deployment>;
516
+ /**
517
+ * Trigger a new deployment from the App's connected Git repository.
518
+ *
519
+ * @param {string} functionId - Function ID.
520
+ * @param {string} reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
521
+ * @param {Type} type - Type of reference passed. Allowed values are: branch, commit
522
+ * @param {boolean} activate - Automatically activate the deployment when it is finished building.
523
+ * @throws {RevenexxException}
524
+ * @returns {Promise<Models.Deployment>}
525
+ * @deprecated Use the object parameter style method for a better developer experience.
526
+ */
527
+ appsCreateVcsDeployment(functionId: string, reference: string, type: Type, activate?: boolean): Promise<Models.Deployment>;
528
+ /**
529
+ * Delete a deployment. The active deployment cannot be deleted while it is active — switch first via the deployment-update endpoint.
530
+ *
531
+ * @param {string} params.functionId - Function ID.
532
+ * @param {string} params.deploymentId - Deployment ID.
533
+ * @throws {RevenexxException}
534
+ * @returns {Promise<{}>}
535
+ */
536
+ appsDeleteDeployment(params: {
537
+ functionId: string;
538
+ deploymentId: string;
539
+ }): Promise<{}>;
540
+ /**
541
+ * Delete a deployment. The active deployment cannot be deleted while it is active — switch first via the deployment-update endpoint.
542
+ *
543
+ * @param {string} functionId - Function ID.
544
+ * @param {string} deploymentId - Deployment ID.
545
+ * @throws {RevenexxException}
546
+ * @returns {Promise<{}>}
547
+ * @deprecated Use the object parameter style method for a better developer experience.
548
+ */
549
+ appsDeleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
550
+ /**
551
+ * Get a deployment by its unique ID.
552
+ *
553
+ * @param {string} params.functionId - Function ID.
554
+ * @param {string} params.deploymentId - Deployment ID.
555
+ * @throws {RevenexxException}
556
+ * @returns {Promise<Models.Deployment>}
557
+ */
558
+ appsGetDeployment(params: {
559
+ functionId: string;
560
+ deploymentId: string;
561
+ }): Promise<Models.Deployment>;
562
+ /**
563
+ * Get a deployment by its unique ID.
564
+ *
565
+ * @param {string} functionId - Function ID.
566
+ * @param {string} deploymentId - Deployment ID.
567
+ * @throws {RevenexxException}
568
+ * @returns {Promise<Models.Deployment>}
569
+ * @deprecated Use the object parameter style method for a better developer experience.
570
+ */
571
+ appsGetDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
572
+ /**
573
+ * Get a redirect URL to download the source archive of an App deployment. Useful for re-running a build locally or auditing what was deployed.
574
+ *
575
+ * @param {string} params.functionId - Function ID.
576
+ * @param {string} params.deploymentId - Deployment ID.
577
+ * @param {Type} params.type - Deployment file to download. Can be: "source", "output".
578
+ * @throws {RevenexxException}
579
+ * @returns {Promise<{}>}
580
+ */
581
+ appsGetDeploymentDownload(params: {
582
+ functionId: string;
583
+ deploymentId: string;
584
+ type?: Type;
585
+ }): Promise<{}>;
586
+ /**
587
+ * Get a redirect URL to download the source archive of an App deployment. Useful for re-running a build locally or auditing what was deployed.
588
+ *
589
+ * @param {string} functionId - Function ID.
590
+ * @param {string} deploymentId - Deployment ID.
591
+ * @param {Type} type - Deployment file to download. Can be: "source", "output".
592
+ * @throws {RevenexxException}
593
+ * @returns {Promise<{}>}
594
+ * @deprecated Use the object parameter style method for a better developer experience.
595
+ */
596
+ appsGetDeploymentDownload(functionId: string, deploymentId: string, type?: Type): Promise<{}>;
597
+ /**
598
+ * Cancel an in-progress deployment build. Used by the Cockpit "Cancel build" affordance.
599
+ *
600
+ * @param {string} params.functionId - Function ID.
601
+ * @param {string} params.deploymentId - Deployment ID.
602
+ * @throws {RevenexxException}
603
+ * @returns {Promise<Models.Deployment>}
604
+ */
605
+ appsUpdateDeploymentStatus(params: {
606
+ functionId: string;
607
+ deploymentId: string;
608
+ }): Promise<Models.Deployment>;
609
+ /**
610
+ * Cancel an in-progress deployment build. Used by the Cockpit "Cancel build" affordance.
611
+ *
612
+ * @param {string} functionId - Function ID.
613
+ * @param {string} deploymentId - Deployment ID.
614
+ * @throws {RevenexxException}
615
+ * @returns {Promise<Models.Deployment>}
616
+ * @deprecated Use the object parameter style method for a better developer experience.
617
+ */
618
+ appsUpdateDeploymentStatus(functionId: string, deploymentId: string): Promise<Models.Deployment>;
619
+ /**
620
+ * List the execution history of an App.
621
+ *
622
+ * @param {string} params.functionId - Function ID.
623
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
624
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
625
+ * @throws {RevenexxException}
626
+ * @returns {Promise<Models.ExecutionList>}
627
+ */
628
+ appsListExecutions(params: {
629
+ functionId: string;
630
+ queries?: string[];
631
+ total?: boolean;
632
+ }): Promise<Models.ExecutionList>;
633
+ /**
634
+ * List the execution history of an App.
635
+ *
636
+ * @param {string} functionId - Function ID.
637
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
638
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
639
+ * @throws {RevenexxException}
640
+ * @returns {Promise<Models.ExecutionList>}
641
+ * @deprecated Use the object parameter style method for a better developer experience.
642
+ */
643
+ appsListExecutions(functionId: string, queries?: string[], total?: boolean): Promise<Models.ExecutionList>;
644
+ /**
645
+ * Trigger an App execution. Use the optional `body`, `path`, `method` and `headers` parameters to invoke the App as if from an HTTP request.
646
+ *
647
+ * @param {string} params.functionId - Function ID.
648
+ * @param {boolean} params.async - Execute code in the background. Default value is false.
649
+ * @param {string} params.body - HTTP body of execution. Default value is empty string.
650
+ * @param {object} params.headers - HTTP headers of execution. Defaults to empty.
651
+ * @param {Method} params.method - HTTP method of execution. Default value is POST.
652
+ * @param {string} params.xpath - HTTP path of execution. Path can include query params. Default value is /
653
+ * @param {string} params.scheduledAt - Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
654
+ * @throws {RevenexxException}
655
+ * @returns {Promise<Models.Execution>}
656
+ */
657
+ appsCreateExecution(params: {
658
+ functionId: string;
659
+ async?: boolean;
660
+ body?: string;
661
+ headers?: object;
662
+ method?: Method;
663
+ xpath?: string;
664
+ scheduledAt?: string;
665
+ }): Promise<Models.Execution>;
666
+ /**
667
+ * Trigger an App execution. Use the optional `body`, `path`, `method` and `headers` parameters to invoke the App as if from an HTTP request.
668
+ *
669
+ * @param {string} functionId - Function ID.
670
+ * @param {boolean} async - Execute code in the background. Default value is false.
671
+ * @param {string} body - HTTP body of execution. Default value is empty string.
672
+ * @param {object} headers - HTTP headers of execution. Defaults to empty.
673
+ * @param {Method} method - HTTP method of execution. Default value is POST.
674
+ * @param {string} xpath - HTTP path of execution. Path can include query params. Default value is /
675
+ * @param {string} scheduledAt - Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
676
+ * @throws {RevenexxException}
677
+ * @returns {Promise<Models.Execution>}
678
+ * @deprecated Use the object parameter style method for a better developer experience.
679
+ */
680
+ appsCreateExecution(functionId: string, async?: boolean, body?: string, headers?: object, method?: Method, xpath?: string, scheduledAt?: string): Promise<Models.Execution>;
681
+ /**
682
+ * Delete an App execution by its unique ID.
683
+ *
684
+ * @param {string} params.functionId - Function ID.
685
+ * @param {string} params.executionId - Execution ID.
686
+ * @throws {RevenexxException}
687
+ * @returns {Promise<{}>}
688
+ */
689
+ appsDeleteExecution(params: {
690
+ functionId: string;
691
+ executionId: string;
692
+ }): Promise<{}>;
693
+ /**
694
+ * Delete an App execution by its unique ID.
695
+ *
696
+ * @param {string} functionId - Function ID.
697
+ * @param {string} executionId - Execution ID.
698
+ * @throws {RevenexxException}
699
+ * @returns {Promise<{}>}
700
+ * @deprecated Use the object parameter style method for a better developer experience.
701
+ */
702
+ appsDeleteExecution(functionId: string, executionId: string): Promise<{}>;
703
+ /**
704
+ * Get an App execution by its unique ID.
705
+ *
706
+ * @param {string} params.functionId - Function ID.
707
+ * @param {string} params.executionId - Execution ID.
708
+ * @throws {RevenexxException}
709
+ * @returns {Promise<Models.Execution>}
710
+ */
711
+ appsGetExecution(params: {
712
+ functionId: string;
713
+ executionId: string;
714
+ }): Promise<Models.Execution>;
715
+ /**
716
+ * Get an App execution by its unique ID.
717
+ *
718
+ * @param {string} functionId - Function ID.
719
+ * @param {string} executionId - Execution ID.
720
+ * @throws {RevenexxException}
721
+ * @returns {Promise<Models.Execution>}
722
+ * @deprecated Use the object parameter style method for a better developer experience.
723
+ */
724
+ appsGetExecution(functionId: string, executionId: string): Promise<Models.Execution>;
725
+ /**
726
+ * Read-through view of the App's App Registry row — visibility + Marketplace publish flag. Used by Cockpit to render the Publish/Unpublish button correctly on cold load.
727
+ *
728
+ * @param {string} params.functionId - App ID.
729
+ * @throws {RevenexxException}
730
+ * @returns {Promise<{}>}
731
+ */
732
+ appsGetMarketplaceStatus(params: {
733
+ functionId: string;
734
+ }): Promise<{}>;
735
+ /**
736
+ * Read-through view of the App's App Registry row — visibility + Marketplace publish flag. Used by Cockpit to render the Publish/Unpublish button correctly on cold load.
737
+ *
738
+ * @param {string} functionId - App ID.
739
+ * @throws {RevenexxException}
740
+ * @returns {Promise<{}>}
741
+ * @deprecated Use the object parameter style method for a better developer experience.
742
+ */
743
+ appsGetMarketplaceStatus(functionId: string): Promise<{}>;
744
+ /**
745
+ * Remove this App from the Marketplace listing. Existing tenant installations are unaffected. Idempotent.
746
+ *
747
+ * @param {string} params.functionId - App ID.
748
+ * @throws {RevenexxException}
749
+ * @returns {Promise<{}>}
750
+ */
751
+ appsUnpublish(params: {
752
+ functionId: string;
753
+ }): Promise<{}>;
754
+ /**
755
+ * Remove this App from the Marketplace listing. Existing tenant installations are unaffected. Idempotent.
756
+ *
757
+ * @param {string} functionId - App ID.
758
+ * @throws {RevenexxException}
759
+ * @returns {Promise<{}>}
760
+ * @deprecated Use the object parameter style method for a better developer experience.
761
+ */
762
+ appsUnpublish(functionId: string): Promise<{}>;
763
+ /**
764
+ * Publish this App to the Marketplace. The App must have at
765
+ * least one `ready` deployment with a registered manifest,
766
+ * and its visibility (derived from `billing.json`) must be
767
+ * `public` or `included`. Idempotent.
768
+ *
769
+ * @param {string} params.functionId - App ID.
770
+ * @throws {RevenexxException}
771
+ * @returns {Promise<{}>}
772
+ */
773
+ appsPublish(params: {
774
+ functionId: string;
775
+ }): Promise<{}>;
776
+ /**
777
+ * Publish this App to the Marketplace. The App must have at
778
+ * least one `ready` deployment with a registered manifest,
779
+ * and its visibility (derived from `billing.json`) must be
780
+ * `public` or `included`. Idempotent.
781
+ *
782
+ * @param {string} functionId - App ID.
783
+ * @throws {RevenexxException}
784
+ * @returns {Promise<{}>}
785
+ * @deprecated Use the object parameter style method for a better developer experience.
786
+ */
787
+ appsPublish(functionId: string): Promise<{}>;
788
+ /**
789
+ * Get usage stats for a single App over the requested time range.
790
+ *
791
+ * @param {string} params.functionId - Function ID.
792
+ * @param {Range} params.range - Date range.
793
+ * @throws {RevenexxException}
794
+ * @returns {Promise<Models.UsageFunction>}
795
+ */
796
+ appsGetUsage(params: {
797
+ functionId: string;
798
+ range?: Range;
799
+ }): Promise<Models.UsageFunction>;
800
+ /**
801
+ * Get usage stats for a single App over the requested time range.
802
+ *
803
+ * @param {string} functionId - Function ID.
804
+ * @param {Range} range - Date range.
805
+ * @throws {RevenexxException}
806
+ * @returns {Promise<Models.UsageFunction>}
807
+ * @deprecated Use the object parameter style method for a better developer experience.
808
+ */
809
+ appsGetUsage(functionId: string, range?: Range): Promise<Models.UsageFunction>;
810
+ /**
811
+ * List all environment variables defined for the App.
812
+ *
813
+ * @param {string} params.functionId - Function unique ID.
814
+ * @throws {RevenexxException}
815
+ * @returns {Promise<Models.VariableList>}
816
+ */
817
+ appsListVariables(params: {
818
+ functionId: string;
819
+ }): Promise<Models.VariableList>;
820
+ /**
821
+ * List all environment variables defined for the App.
822
+ *
823
+ * @param {string} functionId - Function unique ID.
824
+ * @throws {RevenexxException}
825
+ * @returns {Promise<Models.VariableList>}
826
+ * @deprecated Use the object parameter style method for a better developer experience.
827
+ */
828
+ appsListVariables(functionId: string): Promise<Models.VariableList>;
829
+ /**
830
+ * Create a new App environment variable. These are passed into the App at runtime as `process.env.*`.
831
+ *
832
+ * @param {string} params.functionId - Function unique ID.
833
+ * @param {string} params.key - Variable key. Max length: 255 chars.
834
+ * @param {string} params.value - Variable value. Max length: 8192 chars.
835
+ * @param {boolean} params.secret - Secret variables can be updated or deleted, but only functions can read them during build and runtime.
836
+ * @throws {RevenexxException}
837
+ * @returns {Promise<Models.Variable>}
838
+ */
839
+ appsCreateVariable(params: {
840
+ functionId: string;
841
+ key: string;
842
+ value: string;
843
+ secret?: boolean;
844
+ }): Promise<Models.Variable>;
845
+ /**
846
+ * Create a new App environment variable. These are passed into the App at runtime as `process.env.*`.
847
+ *
848
+ * @param {string} functionId - Function unique ID.
849
+ * @param {string} key - Variable key. Max length: 255 chars.
850
+ * @param {string} value - Variable value. Max length: 8192 chars.
851
+ * @param {boolean} secret - Secret variables can be updated or deleted, but only functions can read them during build and runtime.
852
+ * @throws {RevenexxException}
853
+ * @returns {Promise<Models.Variable>}
854
+ * @deprecated Use the object parameter style method for a better developer experience.
855
+ */
856
+ appsCreateVariable(functionId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
857
+ /**
858
+ * Delete an App environment variable.
859
+ *
860
+ * @param {string} params.functionId - Function unique ID.
861
+ * @param {string} params.variableId - Variable unique ID.
862
+ * @throws {RevenexxException}
863
+ * @returns {Promise<{}>}
864
+ */
865
+ appsDeleteVariable(params: {
866
+ functionId: string;
867
+ variableId: string;
868
+ }): Promise<{}>;
869
+ /**
870
+ * Delete an App environment variable.
871
+ *
872
+ * @param {string} functionId - Function unique ID.
873
+ * @param {string} variableId - Variable unique ID.
874
+ * @throws {RevenexxException}
875
+ * @returns {Promise<{}>}
876
+ * @deprecated Use the object parameter style method for a better developer experience.
877
+ */
878
+ appsDeleteVariable(functionId: string, variableId: string): Promise<{}>;
879
+ /**
880
+ * Get an App variable by its unique ID.
881
+ *
882
+ * @param {string} params.functionId - Function unique ID.
883
+ * @param {string} params.variableId - Variable unique ID.
884
+ * @throws {RevenexxException}
885
+ * @returns {Promise<Models.Variable>}
886
+ */
887
+ appsGetVariable(params: {
888
+ functionId: string;
889
+ variableId: string;
890
+ }): Promise<Models.Variable>;
891
+ /**
892
+ * Get an App variable by its unique ID.
893
+ *
894
+ * @param {string} functionId - Function unique ID.
895
+ * @param {string} variableId - Variable unique ID.
896
+ * @throws {RevenexxException}
897
+ * @returns {Promise<Models.Variable>}
898
+ * @deprecated Use the object parameter style method for a better developer experience.
899
+ */
900
+ appsGetVariable(functionId: string, variableId: string): Promise<Models.Variable>;
901
+ /**
902
+ * Update an App environment variable.
903
+ *
904
+ * @param {string} params.functionId - Function unique ID.
905
+ * @param {string} params.variableId - Variable unique ID.
906
+ * @param {string} params.key - Variable key. Max length: 255 chars.
907
+ * @param {boolean} params.secret - Secret variables can be updated or deleted, but only functions can read them during build and runtime.
908
+ * @param {string} params.value - Variable value. Max length: 8192 chars.
909
+ * @throws {RevenexxException}
910
+ * @returns {Promise<Models.Variable>}
911
+ */
912
+ appsUpdateVariable(params: {
913
+ functionId: string;
914
+ variableId: string;
915
+ key: string;
916
+ secret?: boolean;
917
+ value?: string;
918
+ }): Promise<Models.Variable>;
919
+ /**
920
+ * Update an App environment variable.
921
+ *
922
+ * @param {string} functionId - Function unique ID.
923
+ * @param {string} variableId - Variable unique ID.
924
+ * @param {string} key - Variable key. Max length: 255 chars.
925
+ * @param {boolean} secret - Secret variables can be updated or deleted, but only functions can read them during build and runtime.
926
+ * @param {string} value - Variable value. Max length: 8192 chars.
927
+ * @throws {RevenexxException}
928
+ * @returns {Promise<Models.Variable>}
929
+ * @deprecated Use the object parameter style method for a better developer experience.
930
+ */
931
+ appsUpdateVariable(functionId: string, variableId: string, key: string, secret?: boolean, value?: string): Promise<Models.Variable>;
932
+ }