@appwrite.io/console 1.8.0 → 1.9.0
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.
- package/README.md +3 -3
- package/dist/cjs/sdk.js +287 -8
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +288 -9
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +287 -8
- package/docs/examples/databases/decrement-document-attribute.md +18 -0
- package/docs/examples/databases/increment-document-attribute.md +18 -0
- package/docs/examples/databases/upsert-documents.md +1 -1
- package/docs/examples/domains/create-record-a-a-a-a.md +1 -1
- package/docs/examples/domains/create-record-a.md +1 -1
- package/docs/examples/domains/create-record-alias.md +1 -1
- package/docs/examples/domains/create-record-c-a-a.md +1 -1
- package/docs/examples/domains/create-record-c-n-a-m-e.md +1 -1
- package/docs/examples/domains/create-record-h-t-t-p-s.md +1 -1
- package/docs/examples/domains/create-record-m-x.md +1 -1
- package/docs/examples/domains/create-record-n-s.md +1 -1
- package/docs/examples/domains/create-record-s-r-v.md +1 -1
- package/docs/examples/domains/create-record-t-x-t.md +1 -1
- package/docs/examples/domains/update-record-a-a-a-a.md +1 -1
- package/docs/examples/domains/update-record-a.md +1 -1
- package/docs/examples/domains/update-record-alias.md +1 -1
- package/docs/examples/domains/update-record-c-a-a.md +1 -1
- package/docs/examples/domains/update-record-c-n-a-m-e.md +1 -1
- package/docs/examples/domains/update-record-h-t-t-p-s.md +1 -1
- package/docs/examples/domains/update-record-m-x.md +1 -1
- package/docs/examples/domains/update-record-n-s.md +1 -1
- package/docs/examples/domains/update-record-s-r-v.md +1 -1
- package/docs/examples/domains/update-record-t-x-t.md +1 -1
- package/docs/examples/health/{get-queue-stats-usage-dump.md → get-queue-billing-project-aggregation.md} +2 -2
- package/docs/examples/health/{get-queue-billing-aggregation.md → get-queue-billing-team-aggregation.md} +1 -1
- package/docs/examples/organizations/cancel-downgrade.md +13 -0
- package/docs/examples/organizations/estimation-create-organization.md +16 -0
- package/docs/examples/organizations/estimation-delete-organization.md +13 -0
- package/docs/examples/organizations/estimation-update-plan.md +16 -0
- package/docs/examples/organizations/get-usage.md +1 -1
- package/docs/examples/organizations/validate-payment.md +14 -0
- package/docs/examples/proxy/create-redirect-rule.md +4 -2
- package/package.json +1 -1
- package/src/client.ts +5 -4
- package/src/enums/build-runtime.ts +2 -0
- package/src/enums/image-format.ts +1 -0
- package/src/enums/proxy-resource-type.ts +4 -0
- package/src/enums/runtime.ts +2 -0
- package/src/index.ts +1 -0
- package/src/models.ts +272 -2
- package/src/services/databases.ts +96 -1
- package/src/services/health.ts +28 -3
- package/src/services/organizations.ts +197 -0
- package/src/services/proxy.ts +16 -1
- package/types/enums/build-runtime.d.ts +3 -1
- package/types/enums/image-format.d.ts +2 -1
- package/types/enums/proxy-resource-type.d.ts +4 -0
- package/types/enums/runtime.d.ts +3 -1
- package/types/index.d.ts +1 -0
- package/types/models.d.ts +272 -2
- package/types/services/databases.d.ts +27 -1
- package/types/services/health.d.ts +10 -2
- package/types/services/organizations.d.ts +57 -0
- package/types/services/proxy.d.ts +4 -1
- package/docs/examples/functions/create-build.md +0 -15
- package/docs/examples/functions/get-function-usage.md +0 -14
- package/docs/examples/functions/update-deployment-build.md +0 -14
- package/docs/examples/functions/update-deployment.md +0 -14
- package/docs/examples/proxy/create-rule.md +0 -15
- package/src/enums/resource-type.ts +0 -4
- package/types/enums/resource-type.d.ts +0 -4
package/src/services/health.ts
CHANGED
|
@@ -141,14 +141,39 @@ export class Health {
|
|
|
141
141
|
);
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* Get billing aggregation queue
|
|
144
|
+
* Get billing project aggregation queue
|
|
145
145
|
*
|
|
146
146
|
* @param {number} threshold
|
|
147
147
|
* @throws {AppwriteException}
|
|
148
148
|
* @returns {Promise<Models.HealthQueue>}
|
|
149
149
|
*/
|
|
150
|
-
|
|
151
|
-
const apiPath = '/health/queue/billing-aggregation';
|
|
150
|
+
getQueueBillingProjectAggregation(threshold?: number): Promise<Models.HealthQueue> {
|
|
151
|
+
const apiPath = '/health/queue/billing-project-aggregation';
|
|
152
|
+
const payload: Payload = {};
|
|
153
|
+
if (typeof threshold !== 'undefined') {
|
|
154
|
+
payload['threshold'] = threshold;
|
|
155
|
+
}
|
|
156
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
157
|
+
|
|
158
|
+
const apiHeaders: { [header: string]: string } = {
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
return this.client.call(
|
|
162
|
+
'get',
|
|
163
|
+
uri,
|
|
164
|
+
apiHeaders,
|
|
165
|
+
payload
|
|
166
|
+
);
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Get billing team aggregation queue
|
|
170
|
+
*
|
|
171
|
+
* @param {number} threshold
|
|
172
|
+
* @throws {AppwriteException}
|
|
173
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
174
|
+
*/
|
|
175
|
+
getQueueBillingTeamAggregation(threshold?: number): Promise<Models.HealthQueue> {
|
|
176
|
+
const apiPath = '/health/queue/billing-team-aggregation';
|
|
152
177
|
const payload: Payload = {};
|
|
153
178
|
if (typeof threshold !== 'undefined') {
|
|
154
179
|
payload['threshold'] = threshold;
|
|
@@ -107,6 +107,47 @@ export class Organizations {
|
|
|
107
107
|
payload
|
|
108
108
|
);
|
|
109
109
|
}
|
|
110
|
+
/**
|
|
111
|
+
* Get estimation for creating an organization.
|
|
112
|
+
*
|
|
113
|
+
* @param {BillingPlan} billingPlan
|
|
114
|
+
* @param {string} paymentMethodId
|
|
115
|
+
* @param {string[]} invites
|
|
116
|
+
* @param {string} couponId
|
|
117
|
+
* @throws {AppwriteException}
|
|
118
|
+
* @returns {Promise<Models.Estimation>}
|
|
119
|
+
*/
|
|
120
|
+
estimationCreateOrganization(billingPlan: BillingPlan, paymentMethodId?: string, invites?: string[], couponId?: string): Promise<Models.Estimation> {
|
|
121
|
+
if (typeof billingPlan === 'undefined') {
|
|
122
|
+
throw new AppwriteException('Missing required parameter: "billingPlan"');
|
|
123
|
+
}
|
|
124
|
+
const apiPath = '/organizations/estimations/create-organization';
|
|
125
|
+
const payload: Payload = {};
|
|
126
|
+
if (typeof billingPlan !== 'undefined') {
|
|
127
|
+
payload['billingPlan'] = billingPlan;
|
|
128
|
+
}
|
|
129
|
+
if (typeof paymentMethodId !== 'undefined') {
|
|
130
|
+
payload['paymentMethodId'] = paymentMethodId;
|
|
131
|
+
}
|
|
132
|
+
if (typeof invites !== 'undefined') {
|
|
133
|
+
payload['invites'] = invites;
|
|
134
|
+
}
|
|
135
|
+
if (typeof couponId !== 'undefined') {
|
|
136
|
+
payload['couponId'] = couponId;
|
|
137
|
+
}
|
|
138
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
139
|
+
|
|
140
|
+
const apiHeaders: { [header: string]: string } = {
|
|
141
|
+
'content-type': 'application/json',
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
return this.client.call(
|
|
145
|
+
'patch',
|
|
146
|
+
uri,
|
|
147
|
+
apiHeaders,
|
|
148
|
+
payload
|
|
149
|
+
);
|
|
150
|
+
}
|
|
110
151
|
/**
|
|
111
152
|
* Delete an organization.
|
|
112
153
|
*
|
|
@@ -441,6 +482,73 @@ export class Organizations {
|
|
|
441
482
|
payload
|
|
442
483
|
);
|
|
443
484
|
}
|
|
485
|
+
/**
|
|
486
|
+
* Get estimation for deleting an organization.
|
|
487
|
+
*
|
|
488
|
+
* @param {string} organizationId
|
|
489
|
+
* @throws {AppwriteException}
|
|
490
|
+
* @returns {Promise<Models.EstimationDeleteOrganization>}
|
|
491
|
+
*/
|
|
492
|
+
estimationDeleteOrganization(organizationId: string): Promise<Models.EstimationDeleteOrganization> {
|
|
493
|
+
if (typeof organizationId === 'undefined') {
|
|
494
|
+
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
495
|
+
}
|
|
496
|
+
const apiPath = '/organizations/{organizationId}/estimations/delete-organization'.replace('{organizationId}', organizationId);
|
|
497
|
+
const payload: Payload = {};
|
|
498
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
499
|
+
|
|
500
|
+
const apiHeaders: { [header: string]: string } = {
|
|
501
|
+
'content-type': 'application/json',
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
return this.client.call(
|
|
505
|
+
'patch',
|
|
506
|
+
uri,
|
|
507
|
+
apiHeaders,
|
|
508
|
+
payload
|
|
509
|
+
);
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* Get estimation for updating the organization plan.
|
|
513
|
+
*
|
|
514
|
+
* @param {string} organizationId
|
|
515
|
+
* @param {BillingPlan} billingPlan
|
|
516
|
+
* @param {string[]} invites
|
|
517
|
+
* @param {string} couponId
|
|
518
|
+
* @throws {AppwriteException}
|
|
519
|
+
* @returns {Promise<Models.EstimationUpdatePlan>}
|
|
520
|
+
*/
|
|
521
|
+
estimationUpdatePlan(organizationId: string, billingPlan: BillingPlan, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan> {
|
|
522
|
+
if (typeof organizationId === 'undefined') {
|
|
523
|
+
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
524
|
+
}
|
|
525
|
+
if (typeof billingPlan === 'undefined') {
|
|
526
|
+
throw new AppwriteException('Missing required parameter: "billingPlan"');
|
|
527
|
+
}
|
|
528
|
+
const apiPath = '/organizations/{organizationId}/estimations/update-plan'.replace('{organizationId}', organizationId);
|
|
529
|
+
const payload: Payload = {};
|
|
530
|
+
if (typeof billingPlan !== 'undefined') {
|
|
531
|
+
payload['billingPlan'] = billingPlan;
|
|
532
|
+
}
|
|
533
|
+
if (typeof invites !== 'undefined') {
|
|
534
|
+
payload['invites'] = invites;
|
|
535
|
+
}
|
|
536
|
+
if (typeof couponId !== 'undefined') {
|
|
537
|
+
payload['couponId'] = couponId;
|
|
538
|
+
}
|
|
539
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
540
|
+
|
|
541
|
+
const apiHeaders: { [header: string]: string } = {
|
|
542
|
+
'content-type': 'application/json',
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
return this.client.call(
|
|
546
|
+
'patch',
|
|
547
|
+
uri,
|
|
548
|
+
apiHeaders,
|
|
549
|
+
payload
|
|
550
|
+
);
|
|
551
|
+
}
|
|
444
552
|
/**
|
|
445
553
|
* List all invoices for an organization.
|
|
446
554
|
*
|
|
@@ -854,6 +962,32 @@ export class Organizations {
|
|
|
854
962
|
payload
|
|
855
963
|
);
|
|
856
964
|
}
|
|
965
|
+
/**
|
|
966
|
+
* Cancel the downgrade initiated for an organization.
|
|
967
|
+
*
|
|
968
|
+
* @param {string} organizationId
|
|
969
|
+
* @throws {AppwriteException}
|
|
970
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
971
|
+
*/
|
|
972
|
+
cancelDowngrade<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>> {
|
|
973
|
+
if (typeof organizationId === 'undefined') {
|
|
974
|
+
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
975
|
+
}
|
|
976
|
+
const apiPath = '/organizations/{organizationId}/plan/cancel'.replace('{organizationId}', organizationId);
|
|
977
|
+
const payload: Payload = {};
|
|
978
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
979
|
+
|
|
980
|
+
const apiHeaders: { [header: string]: string } = {
|
|
981
|
+
'content-type': 'application/json',
|
|
982
|
+
}
|
|
983
|
+
|
|
984
|
+
return this.client.call(
|
|
985
|
+
'patch',
|
|
986
|
+
uri,
|
|
987
|
+
apiHeaders,
|
|
988
|
+
payload
|
|
989
|
+
);
|
|
990
|
+
}
|
|
857
991
|
/**
|
|
858
992
|
* Get Scopes
|
|
859
993
|
*
|
|
@@ -905,6 +1039,69 @@ export class Organizations {
|
|
|
905
1039
|
'content-type': 'application/json',
|
|
906
1040
|
}
|
|
907
1041
|
|
|
1042
|
+
return this.client.call(
|
|
1043
|
+
'patch',
|
|
1044
|
+
uri,
|
|
1045
|
+
apiHeaders,
|
|
1046
|
+
payload
|
|
1047
|
+
);
|
|
1048
|
+
}
|
|
1049
|
+
/**
|
|
1050
|
+
* Get the usage data for an organization.
|
|
1051
|
+
*
|
|
1052
|
+
* @param {string} organizationId
|
|
1053
|
+
* @param {string} startDate
|
|
1054
|
+
* @param {string} endDate
|
|
1055
|
+
* @throws {AppwriteException}
|
|
1056
|
+
* @returns {Promise<Models.UsageOrganization>}
|
|
1057
|
+
*/
|
|
1058
|
+
getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization> {
|
|
1059
|
+
if (typeof organizationId === 'undefined') {
|
|
1060
|
+
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
1061
|
+
}
|
|
1062
|
+
const apiPath = '/organizations/{organizationId}/usage'.replace('{organizationId}', organizationId);
|
|
1063
|
+
const payload: Payload = {};
|
|
1064
|
+
if (typeof startDate !== 'undefined') {
|
|
1065
|
+
payload['startDate'] = startDate;
|
|
1066
|
+
}
|
|
1067
|
+
if (typeof endDate !== 'undefined') {
|
|
1068
|
+
payload['endDate'] = endDate;
|
|
1069
|
+
}
|
|
1070
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
1071
|
+
|
|
1072
|
+
const apiHeaders: { [header: string]: string } = {
|
|
1073
|
+
}
|
|
1074
|
+
|
|
1075
|
+
return this.client.call(
|
|
1076
|
+
'get',
|
|
1077
|
+
uri,
|
|
1078
|
+
apiHeaders,
|
|
1079
|
+
payload
|
|
1080
|
+
);
|
|
1081
|
+
}
|
|
1082
|
+
/**
|
|
1083
|
+
* Validate payment for team after creation or upgrade.
|
|
1084
|
+
*
|
|
1085
|
+
* @param {string} organizationId
|
|
1086
|
+
* @param {string[]} invites
|
|
1087
|
+
* @throws {AppwriteException}
|
|
1088
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1089
|
+
*/
|
|
1090
|
+
validatePayment<Preferences extends Models.Preferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>> {
|
|
1091
|
+
if (typeof organizationId === 'undefined') {
|
|
1092
|
+
throw new AppwriteException('Missing required parameter: "organizationId"');
|
|
1093
|
+
}
|
|
1094
|
+
const apiPath = '/organizations/{organizationId}/validate'.replace('{organizationId}', organizationId);
|
|
1095
|
+
const payload: Payload = {};
|
|
1096
|
+
if (typeof invites !== 'undefined') {
|
|
1097
|
+
payload['invites'] = invites;
|
|
1098
|
+
}
|
|
1099
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
1100
|
+
|
|
1101
|
+
const apiHeaders: { [header: string]: string } = {
|
|
1102
|
+
'content-type': 'application/json',
|
|
1103
|
+
}
|
|
1104
|
+
|
|
908
1105
|
return this.client.call(
|
|
909
1106
|
'patch',
|
|
910
1107
|
uri,
|
package/src/services/proxy.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { Service } from '../service';
|
|
|
2
2
|
import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
|
|
3
3
|
import type { Models } from '../models';
|
|
4
4
|
import { StatusCode } from '../enums/status-code';
|
|
5
|
+
import { ProxyResourceType } from '../enums/proxy-resource-type';
|
|
5
6
|
|
|
6
7
|
export class Proxy {
|
|
7
8
|
client: Client;
|
|
@@ -114,10 +115,12 @@ export class Proxy {
|
|
|
114
115
|
* @param {string} domain
|
|
115
116
|
* @param {string} url
|
|
116
117
|
* @param {StatusCode} statusCode
|
|
118
|
+
* @param {string} resourceId
|
|
119
|
+
* @param {ProxyResourceType} resourceType
|
|
117
120
|
* @throws {AppwriteException}
|
|
118
121
|
* @returns {Promise<Models.ProxyRule>}
|
|
119
122
|
*/
|
|
120
|
-
createRedirectRule(domain: string, url: string, statusCode: StatusCode): Promise<Models.ProxyRule> {
|
|
123
|
+
createRedirectRule(domain: string, url: string, statusCode: StatusCode, resourceId: string, resourceType: ProxyResourceType): Promise<Models.ProxyRule> {
|
|
121
124
|
if (typeof domain === 'undefined') {
|
|
122
125
|
throw new AppwriteException('Missing required parameter: "domain"');
|
|
123
126
|
}
|
|
@@ -127,6 +130,12 @@ export class Proxy {
|
|
|
127
130
|
if (typeof statusCode === 'undefined') {
|
|
128
131
|
throw new AppwriteException('Missing required parameter: "statusCode"');
|
|
129
132
|
}
|
|
133
|
+
if (typeof resourceId === 'undefined') {
|
|
134
|
+
throw new AppwriteException('Missing required parameter: "resourceId"');
|
|
135
|
+
}
|
|
136
|
+
if (typeof resourceType === 'undefined') {
|
|
137
|
+
throw new AppwriteException('Missing required parameter: "resourceType"');
|
|
138
|
+
}
|
|
130
139
|
const apiPath = '/proxy/rules/redirect';
|
|
131
140
|
const payload: Payload = {};
|
|
132
141
|
if (typeof domain !== 'undefined') {
|
|
@@ -138,6 +147,12 @@ export class Proxy {
|
|
|
138
147
|
if (typeof statusCode !== 'undefined') {
|
|
139
148
|
payload['statusCode'] = statusCode;
|
|
140
149
|
}
|
|
150
|
+
if (typeof resourceId !== 'undefined') {
|
|
151
|
+
payload['resourceId'] = resourceId;
|
|
152
|
+
}
|
|
153
|
+
if (typeof resourceType !== 'undefined') {
|
|
154
|
+
payload['resourceType'] = resourceType;
|
|
155
|
+
}
|
|
141
156
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
142
157
|
|
|
143
158
|
const apiHeaders: { [header: string]: string } = {
|
|
@@ -33,6 +33,7 @@ export declare enum BuildRuntime {
|
|
|
33
33
|
Dart31 = "dart-3.1",
|
|
34
34
|
Dart33 = "dart-3.3",
|
|
35
35
|
Dart35 = "dart-3.5",
|
|
36
|
+
Dart38 = "dart-3.8",
|
|
36
37
|
Dotnet60 = "dotnet-6.0",
|
|
37
38
|
Dotnet70 = "dotnet-7.0",
|
|
38
39
|
Dotnet80 = "dotnet-8.0",
|
|
@@ -58,5 +59,6 @@ export declare enum BuildRuntime {
|
|
|
58
59
|
Static1 = "static-1",
|
|
59
60
|
Flutter324 = "flutter-3.24",
|
|
60
61
|
Flutter327 = "flutter-3.27",
|
|
61
|
-
Flutter329 = "flutter-3.29"
|
|
62
|
+
Flutter329 = "flutter-3.29",
|
|
63
|
+
Flutter332 = "flutter-3.32"
|
|
62
64
|
}
|
package/types/enums/runtime.d.ts
CHANGED
|
@@ -33,6 +33,7 @@ export declare enum Runtime {
|
|
|
33
33
|
Dart31 = "dart-3.1",
|
|
34
34
|
Dart33 = "dart-3.3",
|
|
35
35
|
Dart35 = "dart-3.5",
|
|
36
|
+
Dart38 = "dart-3.8",
|
|
36
37
|
Dotnet60 = "dotnet-6.0",
|
|
37
38
|
Dotnet70 = "dotnet-7.0",
|
|
38
39
|
Dotnet80 = "dotnet-8.0",
|
|
@@ -58,5 +59,6 @@ export declare enum Runtime {
|
|
|
58
59
|
Static1 = "static-1",
|
|
59
60
|
Flutter324 = "flutter-3.24",
|
|
60
61
|
Flutter327 = "flutter-3.27",
|
|
61
|
-
Flutter329 = "flutter-3.29"
|
|
62
|
+
Flutter329 = "flutter-3.29",
|
|
63
|
+
Flutter332 = "flutter-3.32"
|
|
62
64
|
}
|
package/types/index.d.ts
CHANGED
|
@@ -66,6 +66,7 @@ export { EmailTemplateLocale } from './enums/email-template-locale';
|
|
|
66
66
|
export { SmsTemplateType } from './enums/sms-template-type';
|
|
67
67
|
export { SmsTemplateLocale } from './enums/sms-template-locale';
|
|
68
68
|
export { StatusCode } from './enums/status-code';
|
|
69
|
+
export { ProxyResourceType } from './enums/proxy-resource-type';
|
|
69
70
|
export { Framework } from './enums/framework';
|
|
70
71
|
export { BuildRuntime } from './enums/build-runtime';
|
|
71
72
|
export { Adapter } from './enums/adapter';
|
package/types/models.d.ts
CHANGED
|
@@ -1218,6 +1218,10 @@ export declare namespace Models {
|
|
|
1218
1218
|
* Document ID.
|
|
1219
1219
|
*/
|
|
1220
1220
|
$id: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* Document automatically incrementing ID.
|
|
1223
|
+
*/
|
|
1224
|
+
$sequence: number;
|
|
1221
1225
|
/**
|
|
1222
1226
|
* Collection ID.
|
|
1223
1227
|
*/
|
|
@@ -5374,6 +5378,10 @@ export declare namespace Models {
|
|
|
5374
5378
|
* Does plan support mock numbers
|
|
5375
5379
|
*/
|
|
5376
5380
|
supportsMockNumbers: boolean;
|
|
5381
|
+
/**
|
|
5382
|
+
* Does plan support organization roles
|
|
5383
|
+
*/
|
|
5384
|
+
supportsOrganizationRoles: boolean;
|
|
5377
5385
|
/**
|
|
5378
5386
|
* Does plan support credit
|
|
5379
5387
|
*/
|
|
@@ -5394,6 +5402,10 @@ export declare namespace Models {
|
|
|
5394
5402
|
* Maximum function and site deployment size in MB
|
|
5395
5403
|
*/
|
|
5396
5404
|
buildSize: number;
|
|
5405
|
+
/**
|
|
5406
|
+
* Does the plan support encrypted string attributes or not.
|
|
5407
|
+
*/
|
|
5408
|
+
databasesAllowEncrypt: boolean;
|
|
5397
5409
|
};
|
|
5398
5410
|
/**
|
|
5399
5411
|
* BillingPlanAddon
|
|
@@ -5832,9 +5844,9 @@ export declare namespace Models {
|
|
|
5832
5844
|
*/
|
|
5833
5845
|
billingLimits: BillingLimits;
|
|
5834
5846
|
/**
|
|
5835
|
-
* Billing plan downgrade
|
|
5847
|
+
* Billing plan selected for downgrade.
|
|
5836
5848
|
*/
|
|
5837
|
-
billingPlanDowngrade:
|
|
5849
|
+
billingPlanDowngrade: string;
|
|
5838
5850
|
/**
|
|
5839
5851
|
* Tax Id
|
|
5840
5852
|
*/
|
|
@@ -6086,6 +6098,164 @@ export declare namespace Models {
|
|
|
6086
6098
|
*/
|
|
6087
6099
|
roles: string[];
|
|
6088
6100
|
};
|
|
6101
|
+
/**
|
|
6102
|
+
* UsageOrganization
|
|
6103
|
+
*/
|
|
6104
|
+
type UsageOrganization = {
|
|
6105
|
+
/**
|
|
6106
|
+
* Aggregated stats for number of requests.
|
|
6107
|
+
*/
|
|
6108
|
+
bandwidth: Metric[];
|
|
6109
|
+
/**
|
|
6110
|
+
* Aggregated stats for consumed bandwidth.
|
|
6111
|
+
*/
|
|
6112
|
+
users: Metric[];
|
|
6113
|
+
/**
|
|
6114
|
+
* Aggregated stats for function executions.
|
|
6115
|
+
*/
|
|
6116
|
+
executions: Metric[];
|
|
6117
|
+
/**
|
|
6118
|
+
* Aggregated stats for database reads.
|
|
6119
|
+
*/
|
|
6120
|
+
databasesReads: Metric[];
|
|
6121
|
+
/**
|
|
6122
|
+
* Aggregated stats for database writes.
|
|
6123
|
+
*/
|
|
6124
|
+
databasesWrites: Metric[];
|
|
6125
|
+
/**
|
|
6126
|
+
* Aggregated stats for file transformations.
|
|
6127
|
+
*/
|
|
6128
|
+
imageTransformations: Metric[];
|
|
6129
|
+
/**
|
|
6130
|
+
* Aggregated stats for total file transformations.
|
|
6131
|
+
*/
|
|
6132
|
+
imageTransformationsTotal: number;
|
|
6133
|
+
/**
|
|
6134
|
+
* Aggregated stats for total users.
|
|
6135
|
+
*/
|
|
6136
|
+
usersTotal: number;
|
|
6137
|
+
/**
|
|
6138
|
+
* Aggregated stats for total executions.
|
|
6139
|
+
*/
|
|
6140
|
+
executionsTotal: number;
|
|
6141
|
+
/**
|
|
6142
|
+
* Aggregated stats for function executions in mb seconds.
|
|
6143
|
+
*/
|
|
6144
|
+
executionsMBSecondsTotal: number;
|
|
6145
|
+
/**
|
|
6146
|
+
* Aggregated stats for function builds in mb seconds.
|
|
6147
|
+
*/
|
|
6148
|
+
buildsMBSecondsTotal: number;
|
|
6149
|
+
/**
|
|
6150
|
+
* Aggregated stats for total file storage.
|
|
6151
|
+
*/
|
|
6152
|
+
filesStorageTotal: number;
|
|
6153
|
+
/**
|
|
6154
|
+
* Aggregated stats for total builds storage.
|
|
6155
|
+
*/
|
|
6156
|
+
buildsStorageTotal: number;
|
|
6157
|
+
/**
|
|
6158
|
+
* Aggregated stats for total deployments storage.
|
|
6159
|
+
*/
|
|
6160
|
+
deploymentsStorageTotal: number;
|
|
6161
|
+
/**
|
|
6162
|
+
* Aggregated stats for total databases storage.
|
|
6163
|
+
*/
|
|
6164
|
+
databasesStorageTotal: number;
|
|
6165
|
+
/**
|
|
6166
|
+
* Aggregated stats for total databases reads.
|
|
6167
|
+
*/
|
|
6168
|
+
databasesReadsTotal: number;
|
|
6169
|
+
/**
|
|
6170
|
+
* Aggregated stats for total databases writes.
|
|
6171
|
+
*/
|
|
6172
|
+
databasesWritesTotal: number;
|
|
6173
|
+
/**
|
|
6174
|
+
* Aggregated stats for total backups storage.
|
|
6175
|
+
*/
|
|
6176
|
+
backupsStorageTotal: number;
|
|
6177
|
+
/**
|
|
6178
|
+
* Aggregated stats for total storage.
|
|
6179
|
+
*/
|
|
6180
|
+
storageTotal: number;
|
|
6181
|
+
/**
|
|
6182
|
+
* Aggregated stats for total auth phone.
|
|
6183
|
+
*/
|
|
6184
|
+
authPhoneTotal: number;
|
|
6185
|
+
/**
|
|
6186
|
+
* Aggregated stats for total auth phone estimation.
|
|
6187
|
+
*/
|
|
6188
|
+
authPhoneEstimate: number;
|
|
6189
|
+
/**
|
|
6190
|
+
* Aggregated stats for each projects.
|
|
6191
|
+
*/
|
|
6192
|
+
projects: UsageOrganizationProject[];
|
|
6193
|
+
};
|
|
6194
|
+
/**
|
|
6195
|
+
* UsageOrganizationProject
|
|
6196
|
+
*/
|
|
6197
|
+
type UsageOrganizationProject = {
|
|
6198
|
+
/**
|
|
6199
|
+
* projectId
|
|
6200
|
+
*/
|
|
6201
|
+
projectId: string;
|
|
6202
|
+
/**
|
|
6203
|
+
* Aggregated stats for number of requests.
|
|
6204
|
+
*/
|
|
6205
|
+
bandwidth: Metric[];
|
|
6206
|
+
/**
|
|
6207
|
+
* Aggregated stats for consumed bandwidth.
|
|
6208
|
+
*/
|
|
6209
|
+
users: Metric[];
|
|
6210
|
+
/**
|
|
6211
|
+
* Aggregated stats for function executions.
|
|
6212
|
+
*/
|
|
6213
|
+
executions: number;
|
|
6214
|
+
/**
|
|
6215
|
+
* Aggregated stats for database reads.
|
|
6216
|
+
*/
|
|
6217
|
+
databasesReads: Metric[];
|
|
6218
|
+
/**
|
|
6219
|
+
* Aggregated stats for database writes.
|
|
6220
|
+
*/
|
|
6221
|
+
databasesWrites: Metric[];
|
|
6222
|
+
/**
|
|
6223
|
+
* Aggregated stats for function executions in mb seconds.
|
|
6224
|
+
*/
|
|
6225
|
+
executionsMBSeconds: number;
|
|
6226
|
+
/**
|
|
6227
|
+
* Aggregated stats for function builds in mb seconds.
|
|
6228
|
+
*/
|
|
6229
|
+
buildsMBSeconds: number;
|
|
6230
|
+
/**
|
|
6231
|
+
* Aggregated stats for number of documents.
|
|
6232
|
+
*/
|
|
6233
|
+
storage: number;
|
|
6234
|
+
/**
|
|
6235
|
+
* Aggregated stats for phone authentication.
|
|
6236
|
+
*/
|
|
6237
|
+
authPhoneTotal: number;
|
|
6238
|
+
/**
|
|
6239
|
+
* Aggregated stats for phone authentication estimated cost.
|
|
6240
|
+
*/
|
|
6241
|
+
authPhoneEstimate: number;
|
|
6242
|
+
/**
|
|
6243
|
+
* Aggregated stats for total databases reads.
|
|
6244
|
+
*/
|
|
6245
|
+
databasesReadsTotal: number;
|
|
6246
|
+
/**
|
|
6247
|
+
* Aggregated stats for total databases writes.
|
|
6248
|
+
*/
|
|
6249
|
+
databasesWritesTotal: number;
|
|
6250
|
+
/**
|
|
6251
|
+
* Aggregated stats for file transformations.
|
|
6252
|
+
*/
|
|
6253
|
+
imageTransformations: Metric[];
|
|
6254
|
+
/**
|
|
6255
|
+
* Aggregated stats for total file transformations.
|
|
6256
|
+
*/
|
|
6257
|
+
imageTransformationsTotal: number;
|
|
6258
|
+
};
|
|
6089
6259
|
/**
|
|
6090
6260
|
* Domain
|
|
6091
6261
|
*/
|
|
@@ -6254,6 +6424,106 @@ export declare namespace Models {
|
|
|
6254
6424
|
*/
|
|
6255
6425
|
imageTransformations: AdditionalResource;
|
|
6256
6426
|
};
|
|
6427
|
+
/**
|
|
6428
|
+
* Estimation
|
|
6429
|
+
*/
|
|
6430
|
+
type Estimation = {
|
|
6431
|
+
/**
|
|
6432
|
+
* Total amount
|
|
6433
|
+
*/
|
|
6434
|
+
amount: number;
|
|
6435
|
+
/**
|
|
6436
|
+
* Gross payable amount
|
|
6437
|
+
*/
|
|
6438
|
+
grossAmount: number;
|
|
6439
|
+
/**
|
|
6440
|
+
* Discount amount
|
|
6441
|
+
*/
|
|
6442
|
+
discount: number;
|
|
6443
|
+
/**
|
|
6444
|
+
* Credits amount
|
|
6445
|
+
*/
|
|
6446
|
+
credits: number;
|
|
6447
|
+
/**
|
|
6448
|
+
* Estimation items
|
|
6449
|
+
*/
|
|
6450
|
+
items: EstimationItem[];
|
|
6451
|
+
/**
|
|
6452
|
+
* Estimation discount items
|
|
6453
|
+
*/
|
|
6454
|
+
discounts: EstimationItem[];
|
|
6455
|
+
/**
|
|
6456
|
+
* Trial days
|
|
6457
|
+
*/
|
|
6458
|
+
trialDays: number;
|
|
6459
|
+
/**
|
|
6460
|
+
* Trial end date
|
|
6461
|
+
*/
|
|
6462
|
+
trialEndDate?: string;
|
|
6463
|
+
};
|
|
6464
|
+
/**
|
|
6465
|
+
* EstimationUpdatePlan
|
|
6466
|
+
*/
|
|
6467
|
+
type EstimationUpdatePlan = {
|
|
6468
|
+
/**
|
|
6469
|
+
* Total amount
|
|
6470
|
+
*/
|
|
6471
|
+
amount: number;
|
|
6472
|
+
/**
|
|
6473
|
+
* Gross payable amount
|
|
6474
|
+
*/
|
|
6475
|
+
grossAmount: number;
|
|
6476
|
+
/**
|
|
6477
|
+
* Discount amount
|
|
6478
|
+
*/
|
|
6479
|
+
discount: number;
|
|
6480
|
+
/**
|
|
6481
|
+
* Credits amount
|
|
6482
|
+
*/
|
|
6483
|
+
credits: number;
|
|
6484
|
+
/**
|
|
6485
|
+
* Estimation items
|
|
6486
|
+
*/
|
|
6487
|
+
items: EstimationItem[];
|
|
6488
|
+
/**
|
|
6489
|
+
* Estimation discount items
|
|
6490
|
+
*/
|
|
6491
|
+
discounts: EstimationItem[];
|
|
6492
|
+
/**
|
|
6493
|
+
* Trial days
|
|
6494
|
+
*/
|
|
6495
|
+
trialDays: number;
|
|
6496
|
+
/**
|
|
6497
|
+
* Trial end date
|
|
6498
|
+
*/
|
|
6499
|
+
trialEndDate?: string;
|
|
6500
|
+
/**
|
|
6501
|
+
* Organization's existing credits
|
|
6502
|
+
*/
|
|
6503
|
+
organizationCredits: number;
|
|
6504
|
+
};
|
|
6505
|
+
/**
|
|
6506
|
+
* EstimationDeleteOrganization
|
|
6507
|
+
*/
|
|
6508
|
+
type EstimationDeleteOrganization = {
|
|
6509
|
+
/**
|
|
6510
|
+
* List of unpaid invoices
|
|
6511
|
+
*/
|
|
6512
|
+
unpaidInvoices: Invoice[];
|
|
6513
|
+
};
|
|
6514
|
+
/**
|
|
6515
|
+
* EstimationItem
|
|
6516
|
+
*/
|
|
6517
|
+
type EstimationItem = {
|
|
6518
|
+
/**
|
|
6519
|
+
* Label
|
|
6520
|
+
*/
|
|
6521
|
+
label: string;
|
|
6522
|
+
/**
|
|
6523
|
+
* Gross payable amount
|
|
6524
|
+
*/
|
|
6525
|
+
value: number;
|
|
6526
|
+
};
|
|
6257
6527
|
/**
|
|
6258
6528
|
* Aggregation team list
|
|
6259
6529
|
*/
|